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
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.
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.
checkCreditCardForDebtPayment › Responses
Success
isRipperIs Ripper
resultResult - [Optional]
errorCodeError Code - [Optional]
errorMessageError Message - [Optional]
errorServiceError Service - [Optional]
processorBinProcessor Bin - [Optional]
bankCodeBank Code - [Optional]
bankNameBank Name - [Optional]
isSuplemantaryIs Suplemantary - [Optional]
Card Info - [Optional]
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
amountDebt payment amount posted to the card.
clientReferenceNumberCaller business key for the payment; needed to cancel later.
shadowCardNumberPlatform card reference. Required unless clearCardNumber is supplied; when only the PAN is sent, the service resolves the shadow number.
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.
currencyCodeISO currency of the payment amount.
accountNumberAccepted on the request but not forwarded into the payment entity.
clearCardNumberClear PAN alternative to shadowCardNumber. Used only to resolve the shadow card when shadowCardNumber is empty.
descriptionFree-text description on the payment.
resourceCodeWhen 0–3, selects the channel payment matrix row; otherwise the default debt-payment matrix id is used.
earlyReleaseLogFlagMarks the payment as linked to an early-release flow when set.
doCreditCardDebtPayment › Responses
Success
trnIdTrn Id
utidUtid - [Optional]
rrnRrn - [Optional]
authorizationNumberAuthorization Number - [Optional]
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
trnIdTransaction id of the debt payment being reversed.
amountAmount of the original payment.
currencyCodeCurrency of the original payment.
clientReferenceNumberSame client reference used on doCreditCardDebtPayment.
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.
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.
cancelCreditCardDebtPayment › Responses
Success
trnIdTrn Id
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
List Of Payment - [Optional]
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.
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
List Of Records - [Optional]