The Card Validation object
Description
The Card Validation object allows you to validate an user’s card using 3DS authentication without processing a payment.
A Card object’s Validity is automatically set to INVALID after 24 hours unless it is validated through successful authentication with a Card Validation or a payment (Direct Card PayIn, Preauthorization, Recurring Registration).
Note – Card validation only available for CB_VISA_MASTERCARD
The card validation feature is only available for cards with the CardType CB_VISA_MASTERCARD.
Note – Card validation expires after 5 minutes
Because you cannot create two requests at once for the same card, the card validation will expire after 5 minutes, setting the Status of the Card Validation object to FAILED.
The Card Validity, however, will remain UNKNOWN, which allows you to request a new Card Validation.
Attributes
The unique identifier of the user at the source of the transaction.
Max. length: 255 characters
The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
Max. length: 255 characters
The URL to which to redirect the user to proceed to 3DS2 validation.
Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
Whether or not the SecureMode was used.
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
Information about the browser used by the end user (author) to perform the payment.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
Returned values: CARD_VALIDATION
The type of the card validation.
Returned values: VISA, MASTERCARD, CB, MAESTRO
The card network to use, as chosen by the cardholder, in case of co-branded card products.
Default value: DEFAULT
Allowed values: DEFAULT, FORCE, NO_CHOICE
The mode applied for the 3DS protocol for CB, Visa, and Mastercard. The options are:
DEFAULT– Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.FORCE– Requests SCA.NO_CHOICE– Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.
Note: Sending the FORCE value automatically sets the ValidationUsage value to MIT.
Default value: ECommerce
Allowed values: ECommerce, TelephoneOrder
The channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:
ECommerce– Payment received online.TelephoneOrder– Payment received via mail order or telephone order (MOTO).
Default value: MIT
Allowed values: MIT, CIT
Indicates the intended usage of the card:
- CIT – For customer-initiated transactions (CITs), meaning 3DS is less likely to be required on the card validation.
- MIT – For merchant-initiated transactions (MITs), meaning 3DS is more likely to be required on the card validation.
Note: The MIT value is returned automatically if the SecureMode value is FORCE, even if CIT is sent.
Returned values: UNKNOWN, VALID, INVALID
Whether the card is valid or not.
UNKNOWN– No payment or card validation has been processed, so the validity of the card remains unknown.VALID– The first payment or card validation using the card was processed successfully within 24 hours of the initial card registration.INVALID– The first payment or card validation using the card was attempted and failed, or the status of the corresponding card registration wasCREATEDfor more than 24 hours.
Once a card is set toINVALID, it cannot be set back toVALID. A new card registration will be necessary to make a payment.
The date and time at which the object was created.
The date and time at which successful authorization occurred. If authorization failed, the value is null.
Returned values: V1, V2_1
The 3DS protocol version applied to the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
Information about the card used for the transaction.
If the information or data is not available, null is returned.
The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.
Was this page helpful?