Skip to main content

Get Payout

GET 
/api/shopify/:integrationInstance/payouts/:payout

Returns the full detail of a single payout, including the raw Shopify summary breakdown, receipt totals, and every balance-transaction line with its linked local order and payment transaction where resolved. Returns 403 if the payout does not belong to the integration instance.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Entry date: accounting_date, accounting_date_source, accounting_date_locked and accounting_date_locked_at describe the date the payout's documents post on. accounting_parts lists the parts of a payout split at a month end or the accounting start date (key, kind of pre_start/month_end/final, date, source, net, line_count, first and last order date); an unsplit payout has one part. order_date_range gives the first and last order date across the payout's sales.

accounting_blockers lists the checks currently holding the payout back from posting (key, label, detail with what to do), for example a missing Shopify Payments clearing account, lines without a transaction date, an entry date in a locked period, or lines that now fall into different periods than documents already synced. Empty when nothing holds it or once documents are posted.

Each balance-transaction line carries transaction_date (Shopify's transaction date, as a calendar date in the account timezone) and, when linked, order.order_date (the order's date in the account timezone, which payout entry dates are calculated from).

Request​

Responses​

OK

Response Headers
    Content-Type