Jump to

• Request
• Response

Retrieve Quick Promise to Pay by Account ID

get

/obedm-ptp-services/ptp

This endpoint is used to retrieve the quick Promise to Pay details.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId(required): string
  Account ID for Promise to pay.
• ptpType: string
  Promise To Pay Type.

Header Parameters

• appId(required): string
  Application ID of Promise To Pay.
• branchCode(required): string
  Branch Code of Promise To Pay.
• contentType: string
  content Type of Promise To Pay.
• tenantId: string
  Tenant ID of Promise To Pay.
• userId(required): string
  User ID of Promise To Pay.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the quick Promise To Pay detail based on given account ID.

Body ()

Root Schema : DmInitLoadPTPDto

Type: object

Show Source

• accountId: string
  The ID of the account associated with the PTP.
• currencyCode: string
  The currency code for the PTP amount.
• dmAccountRepaySchDTO: array dmAccountRepaySchDTO
  An array of account repayment schedule DTOs associated with the PTP.
• lookupDtoMap: object lookupDtoMap
  Additional Properties Allowed: DmTmLookupTypeDTO

  A map of lookup type DTOs associated with the PTP.
• promiseDate: string
  The date on which the PTP is promised.
• ptpTypeCodeDto: array ptpTypeCodeDto
  An array of PTP type code DTOs associated with the PTP.
• taskCodeDto: array taskCodeDto
  An array of task type code DTOs associated with the PTP.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the PTP."
        },
        "promiseDate":{
            "type":"string",
            "description":"The date on which the PTP is promised."
        },
        "currencyCode":{
            "type":"string",
            "description":"The currency code for the PTP amount."
        },
        "taskCodeDto":{
            "type":"array",
            "description":"An array of task type code DTOs associated with the PTP.",
            "items":{
                "$ref":"#/definitions/TaskTypeCodeDto"
            }
        },
        "ptpTypeCodeDto":{
            "type":"array",
            "description":"An array of PTP type code DTOs associated with the PTP.",
            "items":{
                "$ref":"#/definitions/PtpTypeCodeDto"
            }
        },
        "dmAccountRepaySchDTO":{
            "type":"array",
            "description":"An array of account repayment schedule DTOs associated with the PTP.",
            "items":{
                "$ref":"#/definitions/DmAccountRepaySchDTO"
            }
        },
        "lookupDtoMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/DmTmLookupTypeDTO"
            },
            "description":"A map of lookup type DTOs associated with the PTP."
        }
    }
}

Nested Schema : dmAccountRepaySchDTO

Type: array

An array of account repayment schedule DTOs associated with the PTP.

Show Source

• Array of: object DmAccountRepaySchDTO

{
    "type":"array",
    "description":"An array of account repayment schedule DTOs associated with the PTP.",
    "items":{
        "$ref":"#/definitions/DmAccountRepaySchDTO"
    }
}

Nested Schema : lookupDtoMap

Type: object

Additional Properties Allowed

Show Source

• object DmTmLookupTypeDTO

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/DmTmLookupTypeDTO"
    },
    "description":"A map of lookup type DTOs associated with the PTP."
}

A map of lookup type DTOs associated with the PTP.

Nested Schema : ptpTypeCodeDto

Type: array

An array of PTP type code DTOs associated with the PTP.

Show Source

• Array of: object PtpTypeCodeDto

{
    "type":"array",
    "description":"An array of PTP type code DTOs associated with the PTP.",
    "items":{
        "$ref":"#/definitions/PtpTypeCodeDto"
    }
}

Nested Schema : taskCodeDto

Type: array

An array of task type code DTOs associated with the PTP.

Show Source

• Array of: object TaskTypeCodeDto

{
    "type":"array",
    "description":"An array of task type code DTOs associated with the PTP.",
    "items":{
        "$ref":"#/definitions/TaskTypeCodeDto"
    }
}

Nested Schema : DmAccountRepaySchDTO

Type: object

Show Source

• accountId: string
  The unique identifier for the account.
