Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clear-box.io/llms.txt

Use this file to discover all available pages before exploring further.

ClearBox provides three layers of reporting so a merchant operator can answer “did I get paid the right amount for what was sold?” at any time.

​
Transactions

Every authorized transaction is queryable by merchant, location, terminal, and time range. Each record carries:
  • The originating terminal_id and location_id.
  • The amount, currency, and the asset the guest paid with.
  • The authorization timestamp, the ClearBox authorization latency, and the settlement timestamp.
GET /v1/merchants/mer_7d3a/transactions?from=2026-05-01&to=2026-05-31

​
Payouts

Each payout is a single record summarizing the net amount that landed in a settlement account. 
GET /v1/merchants/mer_7d3a/payouts

{
  "payout_id": "pay_3c8d",
  "merchant_id": "mer_7d3a",
  "settlement_account_id": "stl_9c4b",
  "window": { "from": "2026-05-27T00:00:00Z", "to": "2026-05-28T00:00:00Z" },
  "gross": "12450.00",
  "fees": "311.25",
  "refunds": "120.00",
  "reserve_held": "62.25",
  "net": "11956.50",
  "currency": "USD",
  "status": "paid",
  "transaction_count": 487
}

​
Settlement reports

For finance teams, ClearBox can deliver a daily settlement report (CSV or JSON) summarizing all transactions, fees, and the resulting payout. Reports can be pulled via the API or delivered to an SFTP endpoint nightly.

​
Reconciliation

The standard reconciliation loop:
1

Pull the payout

Fetch the payout for the window you’re reconciling.
2

Pull its transactions

Fetch the transactions whose settlement timestamp falls in the payout window.
3

Match against POS records

Compare the sum to the merchant’s POS records for the same window. Differences usually trace to refunds, chargebacks, or holds — all of which appear in the payout’s line items.

Webhook event types

See the events ClearBox sends for transactions, payouts, and disputes.