REST API for Oracle Banking Collections

Get PTP History based on account id and case id

post

/obedm-ptp-services/ptphistory

This endpoint is used to Get PTP History based on account id and case id

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

Application ID for get status count for each status of promise to pay.
branchCode(required): string

Branch code for get status count for each status of promise to pay.
contentType: string

Content Type for get status count for each status of promise to pay.
tenantId: string

Tenant ID for get status count for each status of promise to pay.
userId(required): string

User ID for get status count for each status of promise to pay.

Request Body that contains account ID case ID for getting consolidated ptp history.

Root Schema : PTPHistoryRequestDto

Type: object

Show Source

accountId: string

The ID of the account associated with the PTP History.
caseId: string

The IDs of the case associated with the PTP History.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the PTP History."
        },
        "caseId":{
            "type":"string",
            "description":"The IDs of the case associated with the PTP History."
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of success or failure.

Root Schema : ConsolidatePtpHistoryDto

Type: object

Ptp History view Dto

Show Source

brokenCounts: string

Broken Count
collectedAmount: number

Collected Amount
collectedAmtwithCcyCode: string

Collected Amount With Currency Code
currencyCode: string

Currency Code
keptCounts: string

Kept Count
totalPromises: string

No of Promises

{
    "description":"Ptp History view Dto",
    "type":"object",
    "properties":{
        "totalPromises":{
            "description":"No of Promises",
            "type":"string"
        },
        "brokenCounts":{
            "description":"Broken Count",
            "type":"string"
        },
        "keptCounts":{
            "description":"Kept Count",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency Code",
            "type":"string"
        },
        "collectedAmount":{
            "description":"Collected Amount",
            "type":"number"
        },
        "collectedAmtwithCcyCode":{
            "description":"Collected Amount With Currency Code",
            "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