Skip to content

Query Settlements

METHOD NAME querySettlements

Requires state IDLE

Description

Retrieves a list of settlements processed by the terminal.

Parameters

object

  • queryParams QueryParams
    The parameters for querying the list. The default is a descending order, with a limit of 10 settlement records from the last 7 hours. The list is ordered by settlementTime.

Result

object on success

  • settlementRecords SettlementRecord[]
    A list of records found according to the query parameters

Errors

  • IllegalState

Example

Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "querySettlements",
  "params": {
    "queryParams": {
            "from": "2024-10-01T00:00:00.000Z",
            "to": "2024-12-30T15:09:01.756Z",
            "limit": "10",
            "order": "ASC"
        }
  }
}

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "jsonrpc": "2.0",
  "id": "1234567890"
  "result": {
    "settlementRecords": [
        {
            "id": "5b884a09-7d48-457a-91d6-fae615d6aeeb",
            "batchNo": "01649624",
            "time": "2024-11-28T01:34:00+03:00"
        },    
        {
            "id": "b8d2c2c5-4877-4e24-a82b-954bd7ece433",
            "batchNo": "01568223",
            "time": "2024-11-29T01:34:00+03:00"
        }
    ]
  }
}