Card issuance and personalisation
Create individual, corporate and virtual cards, and check which products a customer is eligible to hold before you issue.
getApplicableProductsByCustomerNumber
Retrieves the list of card products applicable to a specific customer. Filters by main customer number and optional product group. Returns product details including name, number, brand, short name, digital capability, and tenant ID.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getApplicableProductsByCustomerNumber › Request Body
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
customerNumberCustomer Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
Filter - [Optional]
getApplicableProductsByCustomerNumber › Responses
Success
List Of Product - [Optional]
createIndividualCard
Creates an individual debit card for a customer, handling product selection, accounts, permissions, digital card flags, addresses, and miscellaneous options. Returns card references, masked and shadow card numbers, warnings, application ID if created asynchronously, and attached account list.
Part of:
- Journey 01 · Launching a new card product — step 2, Issue against accounts
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createIndividualCard › Request Body
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
productNumberRequired · NotNull — The product the card is issued on. Must be a product the platform defines.
customerNumberRequired · NotNull — The customer the card is issued to.
branchCodeRequired · NotNull — The branch the card is issued from. Must be a defined branch.
Required · ListHasNoItem — The accounts the card draws on. Must be sent and must hold at least one entry.
digitalCardFlagDigital Card Flag
nameOnCardName On Card - [Optional]
cardDeliveryTypeOptional — How the card reaches the cardholder. Branch makes cardDeliveryBranchCode mandatory.
cardSendAddressTypeCard Send Address Type - [Optional]
cardDeliveryBranchCodeConditional · NotNull — The branch the card is delivered to. Mandatory when cardDeliveryType is Branch, and it must be a defined branch.
cardSendAddressIdCard Send Address Id - [Optional]
Permissions - [Optional]
Card Misc Option - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
applicationDateApplication Date - [Optional]
applicationContractIdApplication Contract Id - [Optional]
contractTypeContract Type - [Optional]
contractVersionNumberContract Version Number - [Optional]
createIndividualCard › Responses
Success
recordIdRecord Id - [Optional]
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
applicationIdApplication Id - [Optional]
Attach Account List - [Optional]
createIndividualSupplementaryCard
Create Individual Supplementary Card
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createIndividualSupplementaryCard › Request Body
productNumberProduct Number
channelChannel
digitalCardFlagDigital Card Flag
customerNumberCustomer Number
shadowCardNumberShadow Card Number
nameOnCardName On Card
branchCodeBranch Code
cardDeliveryTypeCard Delivery Type
cardSendAddressTypeCard Send Address Type
cardDeliveryBranchCodeCard Delivery Branch Code
cardSendAddressIdCard Send Address Id
List Of Account
Permissions
Card Misc Option
enrollMasterpassEnroll Masterpass
applicationDateApplication Date
applicationContractIdApplication Contract Id
contractTypeContract Type
contractVersionNumberContract Version Number
createIndividualSupplementaryCard › Responses
Success
recordIdRecord Id
maskedCardNumberMasked Card Number
shadowCardNumberShadow Card Number
cardRefNumberCard Ref Number
mainCardRefNumberMain Card Ref Number
Warnings
applicationIdApplication Id
Attach Account List
createCorporateCard
Creates a corporate debit card for a customer, handling product selection, accounts, delivery options, permissions, and digital card flags. Returns card references, masked and shadow card numbers, warnings, and application ID if created asynchronously.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createCorporateCard › Request Body
productNumberProduct Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
digitalCardFlagDigital Card Flag
customerNumberCustomer Number - [Optional]
shadowCardNumberShadow Card Number
nameOnCardName On Card - [Optional]
secondNameOnCardSecond Name On Card
branchCodeBranch Code - [Optional]
cardDeliveryTypeCard Delivery Type - [Optional]
cardSendAddressTypeCard Send Address Type - [Optional]
cardSendAddressIdCard Send Address Id - [Optional]
cardDeliveryBranchCodeCard Delivery Branch Code - [Optional]
Permissions - [Optional]
List Of Account - [Optional]
applicationDateApplication Date - [Optional]
applicationContractIdApplication Contract Id - [Optional]
createCorporateCard › Responses
Success
recordIdRecord Id - [Optional]
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
mainShadowCardNumberMain Shadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
applicationIdApplication Id - [Optional]
createDummyCorporateCard
Create Dummy Corporate Card
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createDummyCorporateCard › Request Body
productNumberProduct Number
channelChannel
customerNumberCustomer Number
digitalCardFlagDigital Card Flag
cardDeliveryTypeCard Delivery Type
cardSendAddressTypeCard Send Address Type
cardDeliveryBranchCodeCard Delivery Branch Code
branchCodeBranch Code
nameOnCardName On Card
applicationDateApplication Date
createDummyCorporateCard › Responses
Success
cardMasterRecordIdCard Master Record Id
secureCardMasterRecordIdSecure Card Master Record Id
cardRefNumberCard Ref Number
mainCardRefNumberMain Card Ref Number
shadowCardNumberShadow Card Number
createVirtualCard
Creates a virtual debit card linked to an existing shadow card, handling accounts and Masterpass enrollment. Returns card references, masked and shadow card numbers, attached accounts, warnings, and sensitive card data including PAN, CVV, and expiry date.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createVirtualCard › Request Body
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
List Of Account - [Optional]
createVirtualCard › Responses
Success
recordIdRecord Id
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
relatedCardRefNumberRelated Card Ref Number - [Optional]
Warnings - [Optional]
Sensitive Card Data - [Optional]
Attach Account List - [Optional]
getPendingCardEmbossList
Retrieves pending embossing information for a debit card using its shadow card number. Returns details including card sequence, emboss and application dates, reason codes and descriptions, emboss status, product type, masked card number, shadow card number, and validity flag.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getPendingCardEmbossList › Responses
Success
cardSeqNumberCard Seq Number - [Optional]
embossDateEmboss Date - [Optional]
applicationDateApplication Date - [Optional]
embossReasonCodeEmboss Reason Code - [Optional]
embossReasonDescriptionEmboss Reason Description - [Optional]
embossReasonSubCodeEmboss Reason Sub Code - [Optional]
embossReasonSubDescEmboss Reason Sub Desc - [Optional]
embossStatusEmboss Status - [Optional]
maskedCardNumberMasked Card Number - [Optional]
productTypeCodeProduct Type Code - [Optional]
productTypeDescriptionProduct Type Description - [Optional]
shadowCardNumberShadow Card Number - [Optional]
validFlagValid Flag - [Optional]
cancelCardEmbossByShadowCardNumber
Cancels the embossing of a debit card using the shadow card number and channel. Logs the operation and validates the request before processing.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelCardEmbossByShadowCardNumber › Request Body
shadowCardNumberShadow Card Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
cancelCardEmbossByShadowCardNumber › Responses
Success