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.
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the quick Promise To Pay detail based on given account ID.
Root Schema : DmInitLoadPTPDto
Type:
Show Source
object
-
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: DmTmLookupTypeDTOA 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.
Nested Schema : dmAccountRepaySchDTO
Type:
array
An array of account repayment schedule DTOs associated with the PTP.
Show Source
Nested Schema : lookupDtoMap
Type:
object
Additional Properties Allowed
Show Source
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
Nested Schema : taskCodeDto
Type:
array
An array of task type code DTOs associated with the PTP.
Show Source
Nested Schema : DmAccountRepaySchDTO
Type:
Show Source
object
-
accountId(optional):
string
The unique identifier for the account.
-
installmentAmt(optional):
string
The amount of the repayment installment.
-
installmentDt(optional):
string
The date of the repayment installment.
Nested Schema : DmTmLookupTypeDTO
Type:
Show Source
object
-
DmTmLookupCodeDTO(optional):
array DmTmLookupCodeDTO
-
lookupTypeCd(optional):
string
The lookup type code.
-
lookupTypeDesc(optional):
string
The lookup type description.
Nested Schema : PtpTypeCodeDto
Type:
Show Source
object
-
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.
Nested Schema : ptpSegmentCodes
Type:
array
An array of segment codes associated with the PTP type.
Show Source
Nested Schema : TaskTypeCodeDto
Type:
Show Source
object
-
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.
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error.