API for retrieving transactions settlements by date
POST https://api.sensepass.com/api/settlements/all
| Name | Type | Description |
|---|---|---|
FilterData
| Name | Type | Description |
|---|---|---|
Response
Pagination data Settlement Report Model
deviceId
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
apiKey
string
Merchant ID provided by SensePass (For Web based Transactions) - Required if deviceId is empty
startDate*
string
2024-01-01T12:00:00Z
endDate*
string
2024-02-01T12:00:00Z
status
string
settled/expired/voided
paymentMethod
string
Sensepass payment method name
currency
string
currency Iso code
pagination.limit
number
limit the number of records returned (between 1 and 1000)
pagination.offset
number
skip N amount of records
orderBy
string
column to sort the results by:
default: submitDate
filter[]
FilterData
filter query rows by array of conditions
parmeter
KeyValue
any custom data to filter by: E.G: "name":"Joe"
operator
string