Balances, settlement batches and bulk exports, so your ERP and finance systems can pull the data themselves instead of someone exporting it from the console.
net comes from the provider's settlement file, not from our own fee calculation. status=mismatched means our ledger and the provider's file disagree and it is queued for manual review.
Query parameters
connector_code
string
status
string
settled_from
string<date-time>
settled_to
string<date-time>
cursor
string
The page.next_cursor returned by the previous page
limit
integer
Response 200
data
object[]
└uid
string
└connector_code
string
└currency
string
└currency_exponent
integer
└gross
integer
Gross transaction amount
└fee
integer
Provider fees, cross-border fees included
└net
integer
Amount actually received, taken from the provider's settlement file
└txn_count
integer
└status
pending | settled | reconciled | mismatched
mismatched means our ledger and the provider's file disagree; it is already queued for manual review
└settled_at
string<date-time>
page
object
└next_cursor
string
└has_more
boolean
Request
curl -X GET https://api.baton.example/v1/finance/settlements \
-H "Authorization: Bearer sk_live_xxx"
Use this for bulk extraction rather than deep pagination: page ten thousand of a transactions table will take the database down, and we reject cursors beyond a certain depth outright.
When the job finishes you get a webhook, or you can poll.
Headers
Idempotency-Keyrequired
string
A unique string you generate (UUID/ULID recommended). Replaying the same key within 24 hours returns the original result and never creates a second payment.
Body
typerequired
payments | refunds | settlements | disputes
format
csv | jsonl
created_fromrequired
string<date-time>
created_torequired
string<date-time>
At most 31 days per export
Response 202
uid
string
type
payments | refunds | settlements | disputes
status
queued | running | ready | failed | expired
format
csv | jsonl
row_count
integer
download_url
string
Returned only when ready. The signed link is valid for 15 minutes — do not store it