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 applicable card products for a specific customer. Supports Debit and Credit cards, filtering by customer number, main customer number, and optional product group code. Maps cached card products to GetApplicableProductsItem including ProductName, ProductNumber, Brand, ProductShortName, DigitalAbility, TenantId, and CardAnnualFeeAmount for Credit cards. Returns results as GetApplicableProductsByCustomerNumberResponse with Debit and Credit lists. Prepaid card support is planned but not implemented.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getApplicableProductsByCustomerNumber › Request Body
customerNumberCustomer Number
receiveCreditProductsReceive Credit Products
receiveDebitProductsReceive Debit Products
receivePrepaidProductsReceive Prepaid Products
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.
mainCustomerNumberMain Customer Number - [Optional]
Filter - [Optional]
getApplicableProductsByCustomerNumber › Responses
Success
Debit - [Optional]
Credit - [Optional]
Prepaid - [Optional]
createIndividualDebitCard
Creates an individual debit card for a customer. If ProductNumber is not provided, automatically selects the primary product. Builds card address info, maps account list, sets card permissions, and calls CreateIndividualCard on the debit management service. Returns card identifiers and warnings.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createIndividualDebitCard › Request Body
digitalCardDigital Card
customerNumberCustomer Number
branchCodeBranch Code
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.
productNumberProduct Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
cardDeliveryTypeCard Delivery Type - [Optional]
cardSendAddressTypeCard Send Address Type - [Optional]
cardSendAddressIdCard Send Address Id - [Optional]
cardDeliveryBranchCodeCard Delivery Branch Code - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
Permissions - [Optional]
List Of Account - [Optional]
applicationDateApplication Date - [Optional]
contractTypeContract Type - [Optional]
contractVersionNumberContract Version Number - [Optional]
virtualCardRelatedCardRefNumberVirtual Card Related Card Ref Number - [Optional]
nameOnCardName On Card - [Optional]
createIndividualDebitCard › Responses
Success
recordIdRecord Id
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
createCorporateDebitCard
Creates a corporate debit card for a customer. Auto-selects ProductNumber if null. Sends customer details, branch info, card delivery type, permissions, accounts, and optional application date & name on card to _debitManagementServiceProxy.CreateCorporateCard. Returns CardRefNumber, MainCardRefNumber, MaskedCardNumber, ShadowCardNumber, RecordId, and Warnings.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createCorporateDebitCard › Request Body
customerNumberCustomer Number
mainCustomerNumberMain Customer Number
branchCodeBranch Code
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.
productNumberProduct Number - [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]
nameOnCardName On Card - [Optional]
secondNameOnCardSecond Name On Card
createCorporateDebitCard › Responses
Success
recordIdRecord Id
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
replaceDebitCard
Replaces a debit card. Calls the debit management service to generate a new card or update product details for the specified debit card. Returns the new shadow card number, masked card number, card reference number, and flags indicating if a new card was generated or the product was changed.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
replaceDebitCard › Request Body
deliveryBranchCodeDelivery Branch Code
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]
embossNameEmboss Name - [Optional]
deliveryTypeDelivery Type - [Optional]
deliveryAddressTypeDelivery Address Type - [Optional]
cardEmbossReasonCard Emboss Reason - [Optional]
cardEmbossSubReasonCard Emboss Sub Reason - [Optional]
renewTypeRenew Type - [Optional]
productNumberProduct Number - [Optional]
digitalCardDigital Card - [Optional]
Permissions - [Optional]
replaceDebitCard › Responses
Success
newCardGeneratedNew Card Generated
productChangedProduct Changed
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
cancelDebitEmbossByShadowCardNumber
Cancels a debit card embossing using the shadow card number. Validates the request for non-empty ShadowCardNumber and a valid Channel, then calls the internal debit management service to perform the cancellation. Logs success and failure events.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelDebitEmbossByShadowCardNumber › Request Body
shadowCardNumberShadow Card Number - [Optional]
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.
cancelDebitEmbossByShadowCardNumber › Responses
Success
getPendingCardEmbossList
Retrieves pending card emboss information for a given shadow card number. Returns details including card sequence number, emboss date, application date, emboss reason code and description, sub reason code and description, emboss status, masked card number, product type code and description, shadow card number, and valid flag.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getPendingCardEmbossList › Request Body
shadowCardNumberShadow Card Number - [Optional]
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]
cancelEmbossByShadowCardNumber
Cancels an emboss operation for a card by its ShadowCardNumber. Determines the card type (Debit, Credit, Prepaid) and calls the appropriate cancel method. Debit cards are handled via CancelDebitEmbossByShadowCardNumber; Credit and Prepaid cards are not implemented. Validates ShadowCardNumber and Channel before processing.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelEmbossByShadowCardNumber › Request Body
shadowCardNumberShadow Card Number - [Optional]
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.
cancelEmbossByShadowCardNumber › Responses
Success