Card lifecycle
Move a card through its states after issuance — status changes, replacement, renewal, blocking and closure.
getCustomerDebitCardListByTenantId
Returns the list of debit cards for a customer filtered by tenant. Retrieves card data via GetCustomerDebitCardListByTenant, enriches results with account balance information from Core Banking, and determines pending replace status based on renewal flags. Performs request validation and returns GetCustomerDebitCardListByTenantIdResponse containing customer debit card details.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCustomerDebitCardListByTenantId › Request Body
customerNumberCustomer Number
tenantIdTenant Id
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.
getCustomerDebitCardListByTenantId › Responses
Success
Customer Debit Card List - [Optional]
getCustomerDebitShadowCardsByTenantId
Returns the list of debit shadow cards for a customer filtered by tenant. Retrieves shadow card information via GetCustomerDebitShadowCardsByTenant and returns card type, masked and shadow card numbers, product details, and card status information after request validation.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCustomerDebitShadowCardsByTenantId › Request Body
customerNumberCustomer Number
tenantIdTenant Id
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.
getCustomerDebitShadowCardsByTenantId › Responses
Success
Customer Debit Shadow Card List - [Optional]
changeCardStatus
Changes the status of a debit card using status code, reason, and optional transaction information. Returns whether the card status is active after the change.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCardStatus › Request Body
shadowCardNumberRequired · NotNullOrWhiteSpace — The card whose status changes.
statusCodeRequired · Enum · NotNullOrWhiteSpace · EqualValue — The status to move to. Must be a status the platform defines, and the move must be permitted for this channel group.
statusReasonCodeRequired · Dependent · NotNullOrWhiteSpace · EqualValue — The reason for the new status. Must be a reason defined for statusCode.
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel, and its group must be Backoffice, Branch, CallCenter, System or Security — no other channel may change a card's status.
transactionIdOptional — The caller's own id. Echoed back in the error body.
closeRequestDateOptional · Nullable · Format date-time — The date the closure was requested.
changeCardStatus › Responses
Success
toStatusActiveTo Status Active
getCardList
Retrieves the list of debit cards based on multiple filters such as ShadowCardNumber, CustomerNumber, MainCustomerNumber, Barcode, AccountNumber, BranchCode, CustomerNameSurname, IdentificationNumber, and CourierStatus. Supports corporate cards, active cards, and digital card flags. Returns a list of DebitCardModel including card details, sensitive data when applicable, account information via ListCardAccountByShadowCardNumber, card status logs, delivery information, and PIN setup status. Uses _dcidRepository.GetSearchByCustomernumberCardnumber for searching, _dbtServiceProxy for account and permission operations, _customerServiceProxy for card and PAN retrieval, and GetSensitiveData for retrieving sensitive card data such as CVV2.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardList › Request Body
customerNumberCustomer Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
barcodeBarcode - [Optional]
accountNumberAccount Number - [Optional]
cardNumberCard Number - [Optional]
purposePurpose - [Optional]
channelCodeThree-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.
tenantIdTenant Id - [Optional]
isCorporateAllCardListIs Corporate All Card List - [Optional]
branchCodeBranch Code - [Optional]
customerNameSurnameCustomer Name Surname - [Optional]
identificationNumberIdentification Number - [Optional]
courierStatusCourier Status - [Optional]
getCardList › Responses
Success
List Of Card - [Optional]
getCardListNew
Retrieves the list of debit cards based on multiple filters such as ShadowCardNumber, CustomerNumber, MainCustomerNumber, Barcode, AccountNumber, BranchCode, CustomerNameSurname, IdentificationNumber, and CourierStatus. Supports corporate cards, active cards, and digital card flags. Returns a list of DebitCardModel including card details, sensitive data when applicable, account information via ListCardAccountByShadowCardNumber, card status logs, delivery information, and PIN setup status. Uses _dcidRepository.GetSearchByCustomernumberCardnumber for searching, _dbtServiceProxy for account and permission operations, _customerServiceProxy for card and PAN retrieval, and GetSensitiveData for retrieving sensitive card data such as CVV2.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardListNew › Request Body
customerNumberCustomer Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
barcodeBarcode - [Optional]
accountNumberAccount Number - [Optional]
cardNumberCard Number - [Optional]
purposePurpose - [Optional]
channelCodeThree-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.
tenantIdTenant Id - [Optional]
isCorporateAllCardListIs Corporate All Card List - [Optional]
branchCodeBranch Code - [Optional]
customerNameSurnameCustomer Name Surname - [Optional]
identificationNumberIdentification Number - [Optional]
courierStatusCourier Status - [Optional]
getCardListNew › Responses
Success
List Of Card - [Optional]
getCardInfo
Retrieves detailed information for a debit card using either the CardNumber (PAN) or ShadowCardNumber.
Includes card metadata (status, branch, product, owner, expiry, virtual/digital flags, embossing info, sensitive data)
and the list of attached accounts with account balances, usable balances, IBAN, currency, account type/subtype, and error info if fetching fails.
Uses _customerServiceProxy to map PAN to ShadowCardNumber, _dcidRepository for card search, and _coreBankingIntegrationOutdoor for account info.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardInfo › Request Body
shadowCardNumberOne-of — The card to read. Send this or cardNumber; sending neither is refused.
cardNumberOne-of — The card's PAN. Resolved to a shadow card number first, and refused if it matches none. When both are sent this one is used.
getCardInfo › Responses
Success.
cardInfo can come back empty with a 200: the card is looked up, and if what comes back is not the shadowCardNumber that was asked for, the response is returned unfilled rather than refused.
Card Info - [Optional]
replaceCard
Replaces an existing card with a new one. Accepts details such as card emboss reason, product number, delivery information, and optional permissions. Returns the new card information, including masked number, shadow card number, and any warnings.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
replaceCard › Request Body
channelRequired · Enum · NotNullOrWhiteSpace — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNullOrWhiteSpace — The card being replaced.
cardEmbossReasonRequired · Enum · NotNullOrWhiteSpace · NotEqualValue — Why the card is reissued. Renew is the only value this operation accepts; anything else is refused.
cardEmbossSubReasonRequired · NotNullOrWhiteSpace — The sub-reason under cardEmbossReason.
embossNameOptional — The name printed on the card.
deliveryTypeOptional — How the card reaches the cardholder. Branch makes deliveryBranchCode mandatory.
deliveryBranchCodeConditional — The branch the card is delivered to. Mandatory when deliveryType is Branch.
deliveryAddressTypeOptional — The address type the card is sent to.
productNumberOptional — Reissue onto a different product. If sent it must be a product the platform defines; the product change scenario must exist too.
cardSendAddressIdOptional — The stored address the card is sent to.
enrollMasterpassOptional — Enrol the new card in Masterpass.
Optional — Permissions to carry onto the new card.
replaceCard › Responses
Success
newCardGeneratedNew Card Generated
productChangedProduct Changed
shadowCardNumberShadow Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
Warnings - [Optional]
changeAndReplaceCard
Changes the status of a debit card and optionally replaces it with a new card, handling embossing, delivery, and permissions. Returns the updated status and replacement card details.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeAndReplaceCard › Request Body
channelChannel
shadowCardNumberShadow Card Number
Replace Info
cardStatusCodeCard Status Code - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
closeRequestDateClose Request Date - [Optional]
changeAndReplaceCard › Responses
Success
toStatusActiveTo Status Active
Replace Result - [Optional]
isCardFoundIn
Checks whether a specific card exists in the system. Accepts a CardNumber and returns a flag (IsFound) along with the ServiceDomainId indicating where the card was found.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
isCardFoundIn › Responses
Success
isFoundIs Found
serviceDomainIdService Domain Id - [Optional]
addDebitCardLog
Adds a log entry for a debit card including details like old and new values, card reference, masked number, and validity flag.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
addDebitCardLog › 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.
logCodeLog Code - [Optional]
cardLogDetailCard Log Detail - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
customerNumberCustomer Number - [Optional]
validFlagValid Flag - [Optional]
oldValueOld Value - [Optional]
newValueNew Value - [Optional]
addDebitCardLog › Responses
Success
recordIdRecord Id