A card is a payment mean that enables a customer to access funds or make purchases against a line of credit.
In our solution each Card is identified by a unique cardReference and optionally by a unique issuerCardExternalReference per Issuer.
The first Card of a Card Contract is created at the same time than the Card Contract.
Card information can be retrieved using the two following endpoints :
- Retrieve the card information :
GET /issuers/{issuerId}/cards/{cardReference} - Search cards by pan and panSequenceNumber and/or expiryDate :
POST /issuers/{issuerId}/cards/{cardReference}/search
Card Lifecycle
The following picture illustrates the card lifecycle and possible card status transition.
The following APIs could be used to manage card lifecycle :
- Activate a card :
POST /issuers/{issuerId}/cards/{cardReference}/activate - Deactivate a card :
POST /issuers/{issuerId}/cards/{cardReference}/deactivate - Block a card :
POST /issuers/{issuerId}/cards/{cardReference}/block - Unblock a card :
POST /issuers/{issuerId}/cards/{cardReference}/unblock
Card Replacement and Renewal
The user can use the API to replace an existing card and create a new one. As input the replacement reason (e.g. old card was lost, stolen, is defective, name change) need to be provided. Both PAN and expiry date of the new card are calculated following the rules defined in the Product configuration for the provided replacement reason.
POST /issuers/{issuerId}/cards/{cardReference}/replace
The renewal of the card can be managed automatically in our solution, an automatic process is triggered when card is close to expire and a new card is created replacing the existing card.