Root

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.

rel conditional
self false
oauth2-token1 false
ch:applications true
ch:accounts true
ch:transactions true
ch:disputes true
1
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{?state,page,per_page}",
      "templated": true
    },
    "ch:accounts": {
      "href": "https://merchant.test.clearhaus.com/accounts{?page,per_page}",
      "templated": true
    },
    "ch:transactions": {
      "href": "https://merchant.test.clearhaus.com/transactions{?query,page,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"
      }
    ]
  }
}
Open Navigation Close Navigation