Skip to main content

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.

Required scope: accounting:read

Grant 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; amount is what reached the bank, gross_total and fee_total sum the lines (null until the lines are read); a standalone processor fee line counts in full toward fee_total and not toward gross_total, so fee_total matches the fees the payout books and gross_total − fee_total still 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; see readiness on 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 (see shared_account_owner in the accounting settings).
  • readiness is 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​

OK

Response Headers
    Content-Type