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 › Request Body
panThe card's PAN, in the clear.
A card number is not stored by these services; the platform keeps a shadow card number instead.
getBasicCardInformationByPan › Responses
Success.
Eight fields off the same read getCardByCardNumber does — bin, PAN sequence, card type, masked and encrypted number, hash, shadow number and customer number. Nothing here is unavailable from that operation; this one is the short form. It does not guard against the service answering nothing.
customerNumberThe customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.
binThe bank identification number — the leading digits of the card number that name the issuer and the product range.
psncardTypeValues:
C— creditD— debitP— prepaid
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
shadowCardNumberThe platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.
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
shadowCardNumberShadow card number to filter the log on. Unlike the credit equivalent, it is always required here; customerNumber does not stand in for it.
startDateCanNotBeNullOrLessThanSqlMinValue — Start of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.
endDateCanNotBeNullOrLessThanSqlMinValue — End of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.
logCodeCard log code to filter on. An absent or empty value switches the filter off and returns every log code.
customerNumberFurther narrows the log to one customer. It is not checked; zero switches this filter off.
getDebitCardLogDataListByShadowCardNumber › Responses
Success.
Rows are read live from the debit card log. The query inner-joins the card log definition table to resolve logCodeDescription, so a log row whose code has no definition row is dropped from the answer altogether; the channel description is joined outer, so an unknown channel leaves insertChannelDescription empty. A card with no log rows inside the window returns an empty cardLogDataList rather than an error. The result is not ordered and carries no cap.
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
startDateCanNotBeNullOrLessThanSqlMinValue — Start of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.
endDateCanNotBeNullOrLessThanSqlMinValue — End of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.
shadowCardNumberOne-of · NotNullOrWhiteSpace — Shadow card number to filter the log on. Either this or customerNumber must be supplied; when both are absent the failure is reported against both fields. An absent or empty value switches this filter off.
logCodeCard log code to filter on. An absent or empty value switches the filter off and returns every log code.
customerNumberOne-of · NotNull — Customer number to filter the log on. Either this or shadowCardNumber must be supplied. Zero counts as absent, both for the check and for the query, where it switches this filter off.
getCreditCardLogDataListByShadowCardNumber › Responses
Success.
Rows are read live from the credit card log. The query inner-joins the card log definition table to resolve logCodeDescription, so a log row whose code has no definition row is dropped from the answer altogether; the channel description is joined outer, so an unknown channel leaves insertChannelDescription empty. A card or customer with no log rows inside the window returns an empty cardLogDataList rather than an error. The result is not ordered and carries no cap.
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
cardNumberThe card's PAN, in the clear.
panSequenceNumberThe PAN sequence number, where one card number carries more than one card.
Passed to the service that resolves the card; no column behind this API holds it.
getCardByCardNumber › Responses
Success.
The same read as getCardByShadowCardNumber, keyed by PAN instead — but without its null guard. This operation reads the customer number off the service's answer without checking there is one, so what a caller sees for a card that does not exist is whatever the service does about it, not a clean empty body. It also takes no channel, unlike its shadow-number twin.
customerNumberThe customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.
expiryDateA date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
binThe bank identification number — the leading digits of the card number that name the issuer and the product range.
shadowCardNumberThe platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.
cardSeqNumberWhich chip on the card was used, where a customer holds more than one card on the same number.
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusReasonCodeWhy the status is what it is.
cardNumbercardTypeValues:
C— creditD— debitP— prepaid
productNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
maskedPanAlternativeA second masked form of the card number, masked differently for a channel that needs other digits.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
ownerSearchNameThe cardholder's name normalised for searching — accents and case removed. It is not the name on the card.
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 code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
panThe card's PAN, in the clear.
A card number is not stored by these services; the platform keeps a shadow card number instead.
getSecureCardByPan › Responses
Success.
Six fields and none of them is the card number: the encrypted block, the hash, the first six, the first eight, the last four and the record id. This is the operation to use when a caller needs to recognise a card later without holding its number.
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
firstEightfirstSixlastFourrecordIdThe identifier of the row the operation created or acted on, returned so a later call can name it.
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 code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
shadowCardNumberThe card to read.
getCardByShadowCardNumber › Responses
Success.
The body is empty when the card is not found: this operation checks the service's answer for null and returns nothing rather than a card. It is the only one of the nine lookups that guards the miss explicitly — see getCardByCardNumber for the same read keyed the other way, which does not.
customerNumberThe customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.
expiryDateA date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
binThe bank identification number — the leading digits of the card number that name the issuer and the product range.
shadowCardNumberThe platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.
cardSeqNumberWhich chip on the card was used, where a customer holds more than one card on the same number.
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusReasonCodeWhy the status is what it is.
cardNumbercardTypeValues:
C— creditD— debitP— prepaid
productNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
maskedPanAlternativeA second masked form of the card number, masked differently for a channel that needs other digits.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
ownerSearchNameThe cardholder's name normalised for searching — accents and case removed. It is not the name on the card.
maskedPanSmart