Get Storefront Payout
GET/api/storefront/payouts/:storefrontPayout
Gets one payout with its lines, the sales orders they matched, its accounting readiness and every document it posted, deposit included.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.
Beyond the list fields:
lines: one per balance change the payout settles, oldest first.categoryis charge, refund, dispute, dispute_reversal, fee, adjustment, reserve, transfer or other;gross,feeandnetare decimal strings in the payout currency (net=gross-fee);fee_detailsbreaks the fee down.store_order_id/order_numberidentify the store order;sales_order_id/sales_order_numberthe SKU.io sales order it matched (matchedis false when none was found).source_idis the processor's charge, refund or dispute ID.lines_net_total: the lines' net sum (null until the lines are read);lines_balance: whether the lines add up to the deposit.readiness.status: done (posted), ready, or blocked.readiness.checkslists each condition withstate(pass, fail, or warn), anotesaying what to change, and a relative applinkto where it is changed. The checks: per_payout_mode_enabled, processor_in_list, after_accounting_start_date, payout_paid, lines_synced, lines_balance, mappings_configured (every line has an account or a fallback covers it), currency_conversion_configured, shared_account_owner, deposit_account_set, and accounting_transactions_created once posted.payout_sync_error: the last processor permission the store reported missing for this store (provider,permission,message,at), or null.
Returns 404 when the payout does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.