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: string
  Account ID for Promise to pay.
• ptpType(optional): string
  Promise To Pay Type.

Header Parameters

• appId: string
  Application ID of Promise To Pay.
• branchCode: string
  Branch Code of Promise To Pay.
• contentType(optional): string
  content Type of Promise To Pay.
• tenantId(optional): string
  Tenant ID of Promise To Pay.
• userId: 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(optional): string
  The ID of the account associated with the PTP.
• currencyCode(optional): string
  The currency code for the PTP amount.
• dmAccountRepaySchDTO(optional): array dmAccountRepaySchDTO
  An array of account repayment schedule DTOs associated with the PTP.
• lookupDtoMap(optional): object lookupDtoMap
  Additional Properties Allowed: DmTmLookupTypeDTO

  A map of lookup type DTOs associated with the PTP.
• promiseDate(optional): string
  The date on which the PTP is promised.
• ptpTypeCodeDto(optional): array ptpTypeCodeDto
  An array of PTP type code DTOs associated with the PTP.
• taskCodeDto(optional): 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
  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

DmAccountRepaySchDTO

Show Source

• accountId(optional): string
  accountId of the DmAccountRepaySch
• createdBy(optional): string
  createdBy of the DmAccountRepaySch
• cretDttm(optional): string
  cretDttm of the DmAccountRepaySch
• feeAmt(optional): number
  feeAmt of the DmAccountRepaySch
• installmentAmt(optional): number
  installmentAmt of the DmAccountRepaySch
• installmentDt(optional): string
  installmentDt of the DmAccountRepaySch
• installmentNum(optional): number
  installmentNum of the DmAccountRepaySch
• interestAmt(optional): number
  interestAmt of the DmAccountRepaySch
• lastUpdatedBy(optional): string
  lastUpdatedBy of the DmAccountRepaySch
• lastUpdtDttm(optional): string
  lastUpdtDttm of the DmAccountRepaySch
• principalAmt(optional): number
  principalAmt of the DmAccountRepaySch
• principalBalAmt(optional): number
  principalBalAmt of the DmAccountRepaySch
• udf1(optional): number
  udf1 of the DmAccountRepaySch
• udf10(optional): number
  udf10 of the DmAccountRepaySch
• udf11(optional): number
  udf11 of the DmAccountRepaySch
• udf12(optional): number
  udf12 of the DmAccountRepaySch
• udf13(optional): number
  udf13 of the DmAccountRepaySch
• udf14(optional): number
  udf14 of the DmAccountRepaySch
• udf15(optional): number
  udf15 of the DmAccountRepaySch
• udf16(optional): number
  udf16 of the DmAccountRepaySch
• udf17(optional): number
  udf17 of the DmAccountRepaySch
• udf18(optional): number
  udf18 of the DmAccountRepaySch
• udf19(optional): number
  udf19 of the DmAccountRepaySch
• udf2(optional): number
  udf2 of the DmAccountRepaySch
• udf20(optional): number
  udf20 of the DmAccountRepaySch
• udf21(optional): number
  udf21 of the DmAccountRepaySch
• udf22(optional): number
  udf22 of the DmAccountRepaySch
• udf23(optional): number
  udf23 of the DmAccountRepaySch
• udf24(optional): number
  udf24 of the DmAccountRepaySch
• udf25(optional): number
  udf25 of the DmAccountRepaySch
• udf26(optional): number
  udf26 of the DmAccountRepaySch
• udf27(optional): number
  udf27 of the DmAccountRepaySch
• udf28(optional): number
  udf28 of the DmAccountRepaySch
• udf29(optional): number
  udf29 of the DmAccountRepaySch
• udf3(optional): number
  udf3 of the DmAccountRepaySch
• udf30(optional): number
  udf30 of the DmAccountRepaySch
• udf31(optional): string
  udf31 of the DmAccountRepaySch
• udf32(optional): string
  udf32 of the DmAccountRepaySch
• udf33(optional): string
  udf33 of the DmAccountRepaySch
• udf34(optional): string
  udf34 of the DmAccountRepaySch
• udf35(optional): string
  udf35 of the DmAccountRepaySch
