SET Merchant API · Statements & tax
Build a monthly statement
POST/v1/statements
One customer's month (UTC) of everything GET /v1/balance_transactions lists, in sections by type with subtotals and a summary, as JSON totals, CSV and PDF. Built in steps: read the statement until state is ready.
Merchant key A merchant's own statement (
self) also lists its card payments and refunds.
Headers
Idempotency-Keystring- Optional. The same key and body run once; a replay answers with
Idempotent-Replayed: true. Kept 24 hours.
Body
customerstringrequired- One of your customers.
monthYYYY-MMrequired- A month that has started.
rebuildboolean- Replace an existing statement, for example one built before its month ended.
Notes
- Each read of
GET /v1/statements/{id}builds more, and SET's scheduler builds one step every ten minutes. - A statement built before its month ended says
complete: false; rebuild it after the month withrebuild: true. - Amounts, states and ids only: no payer, recipient, bank or card details.
Errors
400 body_invalid400 month_invalid400 month_in_future404 customer_unknown409 statement_conflict401 api_key_required401 api_key_invalid401 api_key_wrong_mode403 scope_missing429 rate_limited