| Requires any of the roles: | Reseller, Merchant |
| GET | /reports/settlements/transactions/ | Get a list of transactions available for settlement based on your search criteria. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SortField | query | string | No | The field name by which the records will be sorted. Default is 'Timestamp'.Allowable Values
|
| BeginDate | query | string | Yes | Beginning date of the transaction record query. |
| EndDate | query | string | No | End date of the transaction record query. |
| TransactionId | query | int? | No | Filter by TransactionId. |
| MerchantKey | query | int? | No | Filter by MerchantKey. |
| Amount | query | decimal? | No | Filter by Amount. |
| Payer | query | string | No | Filter by Payer. |
| TransactionType | query | List<string> | No | Filter by TransactionType. |
| PaymentType | query | List<string> | No | Filter by PaymentType.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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransactionId | form | int | No | |
| Timestamp | form | DateTime | No | |
| PaymentType | form | string | No | |
| TransactionType | form | string | No | |
| Amount | form | decimal | No | |
| Payer | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports/settlements/transactions/ HTTP/1.1 Host: syntch.simpay.net Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
TransactionId: 0,
Timestamp: 0001-01-01,
PaymentType: String,
TransactionType: String,
Amount: 0,
Payer: String
}