Card lifecycle
Move a card through its states after issuance — status changes, replacement, renewal, blocking and closure.
getBasicCardInformationByPan
Retrieves basic card information for a given PAN (Primary Account Number). Accepts GetBasicCardInformationByPanRequest containing Pan. Returns GetBasicCardInformationByPanResponse with Bin, Psn (card sequence number), CardType, MaskedCardNumber, EncryptedCardNumber, HashCardNumber, ShadowCardNumber, and CustomerNumber.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getBasicCardInformationByPan › Responses
Success
customerNumberCustomer Number
binBin - [Optional]
psnPsn - [Optional]
cardTypeCard Type - [Optional]
encryptedCardNumberEncrypted Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
hashCardNumberHash Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
getDebitCardInfo
Retrieves detailed debit card information for a given ShadowCardNumber. Accepts GetDebitCardInfoRequest with ShadowCardNumber. Calls _intRepository.GetSearchByCustomernumberCardnumber() and _debitManagementServiceProxy.ListCardAccountByShadowCardNumber() to retrieve card details. Returns GetDebitCardInfoResponse containing DebitCardModel with properties such as Barcode, BranchCode, CardStatusCode, MaskedCardNumber, CustomerNumber, VirtualFlag, SupplementaryCardFlag, and a list of CardAccountInfo including AccountNumber, AccountType, AccountBranchId, AccountOrderFlag, and FecCode.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getDebitCardInfo › Responses
Success
Card Info - [Optional]
changeDebitCardStatus
Changes the status of a debit card. Sends ShadowCardNumber, StatusCode, StatusReasonCode, Channel, and optional CloseRequestDate to _debitManagementServiceProxy.ChangeCardStatus. Returns an empty ChangeDebitCardStatusResponse.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeDebitCardStatus › Request Body
shadowCardNumberShadow Card Number - [Optional]
statusCodeStatus Code - [Optional]
statusReasonCodeStatus Reason Code - [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.
closeRequestDateClose Request Date - [Optional]
changeDebitCardStatus › Responses
Success
toStatusActiveTo Status Active
changeDebitCardBranch
Changes the branch of a debit card. Sends ShadowCardNumber, TargetBranchCode, and Channel to _debitManagementServiceProxy.ChangeCardBranch. Returns IsSuccess, OldBranch, and NewBranch.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeDebitCardBranch › Request Body
targetBranchCodeTarget Branch Code
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.
changeDebitCardBranch › Responses
Success
isSuccessIs Success
oldBranchOld Branch
newBranchNew Branch
attachDebitCardAccount
Attaches a debit card to a bank account using account details including branch, type, suffix, number, shadow card number, alias, and IBAN. Converts request and response between internal and service contracts.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
attachDebitCardAccount › Request Body
fecCodeFec Code
accountBranchIdAccount Branch Id
accountSuffixAccount Suffix
accountNumberAccount Number
accountOrderFlagAccount Order Flag
accountTypeAccount Type - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountAliasAccount Alias - [Optional]
ibanIban - [Optional]
attachDebitCardAccount › Responses
Success
recordIdRecord Id
getDebitCardLogDataListByShadowCardNumber
Retrieves debit card log data for a given ShadowCardNumber. Accepts GetDebitCardLogDataListByShadowCardNumberRequest with ShadowCardNumber, CustomerNumber, LogCode, StartDate, and EndDate. Calls _debitManagementServiceProxy.GetCardLogDataListByShadowCardNumber() and maps results to CardLogData. Returns GetDebitCardLogDataListByShadowCardNumberResponse containing a list of CardLogData with properties such as CardRefNumber, ShadowCardNumber, MaskedCardNumber, CustomerNumber, LogCode, LogCodeDescription, OldValue, NewValue, CardLogDetail, InsertChannelId, InsertChannelDescription, InsertUserId, and InsertDate.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getDebitCardLogDataListByShadowCardNumber › Request Body
customerNumberCustomer Number
startDateStart Date
endDateEnd Date
shadowCardNumberShadow Card Number - [Optional]
logCodeLog Code - [Optional]
getDebitCardLogDataListByShadowCardNumber › Responses
Success
Card Log Data List - [Optional]
getCreditCardLogDataListByShadowCardNumber
Retrieves credit card log data for a given shadow card number. Accepts GetCreditCardLogDataListByShadowCardNumberRequest with parameters ShadowCardNumber, CustomerNumber, LogCode, StartDate, and EndDate. Returns GetCreditCardLogDataListByShadowCardNumberResponse containing a list of CreditCardLogData items, each with CardRefNumber, ShadowCardNumber, MaskedCardNumber, CustomerNumber, OldValue, NewValue, CardLogDetail, InsertChannelId, InsertChannelDescription, LogCode, LogCodeDescription, InsertDate, and InsertUserId. Internally calls _crdIssuingServiceProxy.GetCardLogDataListByShadowCardNumber(). Validates StartDate, EndDate, and ShadowCardNumber before processing.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCreditCardLogDataListByShadowCardNumber › Request Body
customerNumberCustomer Number
startDateStart Date
endDateEnd Date
shadowCardNumberShadow Card Number - [Optional]
logCodeLog Code - [Optional]
getCreditCardLogDataListByShadowCardNumber › Responses
Success
Card Log Data List - [Optional]
getCardByCardNumber
Retrieves detailed card information for a given card number (PAN) and optional PAN sequence number. Accepts GetCardByCardNumberRequest containing CardNumber and PanSequenceNumber. Returns GetCardByCardNumberResponse with Bin, CardNumber, CardRefNumber, CardSeqNumber, CardType, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ProductNumber, StatusCode, and StatusReasonCode.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardByCardNumber › Request Body
cardNumberCard Number - [Optional]
panSequenceNumberPan Sequence Number - [Optional]
getCardByCardNumber › Responses
Success
customerNumberCustomer Number
expiryDateExpiry Date
mainCustomerNumberMain Customer Number
hashCardNumberHash Card Number - [Optional]
encryptedCardNumberEncrypted Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
binBin - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardSeqNumberCard Seq Number - [Optional]
statusCodeStatus Code - [Optional]
statusReasonCodeStatus Reason Code - [Optional]
cardNumberCard Number - [Optional]
cardTypeCard Type - [Optional]
productNumberProduct Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedPanAlternativeMasked Pan Alternative - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
ownerSearchNameOwner Search Name - [Optional]
getSecureCardByPan
Retrieves secure card information using the PAN. The response includes encrypted card number, hashed card number, first six digits, first eight digits, last four digits, and a record ID.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getSecureCardByPan › 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.
panPan - [Optional]
getSecureCardByPan › Responses
Success
encryptedCardNumberEncrypted Card Number - [Optional]
hashCardNumberHash Card Number - [Optional]
firstEightFirst Eight - [Optional]
firstSixFirst Six - [Optional]
lastFourLast Four - [Optional]
recordIdRecord Id - [Optional]
getCardByShadowCardNumber
Service that lists card information based on the Shadow Card Number.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardByShadowCardNumber › 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]
getCardByShadowCardNumber › Responses
Success
customerNumberCustomer Number
expiryDateExpiry Date
mainCustomerNumberMain Customer Number
hashCardNumberHash Card Number - [Optional]
encryptedCardNumberEncrypted Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
binBin - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardSeqNumberCard Seq Number - [Optional]
statusCodeStatus Code - [Optional]
statusReasonCodeStatus Reason Code - [Optional]
cardNumberCard Number - [Optional]
cardTypeCard Type - [Optional]
productNumberProduct Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedPanAlternativeMasked Pan Alternative - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
ownerSearchNameOwner Search Name - [Optional]
maskedPanSmartMasked Pan Smart - [Optional]