REST API for Oracle Banking Collections

Authorize Promise to Pay Type by Given ID

patch

/obedm-ptp-services/ptptype/{id}/approve

This endpoint is used to authorize Promise to Pay Type identified by given ID.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id(required): string

Key of the Promise To Pay Type maintenance

Header Parameters

appId(required): string

The unique identifier of the application making the request.
branchCode(required): string

The code associated with the branch of the user making the request.
contentType: string

The type of content in the request body. Used to specify the format of the request payload.
tenantId: string

The unique identifier of the tenant associated with the request.
userId(required): string

The unique identifier of the user making the request.

Request body contain Promise To Pay Type and Modification number of Promise to Pay Type maintenance which need to be approve.

Root Schema : ModListKeyDto

Type: object

Modification List Data Transer object

Show Source

modNos: array modNos

Modification Number
remarks: string

Remarks

{
    "description":"Modification List Data Transer object",
    "type":"object",
    "properties":{
        "modNos":{
            "description":"Modification Number",
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "remarks":{
            "description":"Remarks",
            "type":"string"
        }
    }
}

Nested Schema : modNos

Type: array

Modification Number

Show Source

Array of: integer

{
    "description":"Modification Number",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Successful operation.

Root Schema : ResponseDtoWrapper

Type: object

Response Data Transfer object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

Response Data Transfer object

{
    "type":"object",
    "description":"Response Data Transfer object",
    "properties":{
        "messages":{
            "description":"Messages",
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "description":"Data",
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Response Data Transfer object

Show Source

codes: array codes

Codes
id: string

ID
requestId: string

Request ID
status: string

Status

{
    "description":"Response Data Transfer object",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

Array of: object ResponseCode

Response code

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

Nested Schema : ResponseCode

Type: object

Response code

Show Source

arg: string

Argument
args: array args

Arguments
Code: string

Code
Desc: string

Description
Language: string

Language
Type: string

Type

{
    "type":"object",
    "description":"Response code",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Arguments",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"Argument"
        }
    }
}

Nested Schema : args

Type: array

Arguments

Show Source

Array of: object items

{
    "type":"array",
    "description":"Arguments",
    "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.

500 Response

Internal error