Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
d) Customer Management

Issue a replacement or addon card to the customer for an existing card on their profile

This is for addon and replacement cards. For a nett-new card, create a new wallet which supports cards. If physical card details are provided then an existing physical card will be used or else a virtual card will be issued

post/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/cards

Path parameters

tenantIdinteger required
customerIdinteger required

Request body

addOnCustomerIdinteger

This field is required when you are creating an ADD_ON card for the secondary user

cardHolderNamestring

Name of the card holder as printed on the card

cardProvisionReasonCode'EXPIRED_CARD' | 'NEW_ADDON' | 'NEW_PRIMARY' | 'NEW_SUPPLEMENTARY' | 'REPLACEMENT'
cardType'PERSONALISED' | 'PHYSICAL' | 'VIRTUAL'

Card type either physical or virtual card

customerIdinteger

This field is required when you are creating an primary card for a user

externalUniqueIdstring

The externally provided unique identifier.

lifeCycleStatus'ACTIVATED' | 'INACTIVE'
operationType'ADDON_CARD' | 'CARD_REPLACEMENT'

Type of operation that you want to perform on card. ADDON_CARD: Add-on card are the additional cards issued under a primary(Physical/Virtual) card E.g. that could be applied for family members like spouse, children etc, CARD_REPLACEMENT: Use this option when your primary physical card is damaged, lost and/or stopped and wants to replace it.

programNamestring

The program name to use when provisioning this card, mainly to support cards enrolled via integration with Pn where there is no perso file upload

skipCmsCreateNotificationboolean

Controls whether or not to suppress the card-creation notification sent to the remote card management system (CMS). Does not affect SMS/email notifications sent to the cardholder, default to false

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

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

walletIdinteger

The wallet the card must be linked to

walletIdsinteger[]

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

walletTypeIdinteger

The type of wallet. This controls the behaviour and rules of the wallet

Example request

{
  "physicalCardIdentifier": {
    "expiry": "2022-03-10T12:15:50-04:00"
  },
  "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"
}