Transactions

ch:transactions LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View transactions collection
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required	method	conditional
query¹	TQL string	false	GET	false
per_page²	integer	false	GET	false
next²	string	false	GET	true

See Transaction Query Language (TQL) for details.

See Pagination for details.

Profile

The Transactions resource represents a collection of Transaction resources.

Properties

name	type	read-only	conditional
per_page	integer	true	false

Link relations

rel	conditional
self	false
first	true
next	true

Embedded

Transaction

Additional semantics

This collection uses cursor-based pagination. Navigate by following the next link; the end of the collection is reached when next is no longer present. The next link’s href contains an opaque cursor token (carried in the next query parameter) — treat it as opaque and follow the link as-is.

This collection supports Transaction Query Language (TQL).

Example representation

{
  "per_page": 20,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/transactions"
    },
    "first": {
      "href": "https://merchant.test.clearhaus.com/transactions?per_page=20"
    },
    "next": {
      "href": "https://merchant.test.clearhaus.com/transactions?per_page=20&next=<opaque-token>"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:transactions": [...]
  }
}