> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Internal links on these pages omit the .md extension. Append .md to a docs page URL, or send an Accept: text/markdown header, to get that page as markdown.

# List Wix Payments payouts

> <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 and a personal access token set to Full access. A viewer is refused, and so is a read-only token. The app's workspace also has to allow payment management.</Note>



## OpenAPI

````yaml /developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/payouts
openapi: 3.1.0
info:
  title: Base44 App Management API
  version: 1.0.0
servers:
  - url: https://app.base44.com
security:
  - PersonalAccessTokenAuth: []
paths:
  /api/apps/{app_id}/payments/wix/payouts:
    get:
      summary: List Wix Payments payouts
      description: >-
        <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 and
        a personal access token set to Full access. A viewer is refused, and so
        is a read-only token. The app's workspace also has to allow payment
        management.</Note>
      operationId: get_app_payouts_api_apps__app_id__payments_wix_payouts_get
      parameters:
        - name: app_id
          in: path
          required: true
          schema:
            type: string
            description: ID of the Base44 app.
            title: App Id
          description: ID of the Base44 app.
          example: 6820f3a4e7b91d003c45a1f2
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              `next_cursor` from the previous page. Leave it out to get the
              first page.
            title: Cursor
          description: >-
            `next_cursor` from the previous page. Leave it out to get the first
            page.
          example: gAAAAABn7vJ2kXq9...
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 100
                minimum: 1
              - type: 'null'
            description: >-
              Payouts per page, from 1 to 100. Defaults to 20. Send it only on
              the first page.
            title: Limit
          description: >-
            Payouts per page, from 1 to 100. Defaults to 20. Send it only on the
            first page.
          example: 20
      responses:
        '200':
          description: >-
            One page of the app's payouts, with its scheduled and held funds on
            the first page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutList'
        '400':
          description: >-
            `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`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '401':
          description: Missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '403':
          description: >-
            You don't have write access to the app, or your personal access
            token is read-only (`forbidden`). Also returned when the app's
            workspace doesn't allow payment management
            (`app_payment_management_not_allowed`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '404':
          description: >-
            Wix Payments isn't connected to the app
            (`wix_payments_not_connected`), or the app is outside the
            credential's grant (`not_found`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '409':
          description: The workspace requires an unlocked SSO session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '422':
          description: >-
            `limit` isn't a whole number from 1 to 100 (`invalid_request`).
            `error.details.errors` lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '429':
          description: >-
            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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
components:
  schemas:
    PayoutList:
      properties:
        payouts:
          items:
            $ref: '#/components/schemas/PayoutItem'
          type: array
          title: Payouts
          description: One page of payouts, newest first.
          example:
            - account_profile_id: 3f6d2a90-8e14-4c57-b2a9-6e0f1d7c4b28
              date: '2026-07-15'
              estimated_arrival: '2026-07-18'
              id: 7c1a3e52-4b0d-4f7e-9a61-2d8f5c3b9e10
              money:
                amount: 21485
                currency: usd
              status: sent
        scheduled:
          anyOf:
            - $ref: '#/components/schemas/ScheduledPayout'
            - type: 'null'
          description: >-
            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:
          anyOf:
            - $ref: '#/components/schemas/PayoutMoney'
            - type: 'null'
          description: >-
            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:
          type: boolean
          title: Balance Unavailable
          description: >-
            `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:
          type: integer
          title: Total
          description: >-
            Total number of payouts created before the first page was read, as
            Wix reports it.
          example: 21
        has_more:
          type: boolean
          title: Has More
          description: Whether more payouts follow this page.
          example: true
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: >-
            Pass as `cursor` to get the next page, or `null` on the last page.
            Expires after 24 hours.
          example: gAAAAABn7vJ2kXq9...
      type: object
      required:
        - payouts
        - scheduled
        - on_hold
        - balance_unavailable
        - total
        - has_more
        - next_cursor
      title: PayoutList
    StandardErrorEnvelope:
      properties:
        error:
          $ref: '#/components/schemas/StandardError'
          description: What went wrong.
      type: object
      required:
        - error
      title: StandardErrorEnvelope
      description: The error body returned in the standard envelope.
    PayoutItem:
      properties:
        id:
          type: string
          title: Id
          description: >-
            Wix Payments ID of the payout. Pass it to [Get Wix Payments
            payout](/api-reference/get-wix-payments-payout).
          example: 7c1a3e52-4b0d-4f7e-9a61-2d8f5c3b9e10
        date:
          type: string
          title: Date
          description: Date the payout was created, as `YYYY-MM-DD`.
          example: '2026-07-15'
        estimated_arrival:
          anyOf:
            - type: string
            - type: 'null'
          title: Estimated Arrival
          description: >-
            Date the funds are expected to reach the bank account, as
            `YYYY-MM-DD`, or `null` when Wix doesn't give one.
          example: '2026-07-18'
        status:
          type: string
          title: Status
          description: >-
            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.
          example: sent
        money:
          $ref: '#/components/schemas/PayoutMoney'
          description: Amount of the payout.
        account_profile_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Profile Id
          description: >-
            ID of the Wix Payments account profile the payout belongs to, or
            `null` when Wix doesn't return one.
          example: 3f6d2a90-8e14-4c57-b2a9-6e0f1d7c4b28
        bank_transfer_reference:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Transfer Reference
          description: >-
            Reference the bank shows for the transfer, or `null` when there
            isn't one yet.
          example: WIX-PO-20260715-0042
        failure_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Reason
          description: Wix's code for why the payout failed, or `null` when it didn't fail.
      type: object
      required:
        - id
        - date
        - estimated_arrival
        - status
        - money
        - account_profile_id
      title: PayoutItem
    ScheduledPayout:
      properties:
        date:
          anyOf:
            - type: string
            - type: 'null'
          title: Date
          description: >-
            Date the scheduled funds are paid out, or `null` when they're spread
            over more than one date.
          example: '2026-07-19'
        money:
          $ref: '#/components/schemas/PayoutMoney'
          description: Total amount scheduled to be paid out.
      type: object
      required:
        - date
        - money
      title: ScheduledPayout
    PayoutMoney:
      properties:
        amount:
          type: integer
          title: Amount
          description: >-
            Amount in the currency's smallest unit, such as cents, so `21485` is
            214.85 in USD.
          example: 21485
        currency:
          type: string
          title: Currency
          description: Lowercase three-letter ISO 4217 currency code.
          example: usd
      type: object
      required:
        - amount
        - currency
      title: PayoutMoney
    StandardError:
      properties:
        code:
          type: string
          title: Code
          description: >-
            Stable machine-readable cause of the failure. Match on this, not on
            `message`.
          example: not_found
        message:
          type: string
          title: Message
          description: Human-readable explanation. It isn't a stable contract.
          example: App not found
        details:
          additionalProperties: true
          type: object
          title: Details
          description: >-
            Structured context for the failure, or an empty object when there's
            none.
          example: {}
      type: object
      required:
        - code
        - message
      title: StandardError
  securitySchemes:
    PersonalAccessTokenAuth:
      type: http
      scheme: bearer
      description: 'Personal access token, sent as `Authorization: Bearer <token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.