Instalments
Split a purchase or a cash advance across a repayment schedule, then track, settle early or cancel the plan.
getEarlyCloseCandidateList
Service that lists installment transactions eligible for early closure for the given customer and card.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getEarlyCloseCandidateList › Request Body
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.
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.
getEarlyCloseCandidateList › Responses
Success
doEarlyClose
Performs early closure of a credit card installment. Returns the early release log record ID and the shadow card number.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
doEarlyClose › Request Body
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.
utidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
feeAmountThe fee charged on the transaction.
earlyReleaseTypeWhich kind of early settlement is being asked for.
doEarlyClose › Responses
Success
erLogRecordIdshadowCardNumberThe 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.
getInstallmentCountsByUtid
Retrieves the installment counts and limits for a credit card transaction identified by UTID. Returns minimum and maximum installment counts, deferring month limits, MCC-based limits, profile-based limits, and transaction details (amount, date, description). Adjusts MaxInstallmentCount and MaxDeferringMonthCount if the transaction occurs in an emergency city.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getInstallmentCountsByUtid › Request Body
UtidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
getInstallmentCountsByUtid › Responses
Success
AmountThe amount.
DateA 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.
MinInstallmentCountMaxInstallmentCountMinDeferringMonthCountMaxDeferringMonthCountInstallmentCountLimitInstallmentCountMccGroupLimitInstallmentCountMccLimitInstallmentProfileDeferringLimitInstallmentProfileInstallmentLimitMccDefinitionInstallmentLimitDescriptiongetCashInstallmentParameter
Retrieves cash installment parameters for a given shadow card and transaction amount. Returns a list of installment options including minimum and maximum installment counts, transaction amount limits, profit rates, and fees. Requires a valid ShadowCardNumber.
Part of:
-
Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)
-
Journey 03 · Enabling additional capabilities — step 2, Same services, debit card
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCashInstallmentParameter › Request Body
channelIdThree-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 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.
accountNumberThe account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.
An account at the bank's core banking system rather than a column here, so its format is the core's: no table behind these APIs holds an account number as text, and most of this platform's own requests type it as a number. The platform stores iban and accountAlias instead, and publishes a width for both.
transactionAmountThe amount of the transaction.
getCashInstallmentParameter › Responses
Success
simulateCashInstallmentForAll
Simulates cash installments for all possible installment counts, providing a detailed breakdown of the total amount, installment amounts, profit, fees, and the remaining balance for each installment count.
Part of:
-
Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)
-
Journey 03 · Enabling additional capabilities — step 2, Same services, debit card
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
simulateCashInstallmentForAll › Request Body
channelIdThree-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 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.
accountNumberThe account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.
An account at the bank's core banking system rather than a column here, so its format is the core's: no table behind these APIs holds an account number as text, and most of this platform's own requests type it as a number. The platform stores iban and accountAlias instead, and publishes a width for both.
transactionAmountThe amount of the transaction.
simulateCashInstallmentForAll › Responses
Success
simulateCashInstallment
Simulates the cash installment process for a given card, calculating the installment amounts, profit, and other associated fees based on the requested installment count and transaction amount.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
simulateCashInstallment › Request Body
channelIdThree-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 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.
accountNumberThe account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.
An account at the bank's core banking system rather than a column here, so its format is the core's: no table behind these APIs holds an account number as text, and most of this platform's own requests type it as a number. The platform stores iban and accountAlias instead, and publishes a width for both.
transactionAmountThe amount of the transaction.
installmentCountHow many instalments to split the amount across. The available counts for a card and amount come from the simulation operations.
simulateCashInstallment › Responses
Success
doCashInstallment
Processes a cash installment payment (early release). Returns transaction ID, authorization number, UTID, and RRN.
Part of:
-
Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)
-
Journey 03 · Enabling additional capabilities — step 2, Same services, debit card
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
doCashInstallment › Request Body
channelIdThree-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 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.
accountNumberThe account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.
An account at the bank's core banking system rather than a column here, so its format is the core's: no table behind these APIs holds an account number as text, and most of this platform's own requests type it as a number. The platform stores iban and accountAlias instead, and publishes a width for both.
referenceNumberThe caller's own reference for the transaction, carried into the institution transaction record. It is truncated to 50 characters rather than refused.
transactionAmountThe amount of the transaction.
installmentCountHow many instalments to split the amount across. The available counts for a card and amount come from the simulation operations.
doCashInstallment › Responses
Success
isSuccessWhether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.
feeAmountThe fee charged on the transaction.
uTIDThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
authCodeThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
responseCodeThe downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.
responseReasonCodeWhy the downstream system answered as it did, where it narrows the response code.
reasonDescriptionThe downstream system's own wording for the refusal, passed through.
rrnThe retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.
reverseCashInstallment
Reverses a cash installment transaction using the provided amount, shadow card number, UTID, and reference number.
Part of:
- Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
reverseCashInstallment › Request Body
amountThe amount.
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.
uTIDThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
referenceNumberThe caller's own reference for the transaction, carried into the institution transaction record. It is truncated to 50 characters rather than refused.
reverseCashInstallment › Responses
Success
isSuccessWhether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.
uTIDThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
authCodeThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
responseReasonCodeWhy the downstream system answered as it did, where it narrows the response code.
getCancelableCashInstallmentList
Retrieves a list of cancellable cash installments for a given shadow card number, including transaction details and card master information.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCancelableCashInstallmentList › Request Body
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.
getCancelableCashInstallmentList › Responses
Success
getEarlyReleaseCashInstallments
Retrieves cash installment transactions available for early release for a given ShadowCardNumber. Returns a list of transactions with details including total installment amount, installment count, fees, profit, taxes (Bsmv, Kkdf, interest), remaining installment capital, and a breakdown of each installment in DetailList with dates, amounts, and flags.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getEarlyReleaseCashInstallments › Request Body
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.
getEarlyReleaseCashInstallments › Responses
Success
getEarlyReleaseCashInstallment
Service that returns early-closed installment cash advance details.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getEarlyReleaseCashInstallment › Request Body
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.
utidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
getEarlyReleaseCashInstallment › Responses
Success
transactionDateA 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.
transactionAmountThe amount of the transaction.
installmentCountHow many instalments to split the amount across. The available counts for a card and amount come from the simulation operations.
totalFeeAmountinstallmentProfitRatetotalInstallmentAmountWhat the instalments come to together.
remainingInstallmentCountHow many instalments are still to run.
remainingInstallmentCapitalAmountearlyReleaseTotalAmountearlyReleaseInterestAmountearlyReleaseTotalTaxAmountearlyReleaseBsmvAmountearlyReleaseKkdfAmountshadowCardNumberThe 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.
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.
utidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
doCashInstallmentEarlyReleasePayment
Processes an early release cash installment payment. Returns UTID, transaction ID, authorization number, and RRN.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
doCashInstallmentEarlyReleasePayment › 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.
amountEarly-release settlement amount.
clientReferenceNumberCaller business key for the payment.
shadowCardNumberCard the early-release payment is posted against.
currencyCodeISO currency of the payment.
cashInstallmentUtidUTID of the cash-installment plan being settled early.
The installment's own transaction identifier, carried through to the services that hold it.
accountNumberAccepted on the request; not mapped into the payment entity.
doCashInstallmentEarlyReleasePayment › Responses
Success
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.
cancelCashInstallEarlyReleasePayment
Cancels an early release cash installment payment for a credit card. Calls the transaction management service to reverse the payment using transaction ID, amount, currency, card reference, and other identifiers. Returns the transaction ID of the cancellation.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelCashInstallEarlyReleasePayment › 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 early-release payment being reversed.
amountAmount of the original early-release payment.
currencyCodeCurrency of the original payment.
clientReferenceNumberSame client reference used on the payment call.
cashInstallmentUtidUTID of the cash-installment plan the payment belonged to.
The installment's own transaction identifier, carried through to the services that hold it.
cardRefNumberCard reference when needed to locate the original payment.
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.
cancelCashInstallEarlyReleasePayment › Responses
Success
trnIdThe platform's identifier for the transaction row.
getAllWaitingInstallments
Retrieves all waiting (pending) credit card installments for a given shadow card number. Returns both summary and detailed installment information grouped by statement date.
Part of:
- Journey 03 · Enabling additional capabilities — step 3, Track waiting installments
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getAllWaitingInstallments › Request Body
shadowCardNumberRequired in practice — The card to read. It is resolved to a card record before anything is read, and three separate failures of that resolution all answer with the same code — see the 400 table. It is not declared required because an absent value is refused as a business failure rather than as a missing field. The card's status is not checked, so a closed card still answers.
getAllWaitingInstallments › Responses
Instalments that have not reached a statement, grouped by the statement date they are waiting for. Each group carries a total and its own rows.
The total and the rows are two separate reads, joined here by statement date. A row whose date matches no total is dropped rather than returned in a group of its own, so the rows you get are the ones that line up with a summary.
The outcome, as the downstream system words it.
getWaitingInstallmentDetail
Retrieves the waiting (upcoming) installment details for a credit card. The service first validates the card using the shadow card number, then fetches the list of waiting installments, including transaction details, amounts, dates, MCC info, product info, reward info, and installment attributes. Supports both current and new repository methods for fetching waiting installment details. The response is mapped to CreditCardNextPeriodInstallmentModel, and transactions can also be mapped to CreditCardDetailTransactionItem for client consumption.
Part of:
- Journey 03 · Enabling additional capabilities — step 3, Track waiting installments
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getWaitingInstallmentDetail › Request Body
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.
getWaitingInstallmentDetail › Responses
Success
totalAmountThe amount of every entry in the list added together.
currencyCodeThe currency of the amount, as its three-letter code.
getWaitingInstallmentSummary
Retrieves a summary of waiting (upcoming) installments for a credit card. The service validates the card using the shadow card number, fetches the installment summary from the repository, and aggregates amounts by statement date, including total installment amount, fees, taxes (KKDF, BSMV), profit, and capital. The result is returned as a list of WaitingInstallmentSummaryInfo within GetWaitingInstallmentSummaryResponse.
Part of:
- Journey 03 · Enabling additional capabilities — step 3, Track waiting installments
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getWaitingInstallmentSummary › Request Body
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.
getWaitingInstallmentSummary › Responses
Success
manuelInstallmentOrder
Places a manual installment order for a credit card transaction. It uses the transaction management service to create an installment order based on the shadow card number, transaction ID (UTID), installment count, and deferring month count. The response includes the InstallmentOrderRecordId for tracking.
Part of:
- Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
manuelInstallmentOrder › Request Body
installmentCountHow many instalments to split the amount across. The available counts for a card and amount come from the simulation operations.
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.
utidRequired in practice — The transaction to split, as in the simulation. The same key orders the plan that was simulated. Not validated here.
deferringMonthCountHow many months the purchase is deferred by.
channelTypeThe channel the order is recorded under. Forwarded to transaction management; nothing here resolves or checks it, and it is a different field from the channel the rest of this API takes.
manuelInstallmentOrder › Responses
Ordered. The response is one record id and nothing else — no schedule, no total. Simulate first if a caller needs those; this operation does not return them again.
An ordered plan is not debt yet. One instalment falls onto each statement, and the ones that have not reached a statement are read separately through getAllWaitingInstallments.
installmentOrderRecordIdmanuelInstallmentOrderSimulate
Simulates a manual installment order for a credit card transaction. Returns projected installment details including installment amount, total payment amount, profit rate, and a breakdown of total PFT (Profit, BSMV, KKDF, and fees). The response includes a list of simulated installment records with installment number, capital amount, installment date, and remaining total amount.
Part of:
- Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
manuelInstallmentOrderSimulate › Request Body
installmentCountRequired in practice — How many instalments to plan for. Echoed back rather than answered — see the 200 description.
shadowCardNumberRequired in practice — The card the transaction belongs to. It narrows the lookup; it does not select what is split. Not validated here.
utidRequired in practice — The transaction being split, and the key to the whole operation. A plan is simulated for one transaction, not for a card: find the transaction first, then simulate against its utid. Not validated here.
deferringMonthCountMonths to defer the first instalment by. Sending one makes the headline total understate the cost; see the 200 description.
manuelInstallmentOrderSimulate › Responses
A plan, and two fields to read carefully.
installmentCountis copied from your request, not taken from the service's answer. If the service settles on a different number this field will not tell you — the length oflistOfInstallmentRecordwill.totalPFTAmountleaves the deferral out. It is the interest, the two legal taxes and the instalment fee added together; the three deferral components are not in it. Ask for adeferringMonthCountand the total you display is short by them.
The schedule itself — one row per instalment, with its date, capital and remaining balance — is the part to trust.
installmentAmountWhat each instalment comes to.
profitRatetotalPaymentAmounttotalPFTAmountinstallmentCountHow many instalments to split the amount across. The available counts for a card and amount come from the simulation operations.
deferringMonthCountHow many months the purchase is deferred by.
getInstallmentCountsByUtidNew
Retrieves the installment counts and limits for a credit card transaction identified by UTID using the new DCIC logic. Returns minimum and maximum installment counts, deferring month limits, MCC-based limits, profile-based limits, and transaction details (amount, date, description). Adjusts MaxInstallmentCount and MaxDeferringMonthCount if the transaction occurs in an emergency city. Unlike the previous version, this method fetches the installment info directly from the DCIC new repository without querying the full customer transaction details.
Part of:
- Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getInstallmentCountsByUtidNew › Request Body
UtidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
getInstallmentCountsByUtidNew › Responses
Success
AmountThe amount.
DateA 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.
MinInstallmentCountMaxInstallmentCountMinDeferringMonthCountMaxDeferringMonthCountInstallmentCountLimitInstallmentCountMccGroupLimitInstallmentCountMccLimitInstallmentProfileDeferringLimitInstallmentProfileInstallmentLimitMccDefinitionInstallmentLimitDescriptioncancelInstallmentEarlyRelease
Cancels an early release of an installment for a given card identified by ShadowCardNumber and UTID. Returns the number of affected rows as EffectedRowCount.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelInstallmentEarlyRelease › Request Body
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.
utidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
cancelInstallmentEarlyRelease › Responses
Success
effectedRowCountgetManuelInstallmentCancelRecordsByCardRefNumber
Retrieves the manual installment cancellation records for a given card reference number or shadow card number. Returns details such as installment count, amount, deferring month, fee and profit amounts, transaction source, merchant, processing flags, and relevant dates. Throws an error if both CardRefNumber and ShadowCardNumber are null. This method helps track manually canceled installments for credit card transactions.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getManuelInstallmentCancelRecordsByCardRefNumber › Request Body
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow 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.
getManuelInstallmentCancelRecordsByCardRefNumber › Responses
Success
getEarlyReleaseAvailableInstallmentsByCriterias
Retrieves available installments for early release based on criteria such as CardRefNumber, MainCardRefNumber, or ShadowCardNumber. Returns detailed installment information including remaining principal, fees, profit, taxes, installment counts, transaction details, merchant information, and totals. Supports subsequent simulation and release of early installments.
Part of:
- Journey 03 · Enabling additional capabilities — step 4, Early settlement
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getEarlyReleaseAvailableInstallmentsByCriterias › Request Body
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
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.
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.
getEarlyReleaseAvailableInstallmentsByCriterias › Responses
Success
simulateInstallmentEarlyRelease
Simulates the early release of an installment, providing details of the remaining balance, canceled fees and profit, early payment amount, and the total installment count.
Part of:
- Journey 03 · Enabling additional capabilities — step 4, Early settlement
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
simulateInstallmentEarlyRelease › Request Body
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.
utidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
simulateInstallmentEarlyRelease › Responses
Success
CanceledFeeAndProfitAmountProfitAmountFeeAmountThe fee charged on the transaction.
EarlyReleaseDeferringAmountTrnDateA 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.
EarlyPaymentAmountRemainingInstallmentCountHow many instalments are still to run.
TotalInstallmentCountHow many instalments the plan has in all.
AmountOfRemainingInstallmentSummaryRecordIdCanceledProfitAmountCanceledKkdfAmountCanceledBsmvAmountCanceledFeeAmountreleasePendingInstallment
Releases a pending installment for a credit card transaction. Accepts a UTID, early release type, and fee amount, and invokes the transaction management service to process the early release. Returns the ER log record ID and the associated ShadowCardNumber.
Part of:
- Journey 03 · Enabling additional capabilities — step 4, Early settlement
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
releasePendingInstallment › Request Body
utidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
feeAmountThe fee charged on the transaction.
earlyReleaseTypeWhich kind of early settlement is being asked for.
releasePendingInstallment › Responses
Success
erLogRecordIdshadowCardNumberThe 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.
cancelInstallmentTransactionOrder
Cancels an existing installment transaction order identified by RecordId. Returns InstallmentOrderRecordId and Success flag indicating whether the cancellation succeeded.
Part of:
- Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelInstallmentTransactionOrder › Request Body
recordIdThe identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry it.
cancelInstallmentTransactionOrder › Responses
Success
installmentOrderRecordIdsuccessWhether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.