Skip to main content

List Payouts

GET 

/api/etsy/instances/:integrationInstance/payouts

List an Etsy connection's payouts (one per Etsy deposit), newest first, each with its accounting readiness and its deposit status in the accounting provider.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Filters: filter[search] (internal id, currency or Etsy deposit entry id), filter[id], filter[accounting_status] (pending, ready, posted, held, error), filter[status] (deposited, needs_review), filter[currency], filter[payout_key], filter[amount.*], filter[payout_date.*], filter[created_at.*].

Sort: id, payout_date, amount, accounting_status (default -payout_date). Pagination: per_page default 10, max 100.

Authentication: Bearer token with the accounting:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type