Create Loan Reschedule Request

Asks to reschedule a loan. The request is approved or rejected afterwards; Preview Loan Reschedule shows the schedule it would produce.

The customer is named with exactly one of clientId or nuban (the number of one of the customer's savings accounts). The loan must belong to that customer, otherwise the request is refused with 403.

Request Body

Field Name	Type	Required	Description
`clientId`	integer	FALSE	The customer's client id. Required if `nuban` is not sent.
`nuban`	string	FALSE	NUBAN of one of the customer's savings accounts. Required if `clientId` is not sent.
`loanAccountNo`	string	TRUE	Account number of the loan to reschedule.
`rescheduleFromDate`	string	TRUE	Date the new schedule starts from. Format yyyy-MM-dd.
`submittedOnDate`	string	FALSE	Format yyyy-MM-dd.
`rescheduleReasonId`	integer	TRUE	Reason for the reschedule.
`rescheduleReasonComment`	string	FALSE	Comment on the reason.
`extraTerms`	integer	FALSE	Number of installments to add.

Response Body

Field Name	Type	Description
`loanAccountNo`	string	Account number of the loan.
`loanId`	integer	Internal loan id.
`clientId`	integer	Customer the loan belongs to.
`resourceId`	integer	Id of what was created or changed.
`changes`	object	The fields that changed.
`commandId`	integer	Present instead of the change when the operation is waiting for approval.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "clientId": 42,
  "loanAccountNo": "000000059",
  "rescheduleFromDate": "2026-12-01",
  "submittedOnDate": "2026-11-06",
  "rescheduleReasonId": 1,
  "extraTerms": 3
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Request created

application/json

Request created

Bodyapplication/json

Example

{
  "officeId": 1,
  "clientId": 42,
  "loanId": 7,
  "loanAccountNo": "000000059",
  "resourceId": 5
}

🟠400Validation failed

🟠401The merchant's account has not been granted this operation,

🟠403The loan is not the customer's, or your API user does not ha

🟠404Not found

🔴500The request could not be completed

Request Body#

Response Body#

Request

Request Code Samples

Responses

Request Body

Response Body