Debt payment
Take a payment against card debt, check a card is eligible to be paid down, and cancel a payment that should not have run.
checkCreditCardForDebtPayment
Checks whether a credit card is eligible for debt payment. Validates PAN, card type, domestic BIN, and supplementary status. Returns masked card info, processor BIN, bank code, bank name, and flags indicating if the card is supplementary or Ripper.
Part of:
- Journey 02 · Managing a card product — step 2, Take a payment
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
checkCreditCardForDebtPayment › Request Body
channelCodeThree-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.
panClear PAN used to resolve BIN and card type. Missing or ineligible PANs return soft errors in the 200 body (99000–99002), not HTTP 400.
A card number is not stored by these services; the platform keeps a shadow card number instead.
checkCreditCardForDebtPayment › Responses
Success
isRipperresultThe outcome, as the downstream system words it.
errorCodeThe platform's own code for the error, and what to match on.
errorMessageerrorServiceprocessorBinbankCodebankNameisSuplemantaryThe card the operation is answering about.
doCreditCardDebtPayment
Performs a credit card debt payment. Determines transaction code based on channel and resource code. Returns UTID, transaction ID, authorization number, and RRN.
Part of:
- Journey 02 · Managing a card product — step 2, Take a payment
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
doCreditCardDebtPayment › 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.
amountDebt payment amount posted to the card.
clientReferenceNumberOptional — The caller's own reference for the payment, forwarded to transaction management.
shadowCardNumberOne-of — The card being paid. Send this or clearCardNumber: when this is empty the PAN is resolved to a shadow card number through the customer service first. The schema marks this field non-nullable, which is a C# value-type artefact rather than a rule — the code path for an empty one is live.
currencyCodeISO currency of the payment amount.
accountNumberAccepted on the request but not forwarded into the payment entity.
clearCardNumberOne-of — The card's PAN, used only when shadowCardNumber is empty. It is resolved to a shadow card number and the payment is written against that.
A card number is not stored by these services; the platform keeps a shadow card number instead.
descriptionFree-text description on the payment.
resourceCodeWhich row of the channel's payment matrix the transaction code comes from. An unrecognised value does not fail — it falls through. Only 0, 1, 2 and 3 select a row by code; anything else, including an absent value, selects the row whose own resource code is empty, then the channel's first row, then a built-in default. Four steps, no refusal at any of them.
earlyReleaseLogFlagForwarded to transaction management, which decides what it means. Nothing in this API reads it.
doCreditCardDebtPayment › Responses
Paid. The response is the transaction's identifiers — utid, trnId, the authorisation number and the retrieval reference number.
The channel decides two things here that the field cannot say. It is left-padded with zeros to three characters before anything is matched against it, so 1 is looked up as 001; and it selects the channel payment matrix row the transaction code is taken from, together with resourceCode. Send the code as the catalogue spells it and the padding never arises.
The payment notification is narrower than it looks. An SMS is sent only when the channel is the batch channel; on every other channel the notification call is not made at all, and that is a condition in the code rather than a missing configuration. Even there it is wrapped: a failed send is logged as a warning and the payment stands. A missing SMS never means a missing payment.
The payment and transaction dates are this service's clock, so a payment cannot be backdated. This operation raises no business code of its own; a refusal comes from transaction management, in its vocabulary.
trnIdThe platform's identifier for the transaction row.
utidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
rrnThe retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.
authorizationNumberThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
cancelCreditCardDebtPayment
Cancels a credit card debt payment by calling the transaction management service with transaction ID, amount, currency, card reference, and related identifiers. Also includes methods to retrieve cancelable credit card payments for a shadow card and cancel early release of installment payments.
Part of:
- Journey 02 · Managing a card product — step 2, Take a payment
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelCreditCardDebtPayment › 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.
trnIdTransaction id of the debt payment being reversed.
amountAmount of the original payment.
currencyCodeCurrency of the original payment.
clientReferenceNumberSame client reference used on doCreditCardDebtPayment.
cardRefNumberCard reference when cancelling by card rather than shadow alone.
mainCustomerNumberMain customer number when required by the cancel criteria.
trnDateOriginal transaction date when the cancel needs date scoping.
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.
cancelCreditCardDebtPayment › Responses
Success
trnIdThe platform's identifier for the transaction row.
getCancelableCreditCardDebtPaymentList
Retrieves a list of cancellable credit card debt payments for a given shadow card number, including transaction details and related card/customer information.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCancelableCreditCardDebtPaymentList › Request Body
shadowCardNumberCard whose cancelable debt payments are listed. Empty throws 60002.
getCancelableCreditCardDebtPaymentList › Responses
Success
saveCreditCardAutoPaymentOrder
Saves the credit card auto-payment order with specified payment type, account number, and account owner name.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
saveCreditCardAutoPaymentOrder › Request Body
accountNumberFunding account number. Lifecycle rejects an empty or zero account.
shadowCardNumberCard whose auto-payment order is created or updated.
paymentTypeT (all / statement), A (minimum), or N (none). Blank defaults to T; any other value throws 60004.
accountOwnerNameDisplay name of the funding account owner.
Belongs to the core banking account rather than to a column here.
saveCreditCardAutoPaymentOrder › Responses
getCreditCardAutoPaymentOrder
Retrieves the auto-payment order details for a credit card. The method accepts MainCustomerNumber, MainCardRefNumber, or ShadowCardNumber. Returns a list of auto-payment orders including payment account, owner name, payment type, and associated card information.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCreditCardAutoPaymentOrder › Request Body
mainCustomerNumberLists auto-payment orders for every card under the customer.
mainCardRefNumberAlternative card key when the shadow number is not held.
shadowCardNumberOne of shadowCardNumber, mainCardRefNumber or mainCustomerNumber is required. All three empty throws 60002.
getCreditCardAutoPaymentOrder › Responses
Success