Contract

Profile

A Contract represents information about a merchant agreement.

Properties

name type
id string
merchant_id string
currency ISO 4217 3-letter code
mcc string
plan1 string
gateway string
descriptor string
threed_secure_mandatory boolean
other_terms string
contact.name string
contact.email email
contact.phone string
company.name string
company.trading_name string
company.registration_number string
company.address string
company.zipcode_city string
company.country ISO 3166-1 2-letter code
company.websites string
company.business_model string
company.estimated_monthly_turnover string
company.estimate_currency ISO 4217 3-letter code
bank_account.swift_code ISO 9362
bank_account.iban ISO 13616-1
payment.period2 string
payment.delay integer
payment.minimum_amount string
rolling_reserve.percentage string
rolling_reserve.delay integer
rolling_reserve.minimum_amount string
account_fees.base.setup string
account_fees.base.payout string
account_fees.base.monthly string
account_fees.base.yearly string
account_fees.base.retrieval string
account_fees.base.chargeback string
account_fees.percentage.exchange string
transaction_fees.base.authorization string
transaction_fees.base.capture string
transaction_fees.base.refund string
transaction_fees.base.credit string
transaction_fees.minimum.domestic string
transaction_fees.minimum.intra string
transaction_fees.minimum.inter string
transaction_fees.percentage.domestic.visa.debit string
transaction_fees.percentage.domestic.visa.credit string
transaction_fees.percentage.domestic.mastercard.debit string
transaction_fees.percentage.domestic.mastercard.credit string
transaction_fees.percentage.intra.visa.debit string
transaction_fees.percentage.intra.visa.credit string
transaction_fees.percentage.intra.mastercard.debit string
transaction_fees.percentage.intra.mastercard.credit string
transaction_fees.percentage.inter.visa.debit string
transaction_fees.percentage.inter.visa.credit string
transaction_fees.percentage.inter.mastercard.debit string
transaction_fees.percentage.inter.mastercard.credit string
signer.name3 string
signer.email3 email
metadata.state string
metadata.created_at ISO 8601 datetime
metadata.signed_at3 ISO 8601 datetime
metadata.declined_at3 ISO 8601 datetime
metadata.effective_at3 ISO 8601 date
metadata.declined_reason3 string

1
One of: pricing_plus, interchange_plus.
2
One of: daily, weekly, monthly.
3
Presence depends on metadata.state.

rel conditional
self false
ch:application false
ch:record false
ch:stamps1 true
version-history false
latest-version2 true

1
Presence depends on metadata.state.
2
Latest signed contract.

Additional semantics

This resource supports Stamps. See Stamps for more information.

name meaning removable
signed Mark the contract as signed false
declined1 Mark the contract as declined false
1
Supports an optional note request parameter that will be available as metadata.declined_reason.

Content negotiation

This resource supports media type application/pdf.

Example representation

{
  "id": "eb33d586-2968-4a94-843b-bf1e8479416f",
  "merchant_id": "2000001",
  "currency": "EUR",
  "mcc": "5611",
  "plan": "pricing_plus",
  "gateway": "Pay pay",
  "descriptor": "clearhaus.com",
  "threed_secure_mandatory": true,
  "contact": {
    "name": "Caroline S. Bech",
    "email": "CarolineSBech@example.com",
    "phone": "+45 41168678"
  },
  "company": {
    "name": "Acme Corporation",
    "trading_name": "Acme Co.",
    "registration_number": "33749996",
    "address": "Nørrebrovænget 64",
    "zipcode_city": "1106 København K",
    "country": "DK",
    "websites": "https://www.example.org, https://www.example.com",
    "business_model": "Prime non-generic products",
    "estimated_monthly_turnover": "300000.0",
    "estimate_currency": "DKK"
  },
  "bank_account": {
    "swift_code": "DABADKKK",
    "iban": "DK9230055205310542"
  },
  "payment": {
    "period": "weekly",
    "delay": 3,
    "minimum_amount": "0.01"
  },
  "rolling_reserve": {
    "percentage": "5.00",
    "delay": 60,
    "minimum_amount": "0.01"
  },
  "account_fees": {
    "base": {
      "setup": "0.00",
      "payout": "0.00",
      "monthly": "0.00",
      "yearly": "0.00",
      "retrieval": "100.00",
      "chargeback": "240.00"
    },
    "percentage": {
      "exchange": "0.60"
    }
  },
  "transaction_fees": {
    "base": {
      "authorization": "0.00",
      "capture": "0.00",
      "refund": "1.75",
      "credit": "1.75"
    },
    "minimum": {
      "domestic": "0.75",
      "intra": "1.85",
      "inter": "1.85"
    },
    "percentage": {
      "domestic": {
        "visa": {
          "debit": "1.00",
          "credit": "1.00"
        },
        "mastercard": {
          "debit": "1.00",
          "credit": "1.00"
        }
      },
      "intra": {
        "visa": {
          "debit": "2.00",
          "credit": "2.00"
        },
        "mastercard": {
          "debit": "2.00",
          "credit": "2.00"
        }
      },
      "inter": {
        "visa": {
          "debit": "2.00",
          "credit": "2.00"
        },
        "mastercard": {
          "debit": "2.00",
          "credit": "2.00"
        }
      }
    }
  },
  "metadata": {
    "state": "signed",
    "created_at": "2016-07-25T12:21:01.431Z",
    "signed_at": "2016-07-26T13:39:29.461Z",
    "effective_at": "2016-07-27"
  },
  "signer": {
    "name": "Mia M. Lassen",
    "email": "MiaMLassen@example.com"
  },
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f",
    },
    "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:stamps": [
      {
        "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f/stamps/signed",
        "name": "signed"
      },
      {
        "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f/stamps/declined",
        "name": "declined"
      }
    ],
    "version-history": {
      "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f/version-history{?query,page,per_page}",
      "templated": true
    },
    "latest-version": {
      "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}

This browser does not support PDFs. Please download the PDF to view it: Download.

Open Navigation Close Navigation