REST API for Oracle Banking Collections

Simulates a New Promise Schedule

post

/obedm-ptp-services/ptp/simulate

This endpoint is used to Simulates a new promise schedule.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

Application ID for simulating a promise schedule.
branchCode(required): string

Branch code for simulating a promise schedule.
contentType: string

Content Type for simulating a promise schedule.
tenantId: string

Tenant ID for simulating a promise schedule.
userId(required): string

User ID for simulating a promise schedule.

Request Body that contains data required for simulating a promise schedule

Root Schema : SimulationRequestDto

Type: object

Show Source

accountId: string

The unique identifier for the account.
amount: string

The amount of each repayment in the simulation.
date: string

The date the simulation is run.
frequency: string

The frequency of the repayments in the simulation.
futureRepayments: string

Any future repayments in the simulation.
noOfInstalments: integer

The number of repayments in the simulation.

{
    "type":"object",
    "properties":{
        "accountId":{
            "description":"The unique identifier for the account.",
            "type":"string"
        },
        "date":{
            "description":"The date the simulation is run.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency of the repayments in the simulation.",
            "type":"string"
        },
        "noOfInstalments":{
            "description":"The number of repayments in the simulation.",
            "type":"integer"
        },
        "amount":{
            "description":"The amount of each repayment in the simulation.",
            "type":"string"
        },
        "futureRepayments":{
            "description":"Any future repayments in the simulation.",
            "type":"string"
        }
    }
}

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

Root Schema : SimulationCollection

Type: object

Collection of promise simulations.

Show Source

data: array data

{
    "description":"Collection of promise simulations.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SimulationResponseDto"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object SimulationResponseDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SimulationResponseDto"
    }
}

Nested Schema : SimulationResponseDto

Type: object

Show Source

promiseAmount: string

The promise amount for the simulation.
promiseDate: string

The promise date for the simulation.

{
    "type":"object",
    "properties":{
        "promiseDate":{
            "description":"The promise date for the simulation.",
            "type":"string"
        },
        "promiseAmount":{
            "description":"The promise amount for the simulation.",
            "type":"string"
        }
    }
}

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