v1

latestOpenAPI 3.0.02026-07-2352269214.0 KB

Verify Card

When a tokenization request reaches D1, D1 can call your backend with this method to verify the status of the card for which the tokenization has been requested. This call will be done if the CVK used to compute the card CVV/DCVV has not been shared with D1 during the onboarding process.

It is expected that your backend verifies the consistency between the card information provided versus the card information known by the backend itself. As a minimum, you should check the following:

  • that the PAN is valid
  • if no expiration date is provided, that the card has not expired
  • if a CVV is provided, that it is valid

It is important that you provide a proper result response because D1 uses this result when making a decision regarding the tokenization request of the card.

If the card is not already registered in D1, and if it has been configured during the on boarding to not reject an unknow card. Then along with the card details, D1 provides a unique card reference : the cardId. You can, OPTIONALLY, override this value by providing your own card ID in the response. In this case, however, you must guarantee the uniqueness of the ID. It is also required to provide a reference of the cardholder information (consumerId). If D1 accepts the card verification, then the consumer and the card will be automatically registered in D1.

If the card is not already registered in D1, and if it has been configured during the on boarding to reject an unknow card. Then the tokenization flow will be stopped before calling your backend, and you will have to register the card using D1 register card API.

post/cms/api/v1/issuers/{issuerId}/cards/credentials

Headers

Authorizationstring

Oauth Access Token (optional)

Request body

encryptedDatastring required

The encryptedData is the encrypted json (cf http://www.json.org/ ) representation of the card credentials.<br/>This value is encrypted using the JWE encryption (please refer to the Sensitive Information Encryption for more details)<br/><br/><b>Content</b><br/><br/>Once deciphered, the plaintext contains:

JSON field parameter namedescriptionMOCFormat
panThe funding pan value.Mstring - from 10 to 19 digits
expThe expiry date of the card.Mstring - 4 digits, following the format MMYY
nameThe card holder name.Ostring - up to 128 characters
cvvThe CVV2 value of the funding cardOstring - 3 or 4 digits
cardIdstring required

Unique identifier of the card.

cardBinstring required

The first 6 digits of the PAN

Response

OK

cardIdstring

Unique identifier of the card.

consumerIdstring

Unique identifier of the end user.

Must be provided only when the card verification is successful: verificationResults.card.invalid flag is false.

accountIdstring

Unique identifier of the account.

Note: This parameter is deprecated, you can still send it but it will be ignored.