Skip to main content

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.

Required scope: accounting:read

Grant 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. category is charge, refund, dispute, dispute_reversal, fee, adjustment, reserve, transfer or other; gross, fee and net are decimal strings in the payout currency (net = gross - fee); fee_details breaks the fee down. store_order_id / order_number identify the store order; sales_order_id / sales_order_number the SKU.io sales order it matched (matched is false when none was found). source_id is 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.checks lists each condition with state (pass, fail, or warn), a note saying what to change, and a relative app link to 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​

OK

Response Headers
    Content-Type