REST API for Oracle Banking Collections

Add New Promise to Pay Type

post

/obedm-ptp-services/ptptype

This endpoint is used to add a new Promise to Pay Type.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

The unique identifier for the application in the request header.
branchCode(required): string

The code of the branch in the request header.
contentType: string

The type of content in the request header.
tenantId: string

The identifier for the tenant in the request header.
userId(required): string

The unique identifier for the user in the request header.

Request Body that contains data required for creating a new Promise To Pay Types.

Root Schema : DmTmPTPTypeDTO

Type: object

Match All

Show Source

allOf GenericDto
object DmTmPTPTypeDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "ptpTypeCd":{
                    "description":"The code for the PTP (Promise to Pay) type.",
                    "type":"string"
                },
                "ptpTypeDescr":{
                    "description":"The description for the PTP (Promise to Pay) type.",
                    "type":"string"
                },
                "graceDays":{
                    "description":"The number of grace days allowed for the PTP (Promise to Pay) type.",
                    "type":"integer"
                },
                "thresholdPer":{
                    "description":"The threshold percentage for the PTP (Promise to Pay) type.",
                    "type":"number"
                },
                "ruleCd":{
                    "description":"The code for the rule associated with the PTP (Promise to Pay) type.",
                    "type":"string"
                },
                "DmTmPtpTypeSegmentsDTO":{
                    "type":"array",
                    "description":"An array of segments associated with the PTP (Promise to Pay) type.",
                    "items":{
                        "$ref":"#/definitions/DmTmPtpTypeSegmentsDTO"
                    }
                },
                "DmTmPtpTypeAlertConfigDTO":{
                    "type":"array",
                    "description":"An array of alert configurations associated with the PTP (Promise to Pay) type.",
                    "items":{
                        "$ref":"#/definitions/DmTmPtpTypeAlertConfigDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]

Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmPTPTypeDTO-allOf[1]

Type: object

Show Source

DmTmPtpTypeAlertConfigDTO: array DmTmPtpTypeAlertConfigDTO

An array of alert configurations associated with the PTP (Promise to Pay) type.
DmTmPtpTypeSegmentsDTO: array DmTmPtpTypeSegmentsDTO

An array of segments associated with the PTP (Promise to Pay) type.
graceDays: integer

The number of grace days allowed for the PTP (Promise to Pay) type.
ptpTypeCd: string

The code for the PTP (Promise to Pay) type.
ptpTypeDescr: string

The description for the PTP (Promise to Pay) type.
ruleCd: string

The code for the rule associated with the PTP (Promise to Pay) type.
thresholdPer: number

The threshold percentage for the PTP (Promise to Pay) type.

{
    "type":"object",
    "properties":{
        "ptpTypeCd":{
            "description":"The code for the PTP (Promise to Pay) type.",
            "type":"string"
        },
        "ptpTypeDescr":{
            "description":"The description for the PTP (Promise to Pay) type.",
            "type":"string"
        },
        "graceDays":{
            "description":"The number of grace days allowed for the PTP (Promise to Pay) type.",
            "type":"integer"
        },
        "thresholdPer":{
            "description":"The threshold percentage for the PTP (Promise to Pay) type.",
            "type":"number"
        },
        "ruleCd":{
            "description":"The code for the rule associated with the PTP (Promise to Pay) type.",
            "type":"string"
        },
        "DmTmPtpTypeSegmentsDTO":{
            "type":"array",
            "description":"An array of segments associated with the PTP (Promise to Pay) type.",
            "items":{
                "$ref":"#/definitions/DmTmPtpTypeSegmentsDTO"
            }
        },
        "DmTmPtpTypeAlertConfigDTO":{
            "type":"array",
            "description":"An array of alert configurations associated with the PTP (Promise to Pay) type.",
            "items":{
                "$ref":"#/definitions/DmTmPtpTypeAlertConfigDTO"
            }
        }
    }
}

Nested Schema : DmTmPtpTypeAlertConfigDTO

Type: array

An array of alert configurations associated with the PTP (Promise to Pay) type.

Show Source

Array of: object DmTmPtpTypeAlertConfigDTO

{
    "type":"array",
    "description":"An array of alert configurations associated with the PTP (Promise to Pay) type.",
    "items":{
        "$ref":"#/definitions/DmTmPtpTypeAlertConfigDTO"
    }
}

Nested Schema : DmTmPtpTypeSegmentsDTO

Type: array

An array of segments associated with the PTP (Promise to Pay) type.

Show Source

Array of: object DmTmPtpTypeSegmentsDTO

{
    "type":"array",
    "description":"An array of segments associated with the PTP (Promise to Pay) type.",
    "items":{
        "$ref":"#/definitions/DmTmPtpTypeSegmentsDTO"
    }
}

Nested Schema : DmTmPtpTypeAlertConfigDTO

Type: object

Show Source

commMode: string

Communication mode
eventType: string

Event type
id: string

ID
ptpTypeMasterId: string

PTP type master ID
recipientType: string

Recipient type
remDays: integer

Remaining days
ruleCd: string

Rule code
sequence: integer

Sequence
templateCd: string

Template code

{
    "type":"object",
    "properties":{
        "eventType":{
            "description":"Event type",
            "type":"string"
        },
        "remDays":{
            "description":"Remaining days",
            "type":"integer"
        },
        "sequence":{
            "description":"Sequence",
            "type":"integer"
        },
        "recipientType":{
            "description":"Recipient type",
            "type":"string"
        },
        "commMode":{
            "description":"Communication mode",
            "type":"string"
        },
        "templateCd":{
            "description":"Template code",
            "type":"string"
        },
        "ruleCd":{
            "description":"Rule code",
            "type":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "ptpTypeMasterId":{
            "description":"PTP type master ID",
            "type":"string"
        }
    }
}

Nested Schema : DmTmPtpTypeSegmentsDTO

Type: object

Show Source

id: string

ID
ptpTypeMasterId: string

PTP type master ID.
segmentCd: string

Segment code

{
    "type":"object",
    "properties":{
        "segmentCd":{
            "description":"Segment code",
            "type":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "ptpTypeMasterId":{
            "description":"PTP type master ID.",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of success or failure.

Headers

Location: string

URL of newly created Promise To Pay Type.

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.

405 Response

Invalid input

500 Response

Internal error