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

Show Source

• DmTmLookupCodeDTO: array DmTmLookupCodeDTO
• lookupTypeCd: string
  The lookup type code.
• lookupTypeDesc: string
  The lookup type description.

{
    "type":"object",
    "properties":{
        "lookupTypeCd":{
            "description":"The lookup type code.",
            "type":"string"
        },
        "lookupTypeDesc":{
            "description":"The lookup type description.",
            "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: boolean
• id: string
• lookupCd: string
• lookupDesc: string
• lookupTypeMasterId: string
• seqNo: integer
  Minimum Value: 0

  Maximum Value: 999
• subCodeOne: string
• subCodeTwo: string
• sysDefFlg: boolean

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"",
            "type":"string"
        },
        "lookupDesc":{
            "description":"",
            "type":"string"
        },
        "seqNo":{
            "description":"",
            "type":"integer",
            "minimum":"0",
            "maximum":"999"
        },
        "sysDefFlg":{
            "description":"",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"",
            "type":"string"
        },
        "enabledFlg":{
            "description":"",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":""
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":""
        }
    }
}

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