Instalments
Split a purchase or a cash advance across a repayment schedule, then track, settle early or cancel the plan.
Where this is used
Implemented on one programme. A capability is one business idea, built once per card programme, so these are the programmes it applies to.
Journeys that walk through it
How this behaves
What gets split is a transaction, not a card
The key is the transaction's own id. The card number only says which card that transaction belongs to. So the sequence is: find the transaction, simulate a plan for it, then order the plan.
- Find the transactionFrom the transaction listor the statement detail
- SimulateInstalment amount, rateThe schedule, row by row
- OrderReturns a record idand nothing else
- Waiting instalmentsGrouped by statement date
Simulation is not required — an order can be placed directly — but then nothing has computed the schedule the customer was shown. The order returns a record id and nothing else; to see the plan again, simulate it or read the instalments still waiting for a statement.
Two things in the simulation do not say what they appear to
- The instalment count in the response is copied from your request, not taken from the service's answer — the line that would have read it is commented out. If the service settles on a different number, the field will not tell you. The length of the schedule it returns will.
- The headline total leaves out the deferral taxes. It adds interest, the two legal taxes and the instalment fee; the three deferral components are commented out of it. Ask for a deferral month and the total you display is short by them.
Every figure is read defensively, so a service that returns nothing produces a plan of zeros rather than a failure.
Instalments that have not reached a statement yet
They are read as a summary per statement date with the rows belonging to that date underneath, joined on the date itself. The query runs against the card and its main card, because an instalment follows the statement and the statement belongs to the main card.
The summary and the rows are two separate reads, and the rows are attached to the summary dates rather than the other way round. A row whose statement date matches no summary row is dropped — it does not come back in a group of its own. So the set you get is the one both reads agree on.
Operations
credit-digital-channels-integration
/credit/api/getEarlyCloseCandidateList
Retrieves list of transactions eligible for early closure.
POST/credit/api/doEarlyClose
Executes early closure of eligible transactions.
POST/credit/api/getInstallmentCountsByUtid
Retrieves installment count information for a transaction by UTID.
POST/credit/api/getCashInstallmentParameter
Retrieves installment parameters (rates, fees) for cash installment products.
POST/credit/api/simulateCashInstallmentForAll
Simulates installment for all available installment count options.
POST/credit/api/simulateCashInstallment
Simulates cash installment calculation.
POST/credit/api/doCashInstallment
Executes a cash installment transaction.
POST/credit/api/reverseCashInstallment
Reverses a cash installment transaction.
POST/credit/api/getCancelableCashInstallmentList
Retrieves list of cash installments that can be cancelled.
POST/credit/api/getEarlyReleaseCashInstallments
Retrieves list of cash installments eligible for early release (prepayment).
POST/credit/api/getEarlyReleaseCashInstallment
Retrieves details of a specific cash installment for early release.
POST/credit/api/doCashInstallmentEarlyReleasePayment
Executes early release (prepayment) of cash installments.
POST/credit/api/cancelCashInstallEarlyReleasePayment
Cancels a pending early release payment.
POST/credit/api/getAllWaitingInstallments
Retrieves all waiting (future period) installments for a card.
POST/credit/api/getWaitingInstallmentDetail
Retrieves detailed information about a specific waiting installment.
POST/credit/api/getWaitingInstallmentSummary
Retrieves summary of waiting installments grouped by statement period.
POST/credit/api/manuelInstallmentOrder
Converts an existing single-payment transaction into an installment plan.
POST/credit/api/manuelInstallmentOrderSimulate
Simulates manual installment conversion.
POST/credit/api/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.
POST/credit/api/cancelInstallmentEarlyRelease
Cancels an early release operation.
POST/credit/api/getManuelInstallmentCancelRecordsByCardRefNumber
Retrieves history of cancelled manual installment orders.
POST/credit/api/getEarlyReleaseAvailableInstallmentsByCriterias
Retrieves installments available for early release based on criteria.
POST/credit/api/simulateInstallmentEarlyRelease
Simulates early release calculation.
POST/credit/api/releasePendingInstallment
Releases a pending installment (makes it active in current period).
POST/credit/api/cancelInstallmentTransactionOrder
Cancels a pending installment order.