v1

latestOpenAPI 3.0.02026-07-2352269214.0 KB
Card

Register Card

This request is used to register a card with corresponding cards credentials. This operation is applicable for card product supporting:

  • No authorisation mode
  • Light authorisation mode

The cardId used to register the card shall be unique. A cardId can be reused to register another card (having a different PAN) under several conditions:

  • The cardId to be reused is linked with a DELETED or REPLACED card
  • The cardId to be reused is not associated to a card issued by D1 (a card created using the CREATE card API).
  • The cardId to be reused is not associated with a card product used for making transactions
  • In any case, it is not possible to register a card PAN already deleted or replaced. Even by reusing a cardId. Reusing a cardId for another consumer is not recommanded. Since the cardId will disappear from the previous consumer cards list.
put/v2/issuers/{issuerId}/cards/{cardId}

Request body

consumerIdstring required

Unique identifier of the end user.

cardProductIdstring required

Unique identifier of the type of card (defined during the onboarding of D1)

state'ACTIVE' | 'SUSPENDED'

The state of the card<br/>If not provided, the card is considered ACTIVE

namestring required

Name of the card holder as it will be printed/embossed on the card.<br/>For virtual card this value will be used exclusively for card display.<br/>Empty string supported.

secondNamestring

Optional second card holder name as it will be printed/embossed on the card under the first card holder name.<br/>Not used in case of virtual card.

encryptedDatastring required

The encryptedData is the encrypted json (cf http://www.json.org/) representation of the Card information. This value is encrypted using the JWE encryption (please refer to the Encrypt sensitive data for more details) <br/><br/>Once deciphered, the plaintext contains a json structure with:

JSON field parameter namedescriptionMOCFormat
panThe funding pan value.Mstring - up to 19 digits
expThe expiry date of the card.Mstring - 4 digits, following the format MMYY
auxiliaryPanThe auxiliary funding pan value. It shall be provided when cobadge is supported and if the card has an auxiliary pan.Cstring - up to 19 digits
auxiliaryExpThe auxiliary expiry date of the card. It shall be provided when cobadge is supported and if the card has an auxiliary pan.Cstring - 4 digits, following the format MMYY

As D1 is able to compute the CVV2, the cvv parameter is not expected. <br> <br>

Response

Successful card registration