Payments
Requires scope merchant-payout-batches-read.
Lists released daily seller settlement batches with cursor pagination. Each payout id is its YYYY-MM-DD settlement date. Only order settlement credits are included; bank withdrawals and rider settlements are read with payout-transactions.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Query Parameters
Maximum number of items to return in one page.
1 <= value <= 100Cursor for the next page: pass next_cursor from the previous response unchanged. Keep walking while has_more is true.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payouts?limit=10" \ -H "X-Client-Key: {{merchantKey}}"{ "data": [ { "id": "2026-09-24", "settlement_date": "2026-09-24", "total_amount": "66.60", "currency": "USD", "order_count": 1, "first_posted_at": "2026-09-24T15:00:00+01:00", "last_posted_at": "2026-09-24T15:00:00+01:00" } ], "has_more": true, "next_cursor": "WzEsImUzMDI2MWU4ZWQ5YzI4NWFlMDMwN2Q3M2RjOGQxMjgyNTU0NWQ5N2M5M2FkNWEyMGRmYmFlOWJmOGY0MjU1ZDAiLCJleUp6WlhSMGJHVnRaVzUwWDJSaGRHVWlPaUl5TURJMkxUQTVMVEkwSWl3aVgzQnZhVzUwYzFSdlRtVjRkRWwwWlcxeklqcDBjblZsZlEiXQ"}Requires scope merchant-payout-batches-read.
Retrieves one released daily seller settlement batch and up to 100 of its order entries. orders_has_more is true when additional entries were omitted. The payout id is its YYYY-MM-DD settlement date. Batch timestamps and each entry’s posted_at are ISO-8601. Bank withdrawals and rider settlements are not part of a batch: read them with payout-transactions.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
Identifier of the payout, as returned by the Merchant API.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payouts/2026-09-24" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Payout retrieved", "data": { "id": "2026-09-24", "settlement_date": "2026-09-24", "total_amount": "66.60", "currency": "USD", "order_count": 1, "first_posted_at": "2026-09-24T15:00:00+01:00", "last_posted_at": "2026-09-24T15:00:00+01:00", "orders": [ { "order_id": 58213, "order_number": "26-0924-58213", "amount": "66.60", "posted_at": "2026-09-24T15:00:00+01:00" } ], "orders_has_more": false }}Requires scope merchant-payout-ledger-read.
Lists the store’s bank withdrawals, rider settlement credits and the charges for Queek rider trips and courier labels, newest first, with cursor pagination (limit + starting_after, has_more/next_cursor). type narrows to one of withdrawal, rider_settlement, delivery_trip_charge, delivery_trip_charge_reversal or shipping_label_charge. Each row has the ledger id (a UUID), type, status, direction, amount, fee_amount, stamp_duty_amount, net_amount (withdrawals), currency, is_refunded (withdrawals: true only when a released reversal returned the money), the source order (id, number) of a rider settlement or trip charge, the destination bank of a withdrawal (name and account_last4 only) and available_at, posted_at, created_at. The account holder, the full account number, the bank code and any provider detail are never returned. Read only: an app cannot start a withdrawal or change a bank account.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Query Parameters
Maximum number of items to return in one page.
1 <= value <= 100Cursor for the next page: pass next_cursor from the previous response unchanged. Keep walking while has_more is true.
One of withdrawal, rider_settlement, delivery_trip_charge, delivery_trip_charge_reversal, shipping_label_charge.
Value in
- "withdrawal"
- "rider_settlement"
- "delivery_trip_charge"
- "delivery_trip_charge_reversal"
- "shipping_label_charge"
- null
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payout-transactions?limit=10&type=withdrawal" \ -H "X-Client-Key: {{merchantKey}}"{ "data": [ { "id": "019a3a0e-6d21-7b54-8e90-2f4a6c8e0c01", "type": "withdrawal", "status": "completed", "direction": "debit", "amount": "100.00", "fee_amount": "0.50", "stamp_duty_amount": "0.00", "net_amount": "99.50", "currency": "USD", "is_refunded": false, "order": null, "bank": { "name": "Example Bank", "account_last4": "6789" }, "available_at": null, "posted_at": "2026-09-25T10:00:00+01:00", "created_at": "2026-09-25T10:00:00+01:00" }, { "id": "019a3a0e-6d21-7b54-8e90-2f4a6c8e0c02", "type": "rider_settlement", "status": "released", "direction": "credit", "amount": "3.00", "fee_amount": null, "stamp_duty_amount": null, "net_amount": null, "currency": "USD", "is_refunded": null, "order": { "id": 58213, "number": "26-0924-58213" }, "bank": null, "available_at": "2026-09-24T16:00:00+01:00", "posted_at": "2026-09-24T16:00:00+01:00", "created_at": "2026-09-24T15:00:00+01:00" } ], "has_more": true, "next_cursor": "eyJpZCI6IjAxOWEzYTBlLTZkMjEtN2I1NC04ZTkwLTJmNGE2YzhlMGMwMiIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"}Requires scope merchant-payout-ledger-read.
Retrieves one ledger row of this store (a withdrawal, rider settlement, rider trip charge or courier label charge) by its ledger id. The same object as the list; an id of another store, of another kind of ledger row or one that does not exist answers 404.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
Identifier of the payout transaction, as returned by the Merchant API.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payout-transactions/019a3a0e-6d21-7b54-8e90-2f4a6c8e0c01" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Payout transaction retrieved", "data": { "id": "019a3a0e-6d21-7b54-8e90-2f4a6c8e0c01", "type": "withdrawal", "status": "completed", "direction": "debit", "amount": "100.00", "fee_amount": "0.50", "stamp_duty_amount": "0.00", "net_amount": "99.50", "currency": "USD", "is_refunded": false, "order": null, "bank": { "name": "Example Bank", "account_last4": "6789" }, "available_at": null, "posted_at": "2026-09-25T10:00:00+01:00", "created_at": "2026-09-25T10:00:00+01:00" }}