Skip to main content
POST

​
Path parameters

​
string
required
The unique identifier of the Card object, obtained during the card registration process.

​
Body parameters

​
string
required
The unique identifier of the user at the source of the transaction.
​
string
required
Max. length: 255 charactersThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
​
string
required
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
​
string
Max. length: 255 charactersCustom 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.
​
object
required
Information about the browser used by the end user (author) to perform the payment.
​
string
Allowed values: VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.
​
string
Default value: ECommerceAllowed values: ECommerce, TelephoneOrderThe 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).
​
string
Allowed values: DEFAULT, FORCE, NO_CHOICEDefault value: DEFAULTThe mode applied for the 3DS2 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.
​
string
Default value: MIT
Allowed values: MIT, CITIndicates 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.
​
string
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.

​
Responses

​
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
string
The unique identifier of the user at the source of the transaction.
​
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
string
Max. length: 255 charactersThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
​
string
Max. length: 255 charactersThe URL to which to redirect the user to proceed to 3DS2 validation.
​
boolean
Whether or not the SecureMode was used.
​
string
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
​
object
Information about the browser used by the end user (author) to perform the payment.
​
string
Returned values: VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.
​
string
Default value: ECommerceAllowed values: ECommerce, TelephoneOrderThe 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).
​
string
Default value: DEFAULT
Allowed values: DEFAULT, FORCE, NO_CHOICEThe 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.
​
string
Default value: MIT
Allowed values: MIT, CITIndicates 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.
​
string
Returned values: UNKNOWN, VALID, INVALIDWhether 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 was CREATED for more than 24 hours.
    Once a card is set to INVALID, it cannot be set back to VALID. A new card registration will be necessary to make a payment.
​
Unix timestamp
The date and time at which the object was created.
​
string
Returned values: CARD_VALIDATIONThe type of the card validation.
​
string | null
Returned values: V1, V2_1The 3DS protocol version applied to the transaction.
​
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
string
The explanation of the result code.
​
string
Max. length: 255 charactersCustom 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.
​
string
Information about the card used for the transaction.If the information or data is not available, null is returned.
​
object | null
Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable).