List payouts

Money moved out of a legal entity’s Stripe balance to its bank account. Payouts live on Stripe rather than in our database, so this reads them from the connected account and pages by cursor rather than offset: pass the last id back as `startingAfter`. `legalEntityId` is required — a payout only means something against the account it left.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

payouts:read

Query Parameters

Name	Type	Required	Description
`legalEntityId`	string	Required	Whose payouts to read.
`limit`	number	Optional	1-100.Default: `20`
`startingAfter`	string	Optional	The last payout id from the previous page.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/payouts" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Payouts retrieved successfully!",
  "content": {
    "payouts": [
      {
        "id": "po_1abc",
        "amount": 420000,
        "currency": "usd",
        "status": "paid",
        "arrivalDate": 1788220800,
        "created": 1788048000,
        "legalEntityId": "le_7788",
        "legalEntityName": "Acme LLC"
      }
    ],
    "hasMore": false
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Finances → Banking

/finances/banking

The payouts table sits under the account balance.