• udf36(optional): string
  udf36 of the DmAccountRepaySch
• udf37(optional): string
  udf37 of the DmAccountRepaySch
• udf38(optional): string
  udf38 of the DmAccountRepaySch
• udf39(optional): string
  udf39 of the DmAccountRepaySch
• udf4(optional): number
  udf4 of the DmAccountRepaySch
• udf40(optional): string
  udf40 of the DmAccountRepaySch
• udf41(optional): string
  udf41 of the DmAccountRepaySch
• udf42(optional): string
  udf42 of the DmAccountRepaySch
• udf43(optional): string
  udf43 of the DmAccountRepaySch
• udf44(optional): string
  udf44 of the DmAccountRepaySch
• udf45(optional): string
  udf45 of the DmAccountRepaySch
• udf46(optional): string
  udf46 of the DmAccountRepaySch
• udf47(optional): string
  udf47 of the DmAccountRepaySch
• udf48(optional): string
  udf48 of the DmAccountRepaySch
• udf49(optional): string
  udf49 of the DmAccountRepaySch
• udf5(optional): number
  udf5 of the DmAccountRepaySch
• udf50(optional): string
  udf50 of the DmAccountRepaySch
• udf6(optional): number
  udf6 of the DmAccountRepaySch
• udf7(optional): number
  udf7 of the DmAccountRepaySch
• udf8(optional): number
  udf8 of the DmAccountRepaySch
• udf9(optional): number
  udf9 of the DmAccountRepaySch

