Search Merchant Payment Batch
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/SearchMerchantPaymentBatch
Use this API to search merchant payment batch by using criteria's like batch ID, batch status, and batch date.
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 |
BatchDate datetime Optional |
Date of the batch. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/01/2020 |
BatchStatus integer Optional |
The current status of the batch. Please refer to Appendix file section 5.27 for a list of valid codes and values. Example: 8 - Rejected |
BatchDescription string Optional |
A short description of the batch. Valid Values:A-Z, 0-9 Example: Merchant Payment Allowable Values: 200 |
BatchID integer Optional |
The identifier of the batch, which is assigned by the system. Valid Values: 0-9 Example: 1234 |
PageIndex integer Optional |
Number of page. 0 is default value. Valid Values:0-9 Format:XX Example:12 |
BatchSize integer Optional |
Number of Transaction which can be view in one Batch 50 is default value Valid Values:0-9 Format:XX Example:20 |
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, "BatchDate": null, "BatchStatus": null, "BatchDescription": null, "BatchID": 459901, "PageIndex": null, "BatchSize": null }
Response fields details
Fields | Description |
---|---|
MerchantPaymentBatch array |
Array for Merchant payment batch list |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "MerchantPaymentBatch": [ { "BatchDate": "01/15/2017 00:00:00", "BatchTotalDebits": 0.0, "BatchTotalCredits": 100.0, "BatchDescription": "Transaction Rejected. Duplicate TIA Reject", "BatchStatus": "Rejected", "BatchID": 459651 } ] } }