Skip to main content

Get statement lines for all marketplace merchants

GET 
/partner/v2/statement

Retrieve a cursor-paginated feed of settlement statement lines for every merchant associated with your marketplace, in a single call. A line is one settled transaction - an invoice, credit note, adjustment or repayment - carrying its amounts, its fees excluding and including tax, the settlement it was paid out on, and the order and document references needed to reconcile it. Every line belongs to a document, identified by document_id. A document can produce more than one line, and the feed always returns a document's lines as a complete set, so store lines keyed on document_id and replace the whole set whenever it reappears rather than merging line by line. Pass updated_since to receive only documents that changed after that timestamp, and poll with the highest document_updated_at you have seen, less a small overlap. Omit it to sync everything. Repeat merchant_id to restrict the feed to specific merchants. An id your marketplace does not own matches nothing. Use page_cursor from the response metadata to page through results. The lines of one document can continue on the next page, so every line carries document_line_count and document_line_number. Keep a document until you hold every number in its range, then replace the stored set. document_line_key identifies the line itself, because two lines of one document can carry the same references and differ only in their amounts. Send the same updated_since and merchant_id values with the cursor, because a cursor only serves the filters it was issued for. A cursor stops working when the query results behind it expire. A request that carries an expired cursor returns 410. Start again from the highest document_updated_at you have stored. A zero fee tax is usually genuine: most merchants are on a pricing package that sets no fee VAT rate. On settlements before 2025, and on repayment-plan lines, the tax breakdown was never recorded upstream and reads zero for that reason instead, so there a non-zero total_fee can sit beside a zero total_fee_including_tax. total_fee is derived from the fee components and is reliable throughout. The feed shows a deletion as a change to the document. When a line is removed, the lines that remain carry a later change timestamp. The feed returns the document again without the removed line, so replacing the stored set drops that line. A document can lose every line, and it then has nothing left to return, so it stops appearing rather than arriving marked as removed.

Request​

Responses​

Cursor-paginated list of statement lines across all marketplace merchants