Api Key


An Api Key allows for processing transactions.


name type
token1 string
expires_at ISO 8601 date and time in UTC
scope string
enabled boolean
The token is truncated (e.g. 9afb8ab0) when Api Key is represented in the Api Keys collection resource.
rel conditional
self false
ch:account false

Additional semantics

No additional semantics.

Example representation

  "token": "9afb8ab0-90bb-4e87-89aa-c11eedf59298",
  "expires_at": "2016-03-03T14:36:27.451Z",
  "scope": "account",
  "enabled": true,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/api-keys/06b11356-840e-4b6b-a5d1-bcde9b4c680b"
    "ch:account": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4"
    "curies": [
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
Open Navigation Close Navigation