Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
i) Card Management

Update a card by ID

Updates card attributes including status, PIN, PIN retry count, and spending rules. PIN changes require the caller to be PCI compliant or to supply a valid Card Access Password (CAP).

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

Path parameters

tenantIdinteger required
cardIdinteger required

Request body

capstring

Optional,The card access password of the customer. Required if no JWT is provided and want to update card.

cardHolderNamestring

Allows the update of cardholder name associated with the card

lifeCycleStatus'ACTIVATED' | 'INACTIVE'
pinstring

The initial or updated PIN to set on the card. Dont pass this parameter to leave PIN as-is

pinBlockstring

Optional. The PINBlock encrypted under Terminal PIN Key (TPK). The PINBlock would be translated to ZPK Encryption for transportation

pinBlockFormat'ISO_0' | 'ISO_1' | 'ISO_2' | 'ISO_3' | 'ISO_4'

The PINBlock format to use for the PINBlock encryption

pinRetryCounterinteger

Pass as 0 to reset the incorrect pin retry counter to 0. Any other value is ignored

programNamestring

Allows the update of card program name associated with the card

reason'BANK' | 'CANCELREPLACEMENT' | 'CAPTURE' | 'COUNTERFEIT' | 'DAMAGED' | 'EMERGENCY' | 'ERRONEOUS' | 'EXPIRED' | 'FOUND' | 'FRAUD' | 'LOST' | 'MISCELLANEOUS' | 'OVERDUE' | 'RETURNED' | 'STOLEN' | 'STOPLIST' | 'UNBLOCKED' | 'UPDATED_REMOTELY'

Type of Eclipse card status reason

sovNamestring

Allows the update of sov name for cards migrated to Eclipse as SOV

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.

syncWithRemoteboolean

Optionally disable syncing card with remote by default its synced

userIdinteger

Allows the update of userId associated with the card

Example request

{
  "virtualCardIdentifier": {
    "expiry": "2022-03-10T12:15:50-04:00"
  }
}

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"
}