---
title: "List Wix Payments payouts"
method: GET
path: "/api/apps/{app_id}/payments/wix/payouts"
---

# List Wix Payments payouts

`GET /api/apps/{app_id}/payments/wix/payouts`

## Request

- Base URL: `https://app.base44.com`
- URL: `https://app.base44.com/api/apps/{app_id}/payments/wix/payouts`
- Auth: HTTP bearer

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the app's Wix Payments payouts, newest first, along with the funds scheduled to be paid out and the funds on hold.

The data is read live from Wix Payments. The first page also reads the account balance: `scheduled` and `on_hold` are filled in only there, and `balance_unavailable` is `true` when Wix couldn't return the balance while the payouts themselves still came back.

Pass `next_cursor` back as `cursor` to get the next page, and leave `limit` out when you do, since the cursor keeps the page size you started with. Every page covers only what was created before the first page was read, so a new one doesn't shift the pages you're walking. A cursor expires after 24 hours.

This endpoint is limited to 60 requests per minute, scoped to your account rather than the workspace.

To open the payouts page of the Wix Payments dashboard instead, call [Get Wix Payments dashboard link](/api-reference/get-wix-payments-dashboard-link) with `destination` set to `payouts`.

<Note>This endpoint only reads, but it needs write access to the app, so a viewer is refused. A read-only personal access token is accepted. The app's workspace also has to allow payment management.</Note>

## Path parameters

- `app_id` string, required: ID of the Base44 app.

## Query parameters

- `cursor` string: `next_cursor` from the previous page. Leave it out to get the first page.
- `limit` integer: Payouts per page, from 1 to 100. Defaults to 20. Send it only on the first page.

## Response `200`

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

- PayoutList
  - `payouts` PayoutItem[], required: One page of payouts, newest first.
    - `id` string, required: Wix Payments ID of the payout. Pass it to [Get Wix Payments payout](/api-reference/get-wix-payments-payout).
    - `date` string, required: Date the payout was created, as `YYYY-MM-DD`.
    - `estimated_arrival` string, nullable, required: Date the funds are expected to reach the bank account, as `YYYY-MM-DD`, or `null` when Wix doesn't give one.
    - `status` string, required: Wix Payments payout status, lowercased, for example `sent` or `failed`. Wix can add values, so handle ones you don't recognize. `unknown` when Wix returns no status.
    - `money` PayoutMoney, required
      - `amount` integer, required: Amount in the currency's smallest unit, such as cents, so `21485` is 214.85 in USD.
      - `currency` string, required: Lowercase three-letter ISO 4217 currency code.
    - `account_profile_id` string, nullable, required: ID of the Wix Payments account profile the payout belongs to, or `null` when Wix doesn't return one.
    - `bank_transfer_reference` string, nullable: Reference the bank shows for the transfer, or `null` when there isn't one yet.
    - `failure_reason` string, nullable: Wix's code for why the payout failed, or `null` when it didn't fail.
  - `scheduled` ScheduledPayout, required
    - `date` string, nullable, required: Date the scheduled funds are paid out, or `null` when they're spread over more than one date.
    - `money` PayoutMoney, required
      - `amount` integer, required: Amount in the currency's smallest unit, such as cents, so `21485` is 214.85 in USD.
      - `currency` string, required: Lowercase three-letter ISO 4217 currency code.
  - `on_hold` PayoutMoney, required
    - `amount` integer, required: Amount in the currency's smallest unit, such as cents, so `21485` is 214.85 in USD.
    - `currency` string, required: Lowercase three-letter ISO 4217 currency code.
  - `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.
  - `total` integer, required: Total number of payouts created before the first page was read, as Wix reports it.
  - `has_more` boolean, required: Whether more payouts follow this page.
  - `next_cursor` string, nullable, required: Pass as `cursor` to get the next page, or `null` on the last page. Expires after 24 hours.

## Other responses

- `400`: `cursor` is malformed, expired, or from another app, or `limit` was sent with it (`invalid_request`). Also returned when the cursor was issued for a different payout or Wix site (`invalid_cursor`).
- `401`: Missing or invalid credentials.
- `403`: You don't have write access to the app (`forbidden`). Also returned when the app's workspace doesn't allow payment management (`app_payment_management_not_allowed`).
- `404`: Wix Payments isn't connected to the app (`wix_payments_not_connected`), or the app is outside the credential's grant (`not_found`).
- `409`: The workspace requires an unlocked SSO session.
- `422`: `limit` isn't a whole number from 1 to 100 (`invalid_request`). `error.details.errors` lists each problem.
- `429`: Rate limit reached (`rate_limited`). The base limit is 60 requests per minute, scoped to your account rather than the workspace. See [Rate limits](/developers/references/apps-api/get-started/rate-limits) for the multiplier your plan gets.

## Changes

> 58 revisions in range; 1 not diffed.

- **2026-10-21** `c23775445de2`: 3 breaking, 2 warning, 1 info
  - `query` request parameter `cursor` list-of-types was narrowed by removing types `null`
  - `query` request parameter `limit` list-of-types was narrowed by removing types `null`
  - for the `query` request parameter `limit`, the type changed from no type to `integer`
  - for the `query` request parameter `limit`, the max was set to `100.00`
  - …2 more
- **2026-10-13** `b92cc2f13639`: 2 info
  - the security scope `read_only` was added to the endpoint's security scheme `PersonalAccessTokenAuth`
  - the security scope `full_access` was removed from the endpoint's security scheme `PersonalAccessTokenAuth`
- **2026-10-12** `5e139db2e643`: 1 info
  - the endpoint scheme security `PersonalAccessTokenAuth` was added to the API
- **2026-10-09** `fc604cdcc3a2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/adexad/apis/base44-app-management-api/changes/api/apps/:app_id/payments/wix/payouts/get.md)

---

[API](https://skmtc.dev/adexad/apis/base44-app-management-api.md) · [All operations](https://skmtc.dev/adexad/apis/base44-app-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/adexad/apis/base44-app-management-api/revisions/fa29e915c226?raw)