Card lifecycle
Move a card through its states after issuance — status changes, replacement, renewal, blocking and closure.
getCardList
Retrieves a list of credit cards based on various filters (card number, customer number, main customer number, barcode, account number, branch code, identification, courier status, etc.). Aggregates card product, branch, limit, debt, account info, annual fee, sensitive data (PAN/CVV2), and currency conversion details. Uses parallel async calls for efficiency and maps results to CreditCardModel objects.
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 (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
cardStatusCodeCard Status Code - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
branchCodeBranch Code - [Optional]
customerNameSurnameCustomer Name Surname - [Optional]
identificationNumberIdentification Number - [Optional]
courierStatusCourier Status - [Optional]
corpCardFlagCorp Card Flag - [Optional]
onlyLastCardFlagOnly Last Card Flag - [Optional]
virtualCardFlagVirtual Card Flag - [Optional]
getCardList › Responses
Success
List Of Card - [Optional]
replaceCard
Replaces a card by generating a new one with specified parameters such as emboss reason, delivery details, and card permissions. Returns the generated card details like masked card number, expiry date, and warnings.
Part of:
- Journey 02 · Managing a card product — step 2, Replace and renew
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; Post constrains deliveryAddressType.
deliveryAddressTypeConditional — The address the card is posted to. When deliveryType is Post and this is sent, it may not be None.
deliveryBranchCodeConditional — The branch the card is delivered to. Mandatory when deliveryType is Branch.
productNumberOptional — Reissue onto a different product. If sent it must be a product the platform defines; the product change scenario must exist too.
instantIssuingFlagOptional · Default false — Issue the card at a branch on the spot. True makes embossBranchCode mandatory.
embossBranchCodeConditional — The branch that prints the card. Mandatory when instantIssuingFlag is true.
Optional — Permissions to carry onto the new card.
cardSendAddressIdOptional — The stored address the card is sent to.
enrollMasterpassOptional — Enrol the new card in Masterpass.
replaceCard › Responses
Success
newCardGeneratedNew Card Generated
productChangedProduct Changed
expiryDateExpiry Date
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
Warnings - [Optional]
getCardMemo
Retrieves a list of card memo entries for a given credit card, filtered by shadow card number, log code, customer number, and date range. Maps results from Lifecycle service to GetCardMemo objects including card reference, masked number, log details, old/new values, insert channel, user, and date.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardMemo › Request Body
shadowCardNumberShadow Card Number - [Optional]
logCodeLog Code - [Optional]
customerNumberCustomer Number - [Optional]
startDateStart Date - [Optional]
endDateEnd Date - [Optional]
getCardMemo › Responses
Success
Get Card Memo List - [Optional]
changeCardStatus
Changes the status of a credit card. Calls the Lifecycle service to update the card status and reason code, optionally reissues the card, and can apply changes only to the specified shadow card. Returns information about the new status, affected shadow cards, card references for limit reset, customer limit reset flag, and a new shadow card number if applicable.
Part of:
-
Journey 01 · Launching a new card product — step 5, Activate and set the PIN
-
Journey 01 · Launching a new card product — step 4, Activate, PIN, transact
-
Journey 02 · Managing a card product — step 1, Status changes
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.
cardStatusCodeRequired · Enum · NotNullOrWhiteSpace · EqualValue — The status to move to. Must be a status the platform defines.
cardStatusReasonCodeRequired · Dependent · NotNullOrWhiteSpace · EqualValue — The reason for the new status. Must be a reason defined for cardStatusCode.
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
transactionIdOptional — The caller's own id. Echoed back in the error body.
reissueCardOptional · Default false — Reissue the card with the status change.
closeRequestDateOptional · Nullable · Format date-time — The date the closure was requested.
changeMeOnlyOptional · Default false — Change only this card, not the cards that would follow it.
changeCardStatus › Responses
Success
toStatusActiveTo Status Active
resetCustomerLimitReset Customer Limit
listOfShadowCardNumberForClosedCardList Of Shadow Card Number For Closed Card - [Optional]
listOfCardRefNumberForResetLimitList Of Card Ref Number For Reset Limit - [Optional]
newShadowCardNumberNew Shadow Card Number - [Optional]
changeCustomerCreditCardStatus
Changes the credit card status for a given customer. Validates input parameters, calls the lifecycle service to update card statuses, and returns a list of shadow card numbers for cards that were closed. Supports optional activation of cards and ensures proper rollback and logging on failure.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCustomerCreditCardStatus › Request Body
channelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
customerNumberCustomer Number
cardStatusCodeCard Status Code - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
activateCardActivate Card - [Optional]
changeCustomerCreditCardStatus › Responses
Success
listOfShadowCardNumberForClosedCardList Of Shadow Card Number For Closed Card - [Optional]
changeAndReplaceCard
Changes the status of a credit card and replaces it with a new card if requested. Validates input, executes ChangeCardStatus via lifecycle service, then ReplaceCard via credit issuing service. Returns details about status change and replaced card.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeAndReplaceCard › Request Body
channelThree-digit channel code (for example "002", not "Internet"). 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
Replace Info
cardStatusCodeCard Status Code - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
closeRequestDateClose Request Date - [Optional]
changeAndReplaceCard › Responses
Success
toStatusActiveTo Status Active
resetCustomerLimitReset Customer Limit
listOfShadowCardNumberForClosedCardList Of Shadow Card Number For Closed Card - [Optional]
listOfCardRefNumberForResetLimitList Of Card Ref Number For Reset Limit - [Optional]
Replace Result - [Optional]
getRenewCountByShadowCardNumber
Get Renew Count By Shadow Card Number
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getRenewCountByShadowCardNumber › Request Body
channelThree-digit channel code (for example "002", not "Internet"). 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
embossReasonSubCodeEmboss Reason Sub Code
getRenewCountByShadowCardNumber › Responses
Success
shadowCardNumberShadow Card Number
cardRefNumberCard Ref Number
mainCardRefNumberMain Card Ref Number
isSupplementaryIs Supplementary
List Of Renew Count
getCreditCardInfo
Retrieves detailed credit card information using ShadowCardNumber or CardNumber. Validates input parameters, resolves ShadowCardNumber when CardNumber is provided, and fetches card details including virtual and corporate cards. Returns card information along with card-level and customer-level reward details such as available rewards, reward types, and descriptions.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCreditCardInfo › Request Body
channelOptional · Default 102 — Three-digit channel code, used when the card's sensitive data and accounts are read. Left out, it is taken as 102 — Individual Mobile.
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.
getCreditCardInfo › Responses
Success
Card Info - [Optional]
Card Reward Details - [Optional]
Customer Reward Details - [Optional]
getCustomerCreditCardListByTenantId
Retrieves a list of credit cards for a customer filtered by TenantId and optionally by ProductNumbers. Validates the request, checks card status, filters closed or renewed cards, calculates total debt, fetches statement remaining debt, card limits, and other card attributes. Returns detailed credit card information including masked card numbers, limits, delinquency, due dates, digital card flags, and pending replace applications.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCustomerCreditCardListByTenantId › Request Body
customerNumberCustomer Number
tenantIdTenant Id
channelCodeThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
productNumbersProduct Numbers - [Optional]
getCustomerCreditCardListByTenantId › Responses
Success
Customer Credit Card List - [Optional]
getCustomerCreditShadowCardsByTenantId
Retrieves a list of a customer's credit shadow cards filtered by TenantId. It validates the request, retrieves all shadow cards for the customer from the repository, and returns them with details such as card type, masked number, product info, and status codes/descriptions.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCustomerCreditShadowCardsByTenantId › Request Body
customerNumberCustomer Number
tenantIdTenant Id
channelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
getCustomerCreditShadowCardsByTenantId › Responses
Success
Customer Credit Shadow Card List - [Optional]
getCustomerCreditCardListByTenantIdProductNumber
Retrieves a customer's credit card list filtered by TenantId and optionally by ProductNumber. It validates the request, filters out closed or invalid cards based on status, debt, and digital/physical card rules, and enriches each card with statement remaining debt and available limit information retrieved from the limit service proxy.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCustomerCreditCardListByTenantIdProductNumber › Request Body
customerNumberCustomer Number
tenantIdTenant Id
channelCodeThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
productNumbersProduct Numbers - [Optional]
getCustomerCreditCardListByTenantIdProductNumber › Responses
Success
Customer Credit Card List - [Optional]
getCardListNew
Retrieves a list of credit cards based on various filters (card number, customer number, main customer number, barcode, account number, branch code, identification, courier status, etc.). Aggregates card product, branch, limit, debt, account info, annual fee, sensitive data (PAN/CVV2), and currency conversion details. Uses parallel async calls for efficiency and maps results to CreditCardModel objects.
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 (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
cardStatusCodeCard Status Code - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
isCorporateAllCardListIs Corporate All Card List - [Optional]
tenantIdTenant Id - [Optional]
getCardListNew › Responses
Success
List Of Card - [Optional]