• installmentAmt: string
  The amount of the repayment installment.
• installmentDt: string
  The date of the repayment installment.

{
    "type":"object",
    "properties":{
        "accountId":{
            "description":"The unique identifier for the account.",
            "type":"string"
        },
        "installmentDt":{
            "description":"The date of the repayment installment.",
            "type":"string"
        },
        "installmentAmt":{
            "description":"The amount of the repayment installment.",
            "type":"string"
        }
    }
}

Nested Schema : DmTmLookupTypeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmLookupTypeDTO-allOf[1]

{
    "type":"object",
    "required":[
        "lookupTypeCd",
        "lookupTypeDesc",
        "sysDefFlg"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "DmTmLookupCodeDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmLookupCodeDTO"
                    }
                }
            }
        }
    ]
}

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 : DmTmLookupTypeDTO-allOf[1]

Type: object

Show Source

• DmTmLookupCodeDTO: array DmTmLookupCodeDTO

{
    "type":"object",
    "properties":{
        "DmTmLookupCodeDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmLookupCodeDTO"
            }
        }
    }
}

Nested Schema : DmTmLookupCodeDTO

Type: array

Show Source

• Array of: object DmTmLookupCodeDTO

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

Nested Schema : DmTmLookupCodeDTO

Type: object

Show Source

• enabledFlg: boolean
  Enabled Flag
• id: string
  ID
• lookupCd: string
  Lookup Code
• lookupDesc: string
  Lookup Description
• lookupTypeMasterId: string
  Lookup Type Master ID
• seqNo: integer
  Minimum Value: 0

  Maximum Value: 999

  Sequence Number
• subCodeOne: string
  Sub Code One
• subCodeTwo: string
  Sub Code Two
• sysDefFlg: boolean
  System Def Flag

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"Lookup Code",
            "type":"string"
        },
        "lookupDesc":{
            "description":"Lookup Description",
            "type":"string"
        },
        "seqNo":{
            "description":"Sequence Number",
            "type":"integer",
            "minimum":"0",
            "maximum":"999"
        },
        "sysDefFlg":{
            "description":"System Def Flag",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"Sub Code One",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"Sub Code Two",
            "type":"string"
        },
        "enabledFlg":{
            "description":"Enabled Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":"Lookup Type Master ID"
        }
    }
}

Nested Schema : PtpTypeCodeDto

Type: object

Show Source

• ptpSegmentCodes: array ptpSegmentCodes
  An array of segment codes associated with the PTP type.
• ptpTypeCode: string
  The code associated with the PTP type.
• ptpTypeDesc: string
  The description of the PTP type.

{
    "type":"object",
    "properties":{
        "ptpTypeCode":{
            "type":"string",
            "description":"The code associated with the PTP type."
        },
        "ptpTypeDesc":{
            "type":"string",
            "description":"The description of the PTP type."
        },
        "ptpSegmentCodes":{
            "type":"array",
            "description":"An array of segment codes associated with the PTP type.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ptpSegmentCodes

Type: array

An array of segment codes associated with the PTP type.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of segment codes associated with the PTP type.",
    "items":{
        "type":"string"
    }
}

Nested Schema : TaskTypeCodeDto

Type: object

Show Source

• segmentCode: string
  The code associated with the segment of the task type.
• taskCode: string
  The code associated with the task type.
• taskDesc: string
  The description of the task type.
• taskId: string
  The ID of the task associated with the task type.
• taskStatus: string
  The status of the task type.

{
    "type":"object",
    "properties":{
        "taskCode":{
            "type":"string",
            "description":"The code associated with the task type."
        },
        "taskId":{
            "type":"string",
            "description":"The ID of the task associated with the task type."
        },
        "taskDesc":{
            "type":"string",
            "description":"The description of the task type."
        },
        "segmentCode":{
            "type":"string",
            "description":"The code associated with the segment of the task type."
        },
        "taskStatus":{
            "type":"string",
            "description":"The status of the task type."
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error.

Back to Top