Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
i) Card Management

Get a card by ID

Retrieves a card by ID. To receive an unmasked PAN and CVV (masked=false), the caller must be the cardholder using their own JWT or a valid card access password (CAP). This endpoint must only be called from the cardholder's device when unmasked data is requested.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/cards/{cardId}

Path parameters

tenantIdinteger required
cardIdinteger required

Query parameters

capstring

The card access password of the customer. Required if masked=false and no JWT is provided

fieldsstring

Used to include additional details along with the card information. For example, if a card level limit is required, it can be passed as a field i.e. fields=limits. It supports multiple values using a comma-separated format to include in the response

maskedboolean

If false then the full PAN and CVV will be returned. An error will be returned if masked=false and the caller is not the card owner or a valid CAP is not provided

Response

OK

cardHolderNamestring

Name of the card holder as printed on the card

cardIdinteger

Unique system generated identifier for a card

cardIdentifierType'ADDON_CARD' | 'PRIMARY_CARD' | 'SUPPLEMENTARY_CARD'
cardPackIdstring
cardType'PERSONALISED' | 'PHYSICAL' | 'VIRTUAL'

Card type either physical or virtual card

createdstring date-time

ISO 8601 date/time of when the record was first created

customerIdinteger

Customer the card belongs to

cvvstring

CVV/CVC of the card

expiresstring date-time

ISO 8601 date/time of when the card expires

externalUniqueIdstring

External unique identifier for the card

lifeCycleStatus'ACTIVATED' | 'INACTIVE'
panstring

Primary account number of the card

programNamestring
status'ACTIVE' | 'CANCELLED' | 'EXPIRED' | 'FIRST_TIME_ACTIVATION' | 'LOST_PICKUP' | 'NO_SAVING_ACCOUNT' | 'PIN_TRIES_EXCEEDED' | 'REPLACED' | 'RESTRICTED' | 'STOLEN_PICKUP' | 'STOPPED'

Status of the card ACTIVE:Can be used, STOPPED is temporarily blocked from use. CANCELLED is permanently disabled.

statusChangeReasonstring
walletIdinteger

The wallet the card is mapped to if it only has a single mapping - deprecated use walletIds instead

walletIdsinteger[]

The wallets the card is mapped to. Use this and not walletId

Example response

{
  "created": "2022-03-10T12:15:50-04:00",
  "expires": "2022-03-10T12:15:50-04:00"
}