Get Payment Schedule Transaction
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetPaymentScheduleTransaction
Use this API to get transactions of each payment schedule using card number or admin number or account number. API fetches out the details such as return reason code for ACH payment reversal transactions, payment method, mode of payment, reversal date, and other details related to payment allocation plans.
Request fields details
Fields | Description |
---|---|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CardNumber string Conditional |
Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. |
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
ScheduleID integer Conditional |
Unique identifier for Schedule Payment. Valid Values: 0-9 Format:XXXXX Example:25874 Condition: Either ScheduleID or Page, Limit is required. |
Action integer Optional |
If Action is blank or Null then all transaction will be returned. 1 = All 2 = Successful 3 = Fail 4= Skipped Valid Values: 1,2,3, Example:1 |
Page integer Conditional |
Use to display transactions for a particular page. It's always be greater than or equal To 1 Valid Values: 0-9 Format:XXX Example:1 Condition : This is mandatory if 'ScheduleID is' not supplied. |
Limit integer Conditional |
Display number of transactions in a page. Valid Values: 0-9 Format:XXX Example:50 Condition : This is mandatory if 'ScheduleID is' not supplied. |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "CardNumber": null, "AdminNumber": 167550, "AccountNumber": "8110000000000125", "ScheduleID": null, "Action": null, "Page": null, "Limit": null }
Response fields details
Fields | Description |
---|---|
TransactionList array |
TransactionList |
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Example:7485122 Allowable Values: 19 |
TotalNumberOfTxns integer |
Total number of transactions in the response. |
Sample response body
{ "Message": "Payment schedule transaction(s) information returned successfully.", "Status": true, "ErrorCode": "ERR01034", "ResponseData": { "TransactionList": [ { "TransactionID": 157878754548754, "PostedDate": "03/15/2020 00:00:00", "TransactionAmount": 152.0, "Description": null, "PostingReference": "1", "PaymentStatus": "Paid", "ReturnReasonCode": null, "ReversalTranid": null, "ReversalDate": null, "ScheduleID": null, "BankName": "JPMorgan Chase", "BankAccountType": "1", "BAMLast4Digit": "0821", "Frequency": 1, "ExternalErrorMessage": null, "PaymentReferenceId": null, "PaymentMode": "0", "RequestID": "1452" } ], "ResponseID": null, "TotalNumberOfTxns": 10 } }