Create a Card Validation

POST /V2.01/{ClientId}/cards/{CardId}/validation

REST

{
    "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
    "SecureModeReturnURL": "http://example.com",
    "IpAddress": "466b:ed49:0966:f7fe:1e09:d7de:4e24:b612",
    "Tag": "Created using the Mangopay API Postman collection",
    "BrowserInfo": {
        "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
        "JavaEnabled": true,
        "Language": "fr",
        "ColorDepth": 32,
        "ScreenHeight": 667,
        "ScreenWidth": 375,
        "TimeZoneOffset": "-120",
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "PreferredCardNetwork":"CB",
    "SecureMode":"NO_CHOICE",
    "ValidationUsage":"CIT"
}  

200 - Created

{
    "Id": "wt_b7f55dd5-d699-46da-8c43-51c166e116f9",
    "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
    "Status": "CREATED",
    "SecureModeReturnURL": "http://example.com?cardValidationId=wt_b7f55dd5-d699-46da-8c43-51c166e116f9",
    "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=b7f55dd5-d699-46da-8c43-51c166e116f9&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvZDNjNWI0ODMtNTdjMC00NzA2LTkxZTAtMjk4ZDA5ZWFhY2Mw&amount=MA&currency=RVVS",
    "SecureModeNeeded": true,
    "IpAddress": "466b:ed49:0966:f7fe:1e09:d7de:4e24:b612",
    "BrowserInfo": {
        "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
        "JavaEnabled": true,
        "Language": "fr",
        "ColorDepth": 32,
        "ScreenHeight": 667,
        "ScreenWidth": 375,
        "TimeZoneOffset": -120,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "PreferredCardNetwork": null,
    "SecureMode": "DEFAULT",
    "PaymentCategory": "ECommerce",
    "Type": "CARD_VALIDATION",
    "SecurityInfo": {
        "AVSResult": "NO_CHECK"
    },
    "ValidationUsage": "MIT",
    "Validity": "UNKNOWN",
    "CreationDate": 1771580513,
    "Applied3DSVersion": null,
    "ResultCode": null,
    "ResultMessage": null,
    "Tag": "Created using the Mangopay API Postman collection",
    "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "SubType": null,
        "Brand": "VISA"
    },
    "AuthenticationResult": {
        "AuthenticationType": "CHALLENGE"
    }
}

Path parameters

CardId · string · required

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

Body parameters

AuthorId · string · required

The unique identifier of the user at the source of the transaction.

SecureModeReturnURL · string · required

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).

IpAddress · string · required

The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.

Tag · string

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.

BrowserInfo · object · required

Information about the browser used by the end user (author) to perform the payment.

Show properties

AcceptHeader · string · required

The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.

JavaEnabled · boolean · required

Whether or not the end user’s browser has the ability to execute Java.

Language · string · required

Format: Two-letter language code (ISO 639-1 alpha-2) followed by two-letter country code (ISO 3166-1 alpha-2), separated by a hyphen (example: en-US; pattern:^[a-zA-Z]{2}(-[a-zA-Z]{2})?$)

The language of the browser.

ColorDepth · integer · required

The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.

ScreenHeight · integer · required

Max. length: 6 characters

The height of the screen in pixels.

ScreenWidth · integer · required

Max. length: 6 characters

The width of the screen in pixels.

TimeZoneOffset · integer · required

The difference in minutes between the browser’s timezone and UTC.

UserAgent · string · required

Max. length: 255 characters

The exact content of the HTTP User-Agent header.

JavascriptEnabled · boolean · required

Whether or not the end user’s browser has the ability to execute JavaScript.

PreferredCardNetwork · string

Allowed values: VISA, MASTERCARD, CB, MAESTRO

The card network to use, as chosen by the cardholder, in case of co-branded cards.

PaymentCategory · string

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).

SecureMode · string

Allowed values: DEFAULT, FORCE, NO_CHOICE

Default value: DEFAULT

The 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.

ValidationUsage · string

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.

ProfilingAttemptReference · 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

200 - Created

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

AuthorId · string

The unique identifier of the user at the source of the transaction.

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

SecureModeReturnURL · string

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).

SecureModeRedirectURL · string

Max. length: 255 characters

The URL to which to redirect the user to proceed to 3DS2 validation.

SecureModeNeeded · boolean

Whether or not the SecureMode was used.

IpAddress · string

The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.

BrowserInfo · object

Information about the browser used by the end user (author) to perform the payment.

Show properties

AcceptHeader · string

The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.

JavaEnabled · boolean

Whether or not the end user’s browser has the ability to execute Java.

Language · string

Format: Two-letter language code (ISO 639-1 alpha-2) followed by two-letter country code (ISO 3166-1 alpha-2), separated by a hyphen (example: en-US; pattern:^[a-zA-Z]{2}(-[a-zA-Z]{2})?$)

The language of the browser.

ColorDepth · integer

The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.

ScreenHeight · integer

Max. length: 6 characters

The height of the screen in pixels.

ScreenWidth · integer

Max. length: 6 characters

The width of the screen in pixels.

TimeZoneOffset · integer

The difference in minutes between the browser’s timezone and UTC.

UserAgent · string

Max. length: 255 characters

The exact content of the HTTP User-Agent header.

JavascriptEnabled · boolean

Whether or not the end user’s browser has the ability to execute JavaScript.

