Settlement

API for retrieving transactions settlements by date

POST https://api.sensepass.com/api/settlements/all

Request Body

Name	Type	Description
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: status/paymentMethod/settlementAmount/fee/submitDate/settlementDate/transactionNumber/pmTransId/cardType default: submitDate
filter[]	FilterData	filter query rows by array of conditions

FilterData

Name	Type	Description
parmeter	KeyValue	any custom data to filter by: E.G: "name":"Joe"
operator	string	'=', '!=', '<', '<=', '>', '>='

Example Request

{
   "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-06-01T00:00:00Z",
    "apikey": "myApiKey",
    "pagination": {
        "limit": "40",
        "offset": "0"
    },
    "orderBy": "settlementAmount",
    "filter": [{"accountId": "1000635", "operator": "!="}, {"age": "10", "operator": ">"}  ]    
}

Response

Pagination data Settlement Report Model

200

{ "pagination": {
    "returnedRecords": 2,
    "totalRecords": 2
    "isPartialResult": "false"
  },
  "data": [
    {
        "status": "settled",
        "paymentMethod": "Authorize.Net",
        "settlementAmount": "10.21",
        "fee": null,
        "submitDate": "2024-03-27T13:29:07.200Z",
        "settlementDate": "2024-01-04T05:06:18.377Z",
        "transactionNumber": "c7bc37546cf53aa42fa4e2838bbda9cd355e99e680a7715fc4d85dc6",
        "pmTransId": "120012947718",
        "cardType": "MasterCard",
        "settlementCurrency": "USD"
    },
    {
        "status": "expired",
        "paymentMethod": "Authorize.Net",
        "settlementAmount": "12.79",
        "fee": null,
        "submitDate": "2024-03-27T13:29:07.404Z",
        "settlementDate": "2023-12-28T07:40:19.838Z",
        "transactionNumber": "4afa7ca11746f1e9b89ee05b56db6463728752a2a486893a6f44766a",
        "pmTransId": "120012495576",
        "cardType": "MasterCard",
        "settlementCurrency": "USD"
    }
    ]

400