REST API for Oracle Banking Collections

Cancel Promise To Pay with Reason and Notes

post

/obedm-ptp-services/ptp/cancel

This endpoint is used to Cancel Promise To Pay with reason and notes.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

Application ID for Cancel Promise To Pay with reason and notes.
branchCode(required): string

Branch code for Cancel Promise To Pay with reason and notes.
contentType: string

Content Type for Cancel Promise To Pay with reason and notes.
tenantId: string

Tenant ID for Cancel Promise To Pay with reason and notes.
userId(required): string

User ID for Cancel Promise To Pay with reason and notes.

Request Body that contains data required for cancel Promise To Pay with reason and notes.

Root Schema : CancelPTPRequestDto

Type: object

Show Source

cancelReasonCode: string

The reason code for cancelling the PTP transaction.
id: string

The unique identifier for the PTP transaction to be cancelled.
notes: string

Additional notes or comments for cancelling the PTP transaction.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the PTP transaction to be cancelled.",
            "type":"string"
        },
        "cancelReasonCode":{
            "description":"The reason code for cancelling the PTP transaction.",
            "type":"string"
        },
        "notes":{
            "description":"Additional notes or comments for cancelling the PTP transaction.",
            "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 Cancel Promise To Pay.

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

codes: array codes
id: string
requestId: string
status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

arg: string
args: array args
Code: string
Desc: string
Language: string
Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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