Application

ch:application LINK RELATION

Actions

method description
GET View application
PATCH Update application
OPTIONS Retrieve supported HTTP methods

Request parameters

property type required
signer.name string false
signer.email1 email false
business_model.trading_name string true
business_model.description string true
business_model.recurring boolean true
business_model.physical_delivery boolean true
business_model.delivery_delay2 string false
business_model.drop_shipping boolean false
business_model.estimate_currency ISO 4217 3-letter code true
business_model.estimated_monthly_turnover decimal(19,4) true
business_model.estimated_average_transaction_amount decimal(19,4) true
additional_information text false
1
Required if signer.name is set.
2
One of: less5days, 5to10days, 10to20days, more20days. Required if business_model.physical_delivery is true.

Profile

A Merchant Application represents an intent to enter into an aggreement with Clearhaus A/S.

A common application process goes through at least the following stages:

submitted -> under_review -> accepted -> Contract signed -> Account live

After the Merchant Agreement (Contract) is signed, a Merchant Account (Account) is set live and the Merchant can start accepting payments.

An Application can optionally have a signer other than the original creator. A signer is the person who will sign the Merchant Agreement and will become the point of contact from then on. The signer is also the user who will have initial access to the Merchant Account in https://my.clearhaus.com.

Properties

name type read-only commentable
signer.name string false true
signer.email email false true
business_model.trading_name string false true
business_model.description string false true
business_model.recurring boolean false true
business_model.physical_delivery boolean false true
business_model.delivery_delay1 string false true
business_model.drop_shipping boolean false true
business_model.estimate_currency ISO 4217 3-letter code false true
business_model.estimated_monthly_turnover string false true
business_model.estimated_average_transaction_amount string false true
additional_information text false true
metadata.state2 string true false
metadata.created_at ISO 8601 date and time in UTC true false
metadata.declined_reason3 string true false
1
One of: less5days, 5to10days, 10to20days, more20days.
2
Can be used to filter applications. See ch:applications.
3
Presence depends on metadata.state.
rel conditional
self false
ch:contact false
ch:company false
ch:comments false
ch:bank-account false
ch:websites false
ch:files false
ch:collaborators false
ch:gateways false
ch:record false
ch:contracts1 true
ch:accounts2 true
ch:stamps3 true
1
Presence depends on the existence of a Contract.
2
Presence depends on the existence of a Merchant Account.
3
Presence depends on metadata.state.

Additional semantics

Stamps

This resource supports Stamps. See Stamps for more information.

name meaning removable
submitted Mark the application as completed and ready for review false
archived Discontinue the application. You can always restore to the previous state true

Field comments

This resource supports field comments. See Field comments for more information.

Example representation

{
  "signer": {
    "name": "Mia M. Lassen",
    "email": "MiaMLassen@example.com"
  },
  "business_model": {
    "trading_name": "Acme Co.",
    "description": "Prime non-generic products",
    "recurring": true,
    "physical_delivery": true,
    "delivery_delay": "5to10days",
    "estimate_currency": "DKK",
    "estimated_monthly_turnover": "300000.0",
    "estimated_average_transaction_amount": "1000.0"
  },
  "additional_information": "Hello",
  "metadata": {
    "state": "submitted",
    "created_at": "2016-07-26T13:39:29.461Z"
  },
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:contact": {
      "href": "https://merchant.test.clearhaus.com/contacts/32f44d04-7662-48f3-a6d5-753740c0f757"
    },
    "ch:comments": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/comments{?page,per_page}"
    },
    "ch:company": {
      "href": "https://merchant.test.clearhaus.com/companies/b3ce3642-2061-4a76-bd9b-1b145395452a"
    },
    "ch:bank-account": {
      "href": "https://merchant.test.clearhaus.com/bank_accounts/9cb29cf0-d9f1-4fc0-aa21-8a5bce65a6c9"
    },
    "ch:websites": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/websites{?page,per_page}"
    },
    "ch:files": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/files{?page,per_page}"
    },
    "ch:collaborators": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/collaborators{?page,per_page}"
    },
    "ch:gateways": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/gateways{?page,per_page}"
    },
    "ch:record": {
      "href": "https://merchant.test.clearhaus.com/records/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:accounts": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/accounts{?query,page,per_page}"
    },
    "ch:contracts": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/contracts{?query,page,per_page}"
    },
    "ch:stamps": [
      {
        "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/stamps/submitted",
        "name": "submitted"
      },
      {
        "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/stamps/archived",
        "name": "archived"
      }
    ],
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}
Open Navigation Close Navigation