Root

ch:root LINK RELATION

Actions

method	description
GET	View root resource
OPTIONS	Retrieve supported HTTP methods

Request parameters

No request parameters.

Profile

The Root resource is the entrypoint for the Merchant API.

The only URL any application should need to know about is the one that points to this resource.

https://merchant.clearhaus.com       # Production
https://merchant.test.clearhaus.com  # Sandbox

Properties

No properties.

Link relations

rel	conditional
self	false
oauth2-token¹	false
ch:applications	true
ch:records	true
ch:accounts	true
ch:settlements	true
ch:transactions	true
ch:disputes	true

See Authentication for more information.

Additional semantics

No additional semantics.

Example representation

{
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com"
    },
    "oauth2-token": {
      "href": "https://merchant.test.clearhaus.com/oauth/token"
    },
    "ch:applications": {
      "href": "https://merchant.test.clearhaus.com/applications{?query,page,per_page}",
      "templated": true
    },
    "ch:records": {
      "href": "https://merchant.test.clearhaus.com/records{?query,page,per_page}",
      "templated": true
    },
    "ch:accounts": {
      "href": "https://merchant.test.clearhaus.com/accounts{?query,page,per_page}",
      "templated": true
    },
    "ch:settlements": {
      "href": "https://merchant.test.clearhaus.com/settlements{?query,page,per_page}",
      "templated": true
    },
    "ch:transactions": {
      "href": "https://merchant.test.clearhaus.com/transactions{?query,per_page}",
      "templated": true
    },
    "ch:disputes": {
      "href": "https://merchant.test.clearhaus.com/disputes{?query,page,per_page}",
      "templated": true
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}