Instalments
Split a purchase or a cash advance across a repayment schedule, then track, settle early or cancel the plan.
Service that lists installment transactions eligible for early closure for the given customer and card
Service that lists installment transactions eligible for early closure for the given customer and card.
Service that lists installment transactions eligible for early closure for the given customer and card › Request Body
customerNumberCustomer Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
Service that lists installment transactions eligible for early closure for the given customer and card › Responses
Success
List Of Early Close Candidate Row - [Optional]
Performs early closure for a given card and transaction
Performs early closure of a credit card installment. Returns the early release log record ID and the shadow card number.
Performs early closure for a given card and transaction › Request Body
feeAmountFee Amount - [Optional]
earlyReleaseTypeEarly Release Type - [Optional]
shadowCardNumberShadow Card Number - [Optional]
utidUtid - [Optional]
Performs early closure for a given card and transaction › Responses
Success
erLogRecordIdEr Log Record Id - [Optional]
shadowCardNumberShadow Card Number - [Optional]
Service that returns min/max installment counts applicable to the transaction for a given UTID
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.
Service that returns min/max installment counts applicable to the transaction for a given UTID › Request Body
UtidUtid - [Optional]
Service that returns min/max installment counts applicable to the transaction for a given UTID › Responses
Success
AmountAmount - [Optional]
DateDate - [Optional]
MinInstallmentCountMin Installment Count - [Optional]
MaxInstallmentCountMax Installment Count - [Optional]
MinDeferringMonthCountMin Deferring Month Count - [Optional]
MaxDeferringMonthCountMax Deferring Month Count - [Optional]
InstallmentCountLimitInstallment Count Limit - [Optional]
InstallmentCountMccGroupLimitInstallment Count Mcc Group Limit - [Optional]
InstallmentCountMccLimitInstallment Count Mcc Limit - [Optional]
InstallmentProfileDeferringLimitInstallment Profile Deferring Limit - [Optional]
InstallmentProfileInstallmentLimitInstallment Profile Installment Limit - [Optional]
MccDefinitionInstallmentLimitMcc Definition Installment Limit - [Optional]
DescriptionDescription - [Optional]
Service that returns interest/profit share rates and amounts for installment ranges for a cash-advance request
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
Service that returns interest/profit share rates and amounts for installment ranges for a cash-advance request › Request Body
transactionAmountTransaction Amount - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountNumberAccount Number - [Optional]
channelIdChannel Id - [Optional]
Service that returns interest/profit share rates and amounts for installment ranges for a cash-advance request › Responses
Success
Cash Installment Parameter List - [Optional]
Service that returns interest/profit share rates and amounts for all possible installment options for a cash-advance request
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
Service that returns interest/profit share rates and amounts for all possible installment options for a cash-advance request › Request Body
transactionAmountTransaction Amount - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountNumberAccount Number - [Optional]
channelIdChannel Id - [Optional]
Service that returns interest/profit share rates and amounts for all possible installment options for a cash-advance request › Responses
Success
Cash Installment Simulate List - [Optional]
Service that returns interest/profit share rates and amounts based on selected installment count for a cash-advance request
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.
Service that returns interest/profit share rates and amounts based on selected installment count for a cash-advance request › Request Body
transactionAmountTransaction Amount - [Optional]
installmentCountInstallment Count - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountNumberAccount Number - [Optional]
channelIdChannel Id - [Optional]
Service that returns interest/profit share rates and amounts based on selected installment count for a cash-advance request › Responses
Success
Cash Installment Simulate Item - [Optional]
Installment cash advance service
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
Installment cash advance service › Request Body
transactionAmountTransaction Amount - [Optional]
installmentCountInstallment Count - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountNumberAccount Number - [Optional]
referenceNumberReference Number - [Optional]
channelIdChannel Id - [Optional]
Installment cash advance service › Responses
Success
isSuccessIs Success - [Optional]
feeAmountFee Amount - [Optional]
uTIDU T I D - [Optional]
authCodeAuth Code - [Optional]
responseCodeResponse Code - [Optional]
responseReasonCodeResponse Reason Code - [Optional]
reasonDescriptionReason Description - [Optional]
rrnRrn - [Optional]
Service that fully or partially closes installment cash advances
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)
Service that fully or partially closes installment cash advances › Request Body
amountAmount - [Optional]
shadowCardNumberShadow Card Number - [Optional]
uTIDU T I D - [Optional]
referenceNumberReference Number - [Optional]
Service that fully or partially closes installment cash advances › Responses
Success
isSuccessIs Success - [Optional]
uTIDU T I D - [Optional]
authCodeAuth Code - [Optional]
responseReasonCodeResponse Reason Code - [Optional]
Service that lists installment cash advances eligible for cancellation
Retrieves a list of cancellable cash installments for a given shadow card number, including transaction details and card master information.
Service that lists installment cash advances eligible for cancellation › Request Body
shadowCardNumberShadow Card Number - [Optional]
Service that lists installment cash advances eligible for cancellation › Responses
Success
List Of Cash Installment - [Optional]
Service that lists early-closed installment cash advances
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.
Service that lists early-closed installment cash advances › Request Body
shadowCardNumberShadow Card Number - [Optional]
Service that lists early-closed installment cash advances › Responses
Success
Transaction List - [Optional]
Service that returns early-closed installment cash advance details
Service that returns early-closed installment cash advance details.
Service that returns early-closed installment cash advance details › Request Body
shadowCardNumberShadow Card Number - [Optional]
utidUtid - [Optional]
Service that returns early-closed installment cash advance details › Responses
Success
transactionDateTransaction Date - [Optional]
transactionAmountTransaction Amount - [Optional]
installmentCountInstallment Count - [Optional]
totalFeeAmountTotal Fee Amount - [Optional]
installmentProfitRateInstallment Profit Rate - [Optional]
totalInstallmentAmountTotal Installment Amount - [Optional]
remainingInstallmentCountRemaining Installment Count - [Optional]
remainingInstallmentCapitalAmountRemaining Installment Capital Amount - [Optional]
earlyReleaseTotalAmountEarly Release Total Amount - [Optional]
earlyReleaseInterestAmountEarly Release Interest Amount - [Optional]
earlyReleaseTotalTaxAmountEarly Release Total Tax Amount - [Optional]
earlyReleaseBsmvAmountEarly Release Bsmv Amount - [Optional]
earlyReleaseKkdfAmountEarly Release Kkdf Amount - [Optional]
shadowCardNumberShadow Card Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
utidUtid - [Optional]
Early closure of installment cash advance service
Processes an early release cash installment payment. Returns UTID, transaction ID, authorization number, and RRN.
Early closure of installment cash advance service › Request Body
accountNumberAccount Number - [Optional]
amountAmount - [Optional]
clientReferenceNumberClient Reference Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
channelChannel - [Optional]
currencyCodeCurrency Code - [Optional]
cashInstallmentUtidCash Installment Utid - [Optional]
Early closure of installment cash advance service › Responses
Success
trnIdTrn Id - [Optional]
utidUtid - [Optional]
rrnRrn - [Optional]
authorizationNumberAuthorization Number - [Optional]
Service that cancels an installment transaction that was previously closed early
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.
Service that cancels an installment transaction that was previously closed early › Request Body
clientReferenceNumberClient Reference Number - [Optional]
trnIdTrn Id - [Optional]
amountAmount - [Optional]
currencyCodeCurrency Code - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
trnDateTrn Date - [Optional]
channelChannel - [Optional]
cashInstallmentUtidCash Installment Utid - [Optional]
Service that cancels an installment transaction that was previously closed early › Responses
Success
trnIdTrn Id - [Optional]
Service that lists all pending installments
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
Service that lists all pending installments › Request Body
shadowCardNumberShadow Card Number - [Optional]
Service that lists all pending installments › Responses
Success
Result
Service that returns details of a pending installment transaction
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
Service that returns details of a pending installment transaction › Request Body
shadowCardNumberShadow Card Number - [Optional]
Service that returns details of a pending installment transaction › Responses
Success
totalAmountTotal Amount - [Optional]
List Of Next Period Installment - [Optional]
currencyCodeCurrency Code - [Optional]
Service that returns total interest/profit share and fee amounts for all pending installments of a card
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
Service that returns total interest/profit share and fee amounts for all pending installments of a card › Request Body
shadowCardNumberShadow Card Number - [Optional]
Service that returns total interest/profit share and fee amounts for all pending installments of a card › Responses
Success
List Waiting Installment Summary Info - [Optional]
Service that receives a manual installment request
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)
Service that receives a manual installment request › Request Body
installmentCountInstallment Count - [Optional]
deferringMonthCountDeferring Month Count - [Optional]
shadowCardNumberShadow Card Number - [Optional]
utidUtid - [Optional]
channelTypeChannel Type - [Optional]
Service that receives a manual installment request › Responses
Success
installmentOrderRecordIdInstallment Order Record Id - [Optional]
Manual installment simulation service
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)
Manual installment simulation service › Request Body
installmentCountInstallment Count - [Optional]
deferringMonthCountDeferring Month Count - [Optional]
shadowCardNumberShadow Card Number - [Optional]
utidUtid - [Optional]
Manual installment simulation service › Responses
Success
installmentAmountInstallment Amount - [Optional]
profitRateProfit Rate - [Optional]
totalPaymentAmountTotal Payment Amount - [Optional]
totalPFTAmountTotal P F T Amount - [Optional]
installmentCountInstallment Count - [Optional]
deferringMonthCountDeferring Month Count - [Optional]
List Of Installment Record - [Optional]
Service that returns installment options applicable to a transaction for a given UTID
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)
Service that returns installment options applicable to a transaction for a given UTID › Request Body
UtidUtid - [Optional]
Service that returns installment options applicable to a transaction for a given UTID › Responses
Success
AmountAmount - [Optional]
DateDate - [Optional]
MinInstallmentCountMin Installment Count - [Optional]
MaxInstallmentCountMax Installment Count - [Optional]
MinDeferringMonthCountMin Deferring Month Count - [Optional]
MaxDeferringMonthCountMax Deferring Month Count - [Optional]
InstallmentCountLimitInstallment Count Limit - [Optional]
InstallmentCountMccGroupLimitInstallment Count Mcc Group Limit - [Optional]
InstallmentCountMccLimitInstallment Count Mcc Limit - [Optional]
InstallmentProfileDeferringLimitInstallment Profile Deferring Limit - [Optional]
InstallmentProfileInstallmentLimitInstallment Profile Installment Limit - [Optional]
MccDefinitionInstallmentLimitMcc Definition Installment Limit - [Optional]
DescriptionDescription - [Optional]
Early installment closure reversal service
Cancels an early release of an installment for a given card identified by ShadowCardNumber and UTID. Returns the number of affected rows as EffectedRowCount.
Early installment closure reversal service › Request Body
shadowCardNumberShadow Card Number - [Optional]
utidUtid - [Optional]
Early installment closure reversal service › Responses
Success
effectedRowCountEffected Row Count - [Optional]
Service that returns manual installment cancellation list
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.
Service that returns manual installment cancellation list › Request Body
cardRefNumberCard Ref Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
Service that returns manual installment cancellation list › Responses
Success
Manuel Installment Cancel Records - [Optional]
Service that lists installments eligible for early closure based on selected criteria
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
Service that lists installments eligible for early closure based on selected criteria › Request Body
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
Service that lists installments eligible for early closure based on selected criteria › Responses
Success
Installment Early Release Rows - [Optional]
Simulation service showing how interest/profit differences are refunded in early installment closure
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
Simulation service showing how interest/profit differences are refunded in early installment closure › Request Body
shadowCardNumberShadow Card Number - [Optional]
utidUtid - [Optional]
Simulation service showing how interest/profit differences are refunded in early installment closure › Responses
Success
CanceledFeeAndProfitAmountCanceled Fee And Profit Amount - [Optional]
ProfitAmountProfit Amount - [Optional]
FeeAmountFee Amount - [Optional]
EarlyReleaseDeferringAmountEarly Release Deferring Amount - [Optional]
TrnDateTrn Date - [Optional]
EarlyPaymentAmountEarly Payment Amount - [Optional]
RemainingInstallmentCountRemaining Installment Count - [Optional]
TotalInstallmentCountTotal Installment Count - [Optional]
AmountOfRemainingInstallmentAmount Of Remaining Installment - [Optional]
SummaryRecordIdSummary Record Id - [Optional]
CanceledProfitAmountCanceled Profit Amount - [Optional]
CanceledKkdfAmountCanceled Kkdf Amount - [Optional]
CanceledBsmvAmountCanceled Bsmv Amount - [Optional]
CanceledFeeAmountCanceled Fee Amount - [Optional]
Service that closes pending installments
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
Service that closes pending installments › Request Body
feeAmountFee Amount - [Optional]
earlyReleaseTypeEarly Release Type - [Optional]
utidUtid - [Optional]
Service that closes pending installments › Responses
Success
erLogRecordIdEr Log Record Id - [Optional]
shadowCardNumberShadow Card Number - [Optional]
Post-installment request cancellation service
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)
Post-installment request cancellation service › Request Body
recordIdRecord Id - [Optional]
Post-installment request cancellation service › Responses
Success
installmentOrderRecordIdInstallment Order Record Id - [Optional]
successSuccess - [Optional]