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.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
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
Response Headers
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.