Simulate New Promise Schedule
post
/obedm-ptp-services/ptp/simulate
This endpoint is used to simulate a new promise schedule.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
Application ID for simulating a promise schedule.
-
branchCode: string
Branch code for simulating a promise schedule.
-
contentType(optional): string
Content Type for simulating a promise schedule.
-
tenantId(optional): string
Tenant ID for simulating a promise schedule.
-
userId: string
User ID for simulating a promise schedule.
Request Body that contains data required for simulating a promise schedule
Root Schema : SimulationRequestDto
Type:
Show Source
object
-
accountId(optional):
string
The unique identifier for the account.
-
amount(optional):
string
The amount of each repayment in the simulation.
-
date(optional):
string
The date the simulation is run.
-
frequency(optional):
string
The frequency of the repayments in the simulation.
-
futureRepayments(optional):
string
Any future repayments in the simulation.
-
noOfInstalments(optional):
integer
The number of repayments in the simulation.
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
-
Location: string
Additional information of the New Promise Schedule
Nested Schema : SimulationResponseDto
Type:
Show Source
object
-
promiseAmount(optional):
string
The promise amount for the simulation.
-
promiseDate(optional):
string
The promise date for the simulation.
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error