List Square Payout Entries
GET/api/square/payouts/:squarePayout/entries
Paginated list of the line-item entries that make up a Square payout (individual charges, refunds and fees). Each entry links back to the underlying Square payment or refund.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Filters: type. Allowed sorts: id, type, effective_at, gross_amount, fee_amount, net_amount. Default: -effective_at. Pagination: page, per_page (default 25).
Route name: square.payouts.entries
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.