SET Merchant API · Tools
Daily settlement report
GET/v1/reports/settlement
Every balance transaction created in one UTC day, oldest first, each with its railReference, and totals per type, direction and currency. Use it to tie each line on your bank statement to an API object. The rows are the ones GET /v1/balance_transactions answers for the same day.
Query parameters
dateYYYY-MM-DDrequired- A UTC day.
typestring- Only this type:
deposit,cash_out_payment,conversion_payment,card_payment,wallet_withdrawal,payoutorrefund. format"json" | "csv"csvanswers one line per row, with the headerset-report-complete.
Notes
- The report goes by
createdAt, as balance transactions do, not by the bank's settlement date. completeisfalsewhen a type had more than 10,000 rows that day. In CSV, read theset-report-completeheader.- The CSV columns are
createdAt,id,type,direction,state,amount,currency,setFee,platformFee,providerFee,settledAmount,settledCurrency,rail,traceNumber,imad,trackingNumber,endToEndIdandsimulated. railReferenceis the bank's own reference for the payment:{rail, traceNumber, imad, trackingNumber, endToEndId}.traceNumberis the ACH trace number,imadthe Fedwire IMAD,trackingNumberthe UETR on SWIFT, SEPA and Faster Payments (clave de rastreo on SPEI, end-to-end id on Pix), andendToEndIdthe FedNow id. It isnulluntil the bank payment is processed, and for payments on chain or by card. On staging it is written by SET's simulator and marked"simulated": true.
Errors
400 date_invalid400 type_invalid400 format_invalid401 api_key_required401 api_key_invalid401 api_key_wrong_mode401 api_key_expired403 scope_missing403 platform_api_paused429 rate_limited503 api_disabled