| Requires any of the roles: | Reseller, Merchant |
| GET | /reports/settlements/ | Get a list of settlement batches based on your search criteria. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BeginDate | query | string | Yes | Beginning date of the settlement batch record query. |
| EndDate | query | string | No | End date of the settlement batch record query. |
| MerchantKey | query | string | No | The key of the merchant of the settlement batches. |
| SortField | query | string | No | The field name by which the records will be sorted. Default is 'BatchDate'.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SortDirection | query | string | No | The direction in which the records will be sorted. Default is 'asc'.Allowable Values
|
| SortField | query | string | No | The field name by which the records will be sorted. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | query | short | No | The number of records per page. Default is 20. |
| PageNumber | query | short | No | The page number to fetch. Default is 1. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports/settlements/ HTTP/1.1 Host: syntch.simpay.net Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
[{"MerchantName":"String","Batches":[{"BatchId":"String","BatchDate":"0001-01-01T00:00:00.0000000","Processor":"String","Message":"String","TransactionCount":0,"SaleAmount":0,"ReturnAmount":0,"TotalAmount":0,"MID":"String"}],"Pagination":{"CurrentPageNumber":0,"PageSize":0,"TotalRecordCount":0}}]