Get Payout Accounting Setup
GET/api/shopify/:integrationInstance/payout-accounting-setup
Returns what the store's per-payout accounting still needs before its Shopify payouts can post: one step per account, the paid payouts currently held back, and the payment gateways (other than Shopify Payments) whose orders have no payment type mapped.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
A store connected from now on starts in per-payout mode (one summary per payout, matched to the bank deposit), so this is the checklist for finishing that setup. A store in per-order mode returns is_per_payout: false, complete: true and empty steps.
Authentication: Requires Bearer token.
Response fields:
uses_shopify_payments— false only for a store confirmed not to take Shopify Payments (orders imported, none through Shopify Payments or Shop Pay Installments, no payouts). Such a store gets no payout steps: every order is invoiced on its own.outside_payout_orders— what happens to orders a payout never carries:invoice_per_orderorleave_out.complete— every required step is configured.missing_required_count— required steps not yet configured.held_payout_count— paid payouts held back from posting, for any reason.steps[]—key(revenue_fallback,expense_fallback,payments_clearing,invoiced_orders_clearing; the last while unpaid orders are invoiced per order, while a held payout needs it, or once it is set),label,reason,required(always for the two fallbacks; for a clearing account only once a payout is held without it),configured,held_payout_count(payouts this missing account holds),account(id,code,nameonce set) andsuggestion(for the clearing accounts: thenameandtypeCreate Payout Setup Account would create, andexistingwhen an account of that name already exists and should be selected instead).unmapped_gateways[]—gatewayandtitleof each gateway other than Shopify Payments and Shop Pay Installments with no payment type mapped. Map each to a payment type that deposits into that processor's own clearing account.action_route/payment_methods_route— where in SKU.io to finish the setup and to map gateways.
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.