Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
h) Wallets

Create a card linked to the existing wallet

For prepaid programs: Create a new supplementary card for existing primary card. For debit programs: Create a card under the wallet even if there is no existing card.

post/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/cards

Path parameters

tenantIdinteger required
walletIdinteger required

Request body

cardHolderNamestring

Name of the card holder as printed on the card

cardType'PERSONALISED' | 'PHYSICAL' | 'VIRTUAL'

Card type either physical or virtual card

customerIdinteger

This field is relevant only when issuing a card against an organisation wallet. In such cases, the provided customerId must hold a valid position within the organisation and this position must be defined at the tenant level config called allowedOrgPositionForCardIssuing. For example, if you want to issue a card on behalf of the organisation head, the property at the tenant level should be set as allowedOrgPositionForCardIssuing=HEAD

externalUniqueIdstring

The externally provided unique identifier.

operationType'ADDON_CARD' | 'PRIMARY_CARD' | 'SUPPLEMENTARY_CARD'
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

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