v1

latestSwagger 2.02026-07-1798126172.4 KB

Returns settlement history

get/settle/history

Query parameters

page_sizeinteger

Number of items per page.

pageinteger

Page to filter the items by.

date_fromstring date

Filter the settlements from this date. Formatted in RFC3339 e.g. 2020-07-01.

date_tostring date

Filter the settlements until this date Formatted in RFC3339 e.g. 2020-07-30.

provider_idstring

Provider identity to filter the sessions by.

hermes_idstring

Hermes ID to filter the sessions by.

typesstring[]

Settlement type to filter the sessions by. "settlement" or "withdrawal"

Response

Returns settlement history

pageinteger

The current page of the items.

page_sizeinteger

Number of items per page.

total_itemsinteger

The total items.

total_pagesinteger

The last page of the items.

withdrawal_totalstring

Example response

{
  "items": [
    {
      "amount": "500000",
      "beneficiary": "0x0000000000000000000000000000000000000001",
      "block_explorer_url": "https://example.com",
      "channel_address": "0x0000000000000000000000000000000000000001",
      "error": "internal server error",
      "fees": "500000",
      "hermes_id": "0x0000000000000000000000000000000000000001",
      "provider_id": "0x0000000000000000000000000000000000000001",
      "settled_at": "2019-06-06T11:04:43.910035Z",
      "tx_hash": "0x20c070a9be65355adbd2ba479e095e2e8ed7e692596548734984eab75d3fdfa5"
    }
  ]
}