PreferredCardNetwork · string

Returned values: VISA, MASTERCARD, CB, MAESTRO

The card network to use, as chosen by the cardholder, in case of co-branded cards.

PaymentCategory · string

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).

SecureMode · string

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.

ValidationUsage · string

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.

Validity · string

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 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.

CreationDate · Unix timestamp

The date and time at which the object was created.

Type · string

Returned values: CARD_VALIDATION

The type of the card validation.

Applied3DSVersion · string | null

Returned values: V1, V2_1

The 3DS protocol version applied to the transaction.

ResultCode · string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage · string

The explanation of the result code.

Tag · string

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.

CardInfo · string

Information about the card used for the transaction.

If the information or data is not available, null is returned.

Show properties

BIN · string

The 6-digit bank identification number (BIN) of the card issuer.

IssuingBank · string

The name of the card issuer.

IssuerCountryCode · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country where the card was issued.

Type · string

Returned values: DEBIT, CREDIT, CHARGE CARD.

The type of card product.

Brand · string

The card brand. Examples include: AMERICAN EXPRESS, DISCOVER, JCB, MASTERCARD, VISA, etc.

Note: The possible returned values are numerous and liable to evolve over time.

SubType · string

The subtype of the card product. Examples include: CLASSIC, GOLD, PLATINUM, PREPAID, etc.

Note: The possible returned values are numerous and liable to evolve over time.

AuthenticationResult · 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).

Show properties

AuthenticationType · string | null

Response values: CHALLENGE, FRICTIONLESS, DIRECT_AUTHORIZATION

The type of authentication:

• CHALLENGE – The issuer requested SCA to be enforced (for example, using 3DS).
• FRICTIONLESS – The transaction was exempted from SCA because an exemption was granted by the issuer.
• DIRECT_AUTHORIZATION – The transaction was sent to the issuer for authorization without any frictionless or challenge (for example, if SCA doesn’t apply).

A null value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received.

400 - Only available for CB_VISA_MASTERCARD

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "c67ea4b3-c144-4142-8fbd-aca45be840da",
    "Date": 1706044641.0,
    "errors": {
        "CardId": "The underlying card type is invalid. Only card type CB_VISA_MASTERCARD is accepted on this feature."
    }
}  

400 - Card validation already pending

{
    "Message":"One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type":"param_error",
    "Id":"7a2d1d57-6c0e-4689-bb80-62222ae073ed#1687358437",
    "Date":1687358438.0,
    "errors":{
        "CardId":"This card is already being validated."
    }
}  

400 - The card is already valid

{
    "Message":"One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type":"param_error",
    "Id":"7af030d9-c652-4cfa-a76b-ae445018ed6e#1687358113",
    "Date":1687358114.0,
    "errors":{
        "CardId":"This card is already VALID."
    }
}  

400 - The card is invalid

{
    "Message":"One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type":"param_error",
    "Id":"7af030d9-c652-4cfa-a76b-ae445018ed6e#1687358113",
    "Date":1687358114.0,
    "errors":{
        "CardId":"This card is INVALID."
    }
}  

200 - Created

{
    "Id": "wt_b7f55dd5-d699-46da-8c43-51c166e116f9",
    "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
    "Status": "CREATED",
    "SecureModeReturnURL": "http://example.com?cardValidationId=wt_b7f55dd5-d699-46da-8c43-51c166e116f9",
    "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=b7f55dd5-d699-46da-8c43-51c166e116f9&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvZDNjNWI0ODMtNTdjMC00NzA2LTkxZTAtMjk4ZDA5ZWFhY2Mw&amount=MA&currency=RVVS",
    "SecureModeNeeded": true,
    "IpAddress": "466b:ed49:0966:f7fe:1e09:d7de:4e24:b612",
    "BrowserInfo": {
        "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
        "JavaEnabled": true,
        "Language": "fr",
        "ColorDepth": 32,
        "ScreenHeight": 667,
        "ScreenWidth": 375,
        "TimeZoneOffset": -120,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "PreferredCardNetwork": null,
    "SecureMode": "DEFAULT",
    "PaymentCategory": "ECommerce",
    "Type": "CARD_VALIDATION",
    "SecurityInfo": {
        "AVSResult": "NO_CHECK"
    },
    "ValidationUsage": "MIT",
    "Validity": "UNKNOWN",
    "CreationDate": 1771580513,
    "Applied3DSVersion": null,
    "ResultCode": null,
    "ResultMessage": null,
    "Tag": "Created using the Mangopay API Postman collection",
    "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "SubType": null,
        "Brand": "VISA"
    },
    "AuthenticationResult": {
        "AuthenticationType": "CHALLENGE"
    }
}

REST

{
    "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
    "SecureModeReturnURL": "http://example.com",
    "IpAddress": "466b:ed49:0966:f7fe:1e09:d7de:4e24:b612",
    "Tag": "Created using the Mangopay API Postman collection",
    "BrowserInfo": {
        "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
        "JavaEnabled": true,
        "Language": "fr",
        "ColorDepth": 32,
        "ScreenHeight": 667,
        "ScreenWidth": 375,
        "TimeZoneOffset": "-120",
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "PreferredCardNetwork":"CB",
    "SecureMode":"NO_CHOICE",
    "ValidationUsage":"CIT"
}