Record

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
merchant_id string true
name string true
trading_name string true
registration_number string true
country ISO 3166-1 2-letter code true
mcc string true
currencies array(ISO 4217 3-letter code) true
websites array(url) true
email email true
created_at ISO 8601 date and time in UTC false
states.application string false
states.contract string true
states.account string true
rel conditional
self false
ch:application false
ch:contract1 true
ch:account2 true
1
Presence depends on the existence of a Contract.
2
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",
  "merchant_id": "3000001",
  "name": "Acme Corporation",
  "trading_name": "Acme Co.",
  "registration_number": "33749996",
  "country": "DK",
  "mcc": "1234",
  "currencies": [
    "DKK"
  ],
  "websites": [
    "www.example.com"
  ],
  "email": "CarolineSBech@example.com",
  "states": {
    "application": "accepted",
    "contract": "signed",
    "account": "live"
  },
  "_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:contract": {
      "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f"
    },
    "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