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
page²	integer	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
count	integer	true	true
page	integer	true	true
per_page	integer	true	false

Link relations

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

Embedded

Transaction

Additional semantics

This collection is paginated. See Pagination.

This collection supports Transaction Query Language (TQL).

Example representation

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