{
    "description":"DmAccountRepaySchDTO",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"accountId of the DmAccountRepaySch",
            "type":"string"
        },
        "installmentDt":{
            "description":"installmentDt of the DmAccountRepaySch",
            "type":"string"
        },
        "installmentAmt":{
            "description":"installmentAmt of the DmAccountRepaySch",
            "type":"number"
        },
        "principalAmt":{
            "description":"principalAmt of the DmAccountRepaySch",
            "type":"number"
        },
        "interestAmt":{
            "description":"interestAmt of the DmAccountRepaySch",
            "type":"number"
        },
        "feeAmt":{
            "description":"feeAmt of the DmAccountRepaySch",
            "type":"number"
        },
        "principalBalAmt":{
            "description":"principalBalAmt of the DmAccountRepaySch",
            "type":"number"
        },
        "installmentNum":{
            "description":"installmentNum of the DmAccountRepaySch",
            "type":"number"
        },
        "cretDttm":{
            "description":"cretDttm of the DmAccountRepaySch",
            "type":"string"
        },
        "lastUpdtDttm":{
            "description":"lastUpdtDttm of the DmAccountRepaySch",
            "type":"string"
        },
        "createdBy":{
            "description":"createdBy of the DmAccountRepaySch",
            "type":"string"
        },
        "lastUpdatedBy":{
            "description":"lastUpdatedBy of the DmAccountRepaySch",
            "type":"string"
        },
        "udf1":{
            "description":"udf1 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf2":{
            "description":"udf2 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf3":{
            "description":"udf3 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf4":{
            "description":"udf4 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf5":{
            "description":"udf5 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf6":{
            "description":"udf6 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf7":{
            "description":"udf7 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf8":{
            "description":"udf8 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf9":{
            "description":"udf9 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf10":{
            "description":"udf10 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf11":{
            "description":"udf11 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf12":{
            "description":"udf12 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf13":{
            "description":"udf13 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf14":{
            "description":"udf14 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf15":{
            "description":"udf15 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf16":{
            "description":"udf16 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf17":{
            "description":"udf17 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf18":{
            "description":"udf18 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf19":{
            "description":"udf19 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf20":{
            "description":"udf20 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf21":{
            "description":"udf21 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf22":{
            "description":"udf22 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf23":{
            "description":"udf23 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf24":{
            "description":"udf24 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf25":{
            "description":"udf25 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf26":{
            "description":"udf26 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf27":{
            "description":"udf27 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf28":{
            "description":"udf28 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf29":{
            "description":"udf29 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf30":{
            "description":"udf30 of the DmAccountRepaySch",
            "type":"number"
        },
        "udf31":{
            "description":"udf31 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf32":{
            "description":"udf32 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf33":{
            "description":"udf33 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf34":{
            "description":"udf34 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf35":{
            "description":"udf35 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf36":{
            "description":"udf36 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf37":{
            "description":"udf37 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf38":{
            "description":"udf38 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf39":{
            "description":"udf39 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf40":{
            "description":"udf40 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf41":{
            "description":"udf41 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf42":{
            "description":"udf42 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf43":{
            "description":"udf43 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf44":{
            "description":"udf44 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf45":{
            "description":"udf45 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf46":{
            "description":"udf46 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf47":{
            "description":"udf47 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf48":{
            "description":"udf48 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf49":{
            "description":"udf49 of the DmAccountRepaySch",
            "type":"string"
        },
        "udf50":{
            "description":"udf50 of the DmAccountRepaySch",
            "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":{
                "lookupTypeCd":{
                    "description":"The code representing the type of the lookup.",
                    "type":"string"
                },
                "lookupTypeDesc":{
                    "description":"A description of the type of the lookup.",
                    "type":"string"
                },
                "sysDefFlg":{
                    "description":"A flag indicating whether this lookup is a system default.",
                    "type":"boolean"
                },
                "sysDefStatus":{
                    "description":"The status of the system default lookup.",
                    "type":"string"
                },
                "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(optional): array DmTmLookupCodeDTO
• lookupTypeCd(optional): string
  The code representing the type of the lookup.
• lookupTypeDesc(optional): string
  A description of the type of the lookup.
• sysDefFlg(optional): boolean
  A flag indicating whether this lookup is a system default.
• sysDefStatus(optional): string
  The status of the system default lookup.

{
    "type":"object",
    "properties":{
        "lookupTypeCd":{
            "description":"The code representing the type of the lookup.",
            "type":"string"
        },
        "lookupTypeDesc":{
            "description":"A description of the type of the lookup.",
            "type":"string"
        },
        "sysDefFlg":{
            "description":"A flag indicating whether this lookup is a system default.",
            "type":"boolean"
        },
        "sysDefStatus":{
            "description":"The status of the system default lookup.",
            "type":"string"
        },
        "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(optional): boolean
  The flag indicating if the lookup is enabled.
• id(optional): string
  The unique identifier for the lookup.
• lookupCd(optional): string
  The code for the lookup.
• lookupDesc(optional): string
  The description for the lookup.
• lookupTypeMasterId(optional): string
  The unique identifier for the lookup type of this lookup.
• seqNo(optional): integer
  Minimum Value: 0

  Maximum Value: 999

  The sequence number of the lookup.
• subCodeOne(optional): string
  The first sub-code for the lookup.
• subCodeTwo(optional): string
  The second sub-code for the lookup.
• sysDefFlg(optional): boolean
  The flag indicating if the lookup is system-defined.

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"The code for the lookup.",
            "type":"string"
        },
        "lookupDesc":{
            "description":"The description for the lookup.",
            "type":"string"
        },
        "seqNo":{
            "description":"The sequence number of the lookup.",
            "type":"integer",
            "minimum":0,
            "maximum":999
        },
        "sysDefFlg":{
            "description":"The flag indicating if the lookup is system-defined.",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"The first sub-code for the lookup.",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"The second sub-code for the lookup.",
            "type":"string"
        },
        "enabledFlg":{
            "description":"The flag indicating if the lookup is enabled.",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"The unique identifier for the lookup."
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":"The unique identifier for the lookup type of this lookup."
        }
    }
}

Nested Schema : PtpTypeCodeDto

Type: object

Show Source

• ptpSegmentCodes(optional): array ptpSegmentCodes
  An array of segment codes associated with the PTP type.
• ptpTypeCode(optional): string
  The code associated with the PTP type.
• ptpTypeDesc(optional): 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(optional): string
  The code associated with the segment of the task type.
• taskCode(optional): string
  The code associated with the task type.
• taskDesc(optional): string
  The description of the task type.
• taskId(optional): string
  The ID of the task associated with the task type.
• taskStatus(optional): 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