Card API

Download D1-Public-OUT-v2-Card.yaml

Get Card Credentials

get

API used by D1 to call the CMS for retrieving the card credentials (PAN, expiry date, cardholder name and CVV) using a card identifier. It can be used, for example, for displaying the card details to an end user who wants to perform an e-commerce transaction or for registering a 'legacy card' in the D1 system.

Authorizations

bearerAuth

AuthorizationstringRequired

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Path parameters

issuerIdstring · min: 10 · max: 10Required

The id of the issuer

cardIdstring · min: 1 · max: 48Required

Unique identifier of the card.

Pattern: ^[A-Za-z0-9_-]{1,48}$

Header parameters

x-correlation-idstringOptional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

AuthorizationstringOptional

Oauth Access Token (optional)

Example: 'Bearer: 2zzLJmBAtTNIU8nF8e8XbmDvaNGs'

Responses

200

OK

application/json

encryptedDatastring · max: 8192Required

The encryptedData is the encrypted json (cf http://www.json.org/ ) representation of the card credentials.
This value is encrypted using the JWE encryption (please refer to the Encrypt sensitive data for more details)

Content

Once deciphered, the plaintext contains:

JSON field parameter name	description	MOC	Format
pan	The funding pan value.	M	string - from 10 to 19 digits
exp	The expiry date of the card.	M	string - 4 digits, following the format MMYY
name	The card holder name.	O	string - up to 128 characters
cvv	The CVV2 value of the funding card	M	string - 3 or 4 digits

400

Bad Request

application/json

401

Authorization missing or invalid

application/json

403

Action forbidden (if card is not active, for example)

application/json

404

Resource not found (issuerId, cardId)

application/json

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /cms/api/v1/issuers/{issuerId}/cards/{cardId}/credentials HTTP/1.1
Host: YOUR_DOMAIN_NAME
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "encryptedData": "text"
}