Settlements

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
rel conditional
self false
first true
last true
prev true
next true

Embedded

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/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4/settlements"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:settlements": [...]
  }
}
Open Navigation Close Navigation