View a Card Validation

Path parameters

CardId · string · required

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

ValidationId · string

The unique identifier of the Card Validation object.

Responses

200 - Succeeded

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.

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

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.

200 - Succeeded

{
    "Id": "110e5f73-9bdc-4333-860d-84dc3ab0fb3a",
    "AuthorId": "user_m_01HT2NFK7Z2BRQNGNHMY30VVTT",
    "Status": "SUCCEEDED",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore?cardValidationId=110e5f73-9bdc-4333-860d-84dc3ab0fb3a",
    "SecureModeRedirectURL": null,
    "SecureModeNeeded": false,
    "IpAddress": "159.180.248.187",
    "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",
    "PaymentCategory": "ECommerce",
    "ValidationUsage": "CIT",
    "Validity": "VALID",
    "CreationDate": 1717085089,
    "AuthorizationDate": 1717085089,
    "Type": "CARD_VALIDATION",
    "Applied3DSVersion": "V2_1",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "Tag": "Custom meta",
    "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "Brand": "VISA",
        "SubType": null
    }
}

NodeJS

const mangopayInstance = require('mangopay2-nodejs-sdk');
const mangopay = new mangopayInstance({
    clientId: "your-client-id",
    clientApiKey: "your-api-key",
})

let myCard = {
  Id: 'card_m_01HRAB5X7K39MDNS5NV6DD68G8'
}

let myCardValidation = {
  Id: '5b0ab172-e1fd-47d7-a1f8-d674986630d2'
}

  const viewCardValidation = async (cardValidationId) => {
    return await mangopay.Cards.getCardValidation(myCard.Id, cardValidationId) 
      .then((response) => {
        console.info(response)
        return response
      })
      .catch((err) => {
        console.log(err)
        return false
      })
  }
  
  viewCardValidation(myCardValidation.Id)