Settlements

ch:settlements LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View settlements collection
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required	method
query¹	SQL string	false	GET
page²	integer	false	GET
per_page²	integer	false	GET

See Settlement Query Language (SQL) for details.

See Pagination for details.

Profile

The Settlements resource represents a collection of Settlement resources.

Properties

name	type	read-only
count	integer	true
page	integer	true
per_page	integer	true

Link relations

rel	conditional
self	false
first	true
last	true
prev	true
next	true

Embedded

Settlement

Additional semantics

This collection is paginated. See Pagination.

This collection supports Settlement Query Language (SQL).

Example representation

{
  "count": 1,
  "page": 1,
  "per_page": 20,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/settlements"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:settlements": [...]
  }
}