Get settlement report
GET/v2/merchant/statement
Endpoint to download a settlement report for a specified date range as .xlsx or .csv. The report contains all settlements within the given period, broken down by order with details including fees, net amounts, and payment references. The Settlement Type column shows how a line was settled: GROSS_PAID (paid out at the gross settlement amount), NET_PAID (paid out at the net settlement amount), PAID (paid out), UNPAID or PENDING (not paid out yet), or IGNORE (Two has decided not to pay this settlement out). Treat any value you do not recognise as not paid out, because new values can be added. The Order Type column shows who initiated the order: BUYER_INITIATED (the buyer started it at checkout, which is the default for orders created through the API) or MERCHANT_INITIATED (the merchant started it, as every order created in the Two merchant portal is). It is blank on lines that are not tied to an order, such as repayment-plan lines.
Request
Responses
- 200
- 400
- default
Settlement report file (.xlsx or .csv)
Bad request, invalid dates, or unsupported file type/country code
Error response