List Storefront Payouts
GET/api/storefront/payouts
Lists the Stripe payouts your Storefront stores report, across every store (narrow with filter[integration_instance_ids]), newest arrival first.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
A payout is one deposit the processor sent to your bank. Its lines are the charges, refunds, disputes and fees it settles; each charge line is matched to the SKU.io sales order it paid for. When a store books its revenue per payout (see Get Storefront Accounting Settings), a paid payout posts to your accounting provider as a sales invoice for the gross amounts and a bill for the processor's fees, and its deposit is recorded against the account you chose for that processor.
Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.
Fields:
amount,gross_total,fee_total: decimal strings in the payout currency;amountis what reached the bank,gross_totalandfee_totalsum the lines (null until the lines are read); a standalone processor fee line counts in full towardfee_totaland not towardgross_total, sofee_totalmatches the fees the payout books andgross_total−fee_totalstill equals the sum of the line nets.status: the processor's status (pending, in_transit, paid, failed, canceled).accounting_status: pending (waits on the store: per-order mode, processor not booked by payouts, or not paid yet), ready, posted, held (something must be fixed first; seereadinesson Get Storefront Payout), error, or before_start (arrives before the store's payout accounting start date and never posts).documents: the accounting documents posted for the payout (kind: invoice, bill, sales_credit, vendor_credit, revenue_recognition), with their reference, total and sync status. The deposit is included on Get Storefront Payout.also_reported_by_instance_ids: other stores that report the same processor account; only one store books it (seeshared_account_ownerin the accounting settings).readinessis null in the list; read one payout for its checks.
Payouts sync automatically every hour for stores booked per payout; Sync Storefront Payouts starts a sync on demand.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.