Skip to main content
GET
List Wix Payments payouts

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the Base44 app.

Query Parameters

cursor
string | null

next_cursor from the previous page. Leave it out to get the first page.

limit
integer | null

Payouts per page, from 1 to 100. Defaults to 20. Send it only on the first page.

Required range: 1 <= x <= 100

Response

One page of the app's payouts, with its scheduled and held funds on the first page.

payouts
PayoutItem · object[]
required

One page of payouts, newest first.

Example:
scheduled
ScheduledPayout · object | null
required

Funds already scheduled to be paid out. null when nothing is scheduled, when the balance couldn't be read, and on every page after the first.

on_hold
PayoutMoney · object | null
required

Funds Wix is holding back from payouts. null when nothing is on hold, when the balance couldn't be read, and on every page after the first.

balance_unavailable
boolean
required

true when Wix couldn't return the balance, so scheduled and on_hold are null even if funds exist. Always false on pages after the first, which don't read the balance.

Example:

false

total
integer
required

Total number of payouts created before the first page was read, as Wix reports it.

Example:

21

has_more
boolean
required

Whether more payouts follow this page.

Example:

true

next_cursor
string | null
required

Pass as cursor to get the next page, or null on the last page. Expires after 24 hours.

Example:

"gAAAAABn7vJ2kXq9..."