Search Credit Balance Refund
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/SearchCreditBalanceRefund
Use this API to fetch the list of credit balance refunds made to an account. It returns details such as refund date time, amount, user, mode, and bank name.
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 |
|
AccountNumber string Optional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
|
AdminNumber int64 Optional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
|
CardNumber string Optional |
Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Allowable Values: 19 |
|
BatchSize integer Optional |
Number of Transaction which can be view in one Batch Default Value would be 50. Valid Values:0-9 Format:XX Example:20 |
|
PageIndex integer Optional |
Number of page Default value would be 0 Valid Values:0-9 Format:XX Example:12 |
Sample request body
{
"Source": "Web",
"IPAddress": "10.120.0.1",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AccountNumber": "5000000000011071",
"AdminNumber": null,
"CardNumber": null,
"BatchSize": null,
"PageIndex": null
}
Response fields details
| Fields | Description |
|---|---|
|
CreditBalanceRefundList array |
Array/List of credit balance refund transactions. |
Sample response body
{
"Message": "Credit balance refund retrieved successfully",
"Status": true,
"ErrorCode": "ERR01013",
"ResponseData": {
"CreditBalanceRefundList": [
{
"RefundDateTime": "12/13/2016 23:03:15",
"InitiatedBy": "Victoria.Krauchunas",
"RefundAmount": 1071.0,
"RefundMode": "0",
"BankName": "2816"
}
]
}
}