| Requires any of the roles: | Reseller, Merchant |
| GET | /reports/settlements/closed | 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. |
| TransactionCount | query | int? | No | Filter by transaction count. |
| TotalAmount | query | decimal? | No | Filter by total amount. |
| ProcessorName | query | string | No | Filter by processor name. |
| BatchID | query | string | No | Filter by batch id. |
| SettlementType | query | string | No | Filter by settlement type (manual or auto). |
| ManualSettlementUser | query | string | No | Filter by manual settlement user. |
| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports/settlements/closed HTTP/1.1 Host: syntch.simpay.net Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'IEnumerable`1' using the custom 'csv' filter}Cannot create an instance of an interface.