Gateway

ch:gateway LINK RELATION

Actions

method	description
GET	View gateway
OPTIONS	Retrieve supported HTTP methods

Profile

A Gateway represents a Payment Service Provider.

Properties

name	type	commentable
id	string	false
name	string	true

Link relations

rel	conditional
self	false
ch:selection¹	true
ch:comments²	true

Present when represented in the Gateways collection of selectable resources. See Selection for details.

Present on a selected gateway.

Additional semantics

Selection

This resource supports Selection. See Selection.

Field comments

This resource supports field comments. See Field comments for more information.

Example representation

{
  "id": "88a92fb6-cf56-4ece-bc5d-1b544ad5a1e1",
  "name": "Pay pay",
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/gateways/88a92fb6-cf56-4ece-bc5d-1b544ad5a1e1"
    },
    "ch:selection": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/gateways/88a92fb6-cf56-4ece-bc5d-1b544ad5a1e1"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}