Fetch PTP and PTP-history using account number.
get
/obedm-ptp-services/ptp/fetch/{accountNumber}
This endpoint is used to fetch PTP and PTP-history using account number, only when an active case is associated with it.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
accountNumber(required): string
Account Number
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.
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of Promise To Pay is success or failure.
Headers
-
Location: string
URL of newly created Promise To Pay
Nested Schema : DmPTPDto
Type:
Show Source
object
-
accountId:
string
Account ID for DM PTP DTO
-
cancelReasonCode:
string
Cancelled Reason code for PTP
-
caseId:
string
Case ID for DM PTP DTO
-
createdBy:
string
PTP Created by user id
-
createdDtTm:
string
Created PTP date and time
-
currencyCode:
string
Currency Code for PTP DTO
-
id:
string
ID of DM PTP DTO
-
lastBy:
string
Last updated PTP user
-
lastUpdateDtTm:
string
Last time and date update PTP
-
notes:
string
Notes of PTP
-
promiseAmount:
string
Promise amount for PTP DTO
-
promiseDate:
string
Promise date for PTP
-
ptpTransactionDto:
array ptpTransactionDto
PTP transactional DTO
-
ptpTypeCode:
string
PTP type code for PTP DTO
-
receivedAmount:
string
Received amount for PTP DTO
-
status:
string
Status of PTP
-
taskId:
string
Task ID for DM PTP DTO
-
taskTypeCd:
string
Task Type Code of the associated task.
Nested Schema : PTPTransactionDto
Type:
Show Source
object
-
id:
string
The unique identifier for the PTP Transaction.
-
origReferenceNumber:
string
The original reference number for the PTP transaction.
-
ptpMasterId:
string
The unique identifier for the PTP master record.
-
referenceNumber:
string
The reference number for the PTP transaction.
-
transactionAmount:
string
The amount of the PTP transaction.
-
transactionDate:
string
The date the PTP transaction occurred.
-
transactionType:
string
The type of PTP transaction that occurred.
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