Record

ch:record LINK RELATION

Actions

method	description
GET	View record
OPTIONS	Retrieve supported HTTP methods

Request parameters

No request parameters.

Profile

A Record represents information about a merchant record.

The record is a composite resource summarising key properties across Application, Contract and Account.

Properties

name	type	conditional
id	string	false
name	string	true
trading_name	string	true
registration_number	string	true
country	ISO 3166-1 2-letter code	true
mccs	object(string => number)	true
currencies	object(ISO 4217 3-letter code => number)	true
websites	array(url)	true
email	email	true
created_at	ISO 8601 date and time in UTC	false
states.application	string	false
states.contracts	object(string => number)	true
states.accounts	object(string => number)	true

Link relations

rel	conditional
self	false
ch:application	false
ch:contracts¹	true
ch:accounts²	true

Presence depends on the existence of a Contract.

Presence depends on the existence of a Merchant Account.

Additional semantics

No additional semantics.

Example representation

{
  "id": "3128a7e4-9594-42fb-a9bd-4f444b58110f",
  "created_at": "2016-07-26T13:39:29.461Z",
  "name": "Acme Corporation",
  "trading_name": "Acme Co.",
  "registration_number": "33749996",
  "country": "DK",
  "mccs": {
    "1234": 2,
  },
  "currencies": {
    "DKK": 1,
    "EUR": 1
  },
  "websites": [
    "www.example.com"
  ],
  "email": "CarolineSBech@example.com",
  "states": {
    "application": "accepted",
    "contracts": {
      "needs_signature": 1,
      "signed": 1
    },
    "accounts": {
      "in_progress": 1,
      "live": 1
    }
  },
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/records/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:contracts": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/contracts"
    },
    "ch:accounts": {
      "href": "https://merchant.test.clearhaus.com/records/3128a7e4-9594-42fb-a9bd-4f444b58110f/accounts"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}