List Square Payouts

GET 
/api/square/payouts

Paginated list of Square payouts (deposit / settlement batches) across integration instances. Each row carries the deposit amount, status, arrival date and mapped location so channel revenue can be reconciled against actual bank deposits.

Not yet available to API tokens

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

Filters: integration_instance_id, status, square_location_id, search (Payout ID / End-to-End ID), date_from, date_to (compared against the Square created date). Allowed sorts: id, square_payout_id, status, amount, arrival_date, square_created_at. Default: -square_created_at. Pagination: page, per_page (default 25).

Route name: square.payouts.index

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.