Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Instalment Operations

Create an instalment

This operation will create an instalment plan

post/v1

Query parameters

auditUserstring required

The audit user to log the request

Request body

from'TRANSACTION' required

The source type for the instalment.

descriptionstring

Optional text describing the instalment request

transactionIdstring biginteger required

Example request

{
  "from": "TRANSACTION",
  "description": "Instalment for product #4567",
  "transactionId": "8767653",
  "planOptions": {
    "shift": 2
  }
}

Response

Successful creation of an instalment

descriptionstring

Short description of the result of the action

idstring

Will contain the ID of the resource that has been created or updated