Settlement

Profile

A Settlement represents information about a given settlement.

Properties

name type
id string
settled boolean
currency ISO 4217 3-letter code
period.start_date ISO 8601 date
period.end_date ISO 8601 date
payout.amount1 integer
payout.date ISO 8601 date
payout.reference_number string
payout.descriptor string
summary.sales1 integer
summary.credits1 integer
summary.refunds1 integer
summary.chargebacks1 integer
summary.fees1 integer
summary.other_postings1 integer
summary.net1 integer
reserve.amount1 integer
reserve.date ISO 8601 date
reserve.reference_number string
reserve.descriptor string
fees.sales1 integer
fees.refunds1 integer
fees.authorisations1 integer
fees.credits1 integer
fees.minimum_processing1 integer
fees.service1 integer
fees.wire_transfer1 integer
fees.chargebacks1 integer
fees.retrieval_requests1 integer
other_postings[].date ISO 8601 date
other_postings[].text string
other_postings[].amount1 integer
1
Amount in minor units of given currency (e.g. cents if in Euro).
rel conditional
self false
ch:account false
ch:transactions false

Embedded

Example representation

{
  "id": "a11a7616-a0ae-5301-a83b-a9d6b8f62a56",
  "settled": true,
  "currency": "USD",
  "period": {
    "start_date": "2017-03-15",
    "end_date": "2017-03-21"
  },
  "payout": {
    "amount": 34979873,
    "date": "2017-03-23",
    "reference_number": "73423589061",
    "descriptor": "CH2000001 2017-03-23"
  },
  "summary": {
    "sales": 43544215,
    "credits": -513250,
    "refunds": -2518314,
    "chargebacks": -15634,
    "fees": -1329828,
    "other_postings": -2346270,
    "net": 36820919
  },
  "reserve": {
    "amount": 1841046,
    "date": "2017-06-20",
    "reference_number": "73423589064",
    "descriptor": "CH2000001 2017-06-20"
  },
  "fees": {
    "sales": -1094163,
    "refunds": -4325,
    "authorisations": -2340,
    "credits": -23450,
    "minimum_processing": -32340,
    "service": -65340,
    "wire_transfer": -4300,
    "chargebacks": -12340,
    "retrieval_requests": -91230
  },
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/settlements/a11a7616-a0ae-5301-a83b-a9d6b8f62a56"
    },
    "ch:account": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4"
    },
    "ch:transactions": {
      "href": "https://merchant.test.clearhaus.com/settlements/b11a7616-a0ae-5301-a83b-a9d6b8f62b56/transactions{?query,page,per_page}",
      "templated": true
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:account": {...}
  }
}
Open Navigation Close Navigation