Get Self-service Payment History
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetSSPaymentHistory
Use this API to retrieve a record of payments made through the Self-service portal. Payment records are fetched using a date range. Each payment record contains information such as the Payment date and Amount.
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 |
|
AdminNumber int64 Mandatory |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
|
PaymentFromDate datetime Mandatory |
Starting date of Payment search. Used as a criteria for Payment History Filter. Valid Values:0-9 Format:MM/DD/YYYY Example:02/20/2020 |
|
PaymentToDate datetime Mandatory |
End date of Payment search. Used as a criteria for Payment History Filter. Valid Values:0-9 Format:MM/DD/YYYY Example:02/20/2020 |
Sample request body
{
"Source": "Web",
"IPAddress": null,
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.205.0.56",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AdminNumber": 129414,
"PaymentFromDate": "01/01/2017 00:00:00",
"PaymentToDate": "01/31/2017 00:00:00"
}
Response fields details
| Fields | Description |
|---|---|
|
ListGetSSPaymentHistory array |
Get or Set lstGetSSPaymentHistory |
Sample response body
{
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"ListGetSSPaymentHistory": [
{
"PaymentDate": "01/17/2017 19:24:12",
"Amount": 36.0,
"PaymentFrom": "Manual Payment by Issuer"
}
]
}
}