Account

ch:account LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View account
OPTIONS	Retrieve supported HTTP methods

Request parameters

No request parameters.

Profile

An Account represents information about a merchant account.

Properties

name	type
id	string
name	string
country	ISO 3166-1 2-letter code
currency	ISO 4217 3-letter code
mcc	string
merchant_id	string
descriptor	string
timezone	string
transaction_rules	string
metadata.state	string

Link relations

rel	conditional
self	false
ch:members	false
ch:transactions	false
ch:disputes	false
ch:settlements	false
ch:api-keys	false
ch:application	false
ch:record	false
ch:contract	true

Additional semantics

No additional semantics.

Example representation

{
  "id": "f72e20a6-31dc-4c24-9314-4bcc5b8820d4",
  "name": "Clearhaus A/S",
  "country": "DK",
  "currency": "EUR",
  "mcc": "5611",
  "merchant_id": "2000001",
  "descriptor": "clearhaus.com",
  "timezone": "Europe/Copenhagen",
  "transaction_rules": "reject credit",
  "metadata": {
    "state": "live"
  },
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4"
    },
    "ch:members": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4/members{?page,per_page}",
      "templated": true
    },
    "ch:api-keys": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4/api-keys{?page,per_page}",
      "templated": true
    },
    "ch:transactions": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4/transactions{?query,per_page}",
      "templated": true
    },
    "ch:disputes": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4/disputes{?query,page,per_page}",
      "templated": true
    },
    "ch:settlements": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4/settlements{?query,page,per_page}",
      "templated": true
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:record": {
      "href": "https://merchant.test.clearhaus.com/records/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:contract": {
      "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}