Gateways

ch:gateways LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View gateways collection
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required	method
page¹	integer	false	GET
per_page¹	integer	false	GET

See Pagination for details.

Profile

The Gateways resource represents a collection of Gateway resources and a collection of selectable Gateway resources in the context of an Application.

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
ch:application	false

Embedded

Gateway
Selectable (Array of selectable Gateway resources)

Additional semantics

This collection is paginated. See Pagination.

This collection contains selectable resources. See Selection.

Example representation

{
  "count": 1,
  "page": 1,
  "per_page": 20,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/gateways"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:gateways": [...],
    "selectable": [...]
  }
}