<back to all web services
GetSettlementTransactions
Reporting - Settlement Transactions
Requires Authentication
| Requires any of the roles: | Reseller, Merchant |
The following routes are available for this service:| GET | /reports/settlements/transactions/ | Get a list of transactions available for settlement based on your search criteria. | |
|---|
GetSettlementTransactions Parameters:| 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- TransactionId
- MerchantKey
- Timestamp
- PaymentType
- TransactionType
- Amount
- Username
- Payer
|
| 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- CREDIT
- VISA
- DINERS
- AMEX
- MASTERCARD
- JAL
- JCB
- DISCOVER
- CARTEBLANCHE
- EBT
- DEBIT
- ECG
- VERIFY
- ECHECK
|
SortedRequestDto Parameters:| 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. |
PaginatedRequestDto Parameters:| 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. |
SettlementTransaction Parameters:| 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 .xml suffix or ?format=xml
HTTP + XML
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SettlementTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses">
<Amount>0</Amount>
<Payer>String</Payer>
<PaymentType>String</PaymentType>
<Timestamp>0001-01-01T00:00:00</Timestamp>
<TransactionId>0</TransactionId>
<TransactionType>String</TransactionType>
</SettlementTransaction>