> ## 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.

# Get Wix Payments payout

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

Returns one Wix Payments payout and the balance records it pays out, newest first.

The data is read live from Wix Payments. `summary_items` totals the whole payout by record type and is filled in only on the first page.

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.

<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/{payout_id}
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/{payout_id}:
    get:
      summary: Get Wix Payments payout
      description: >-
        <Info>This API is in beta. Endpoints, fields, and behavior may still
        change, so avoid depending on it in production.</Info>


        Returns one Wix Payments payout and the balance records it pays out,
        newest first.


        The data is read live from Wix Payments. `summary_items` totals the
        whole payout by record type and is filled in only on the first page.


        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.


        <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_payout_detail_api_apps__app_id__payments_wix_payouts__payout_id__get
      parameters:
        - name: payout_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              ID of the payout, taken from `id` on a payout from [List Wix
              Payments payouts](/api-reference/list-wix-payments-payouts).
            title: Payout Id
          description: >-
            ID of the payout, taken from `id` on a payout from [List Wix
            Payments payouts](/api-reference/list-wix-payments-payouts).
          example: 7c1a3e52-4b0d-4f7e-9a61-2d8f5c3b9e10
        - 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 of records. Leave it out to
              get the first page.
            title: Cursor
          description: >-
            `next_cursor` from the previous page of records. 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: >-
              Balance records per page, from 1 to 100. Defaults to 50. Send it
              only on the first page.
            title: Limit
          description: >-
            Balance records per page, from 1 to 100. Defaults to 50. Send it
            only on the first page.
          example: 50
      responses:
        '200':
          description: The payout and one page of its balance records.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutDetail'
        '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: >-
            The payout isn't one of the app's Wix Payments payouts
            (`payout_not_found`), 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:
    PayoutDetail:
      properties:
        payout:
          $ref: '#/components/schemas/PayoutItem'
          description: The payout.
        records:
          items:
            $ref: '#/components/schemas/PayoutRecord'
          type: array
          title: Records
          description: One page of the balance records the payout pays out, newest first.
          example:
            - date: '2026-07-15'
              fee: 30
              id: 9e2b7d41-6a3c-4f18-8d05-1c7e4a9b3f62
              money:
                amount: 1000
                currency: usd
              net: 970
              payment_method: creditCard
              transaction_id: 2b8f4c61-7d93-4e05-a1c8-5f6e3d2b9a47
              transaction_timestamp: '2026-07-14T10:00:00Z'
              type: credit
        summary_items:
          items:
            $ref: '#/components/schemas/PayoutSummaryItem'
          type: array
          title: Summary Items
          description: >-
            Totals for the whole payout, one entry per record type. Only on the
            first page, and empty on later ones.
          example:
            - amount:
                amount: 22500
                currency: usd
              fees:
                amount: 1015
                currency: usd
              net:
                amount: 21485
                currency: usd
              type: credits
        records_total:
          type: integer
          title: Records Total
          description: >-
            Total number of the payout's balance records created before the
            first page was read.
          example: 51
        has_more:
          type: boolean
          title: Has More
          description: Whether more records follow this page.
          example: true
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: >-
            Pass as `cursor` to get the next page of records, or `null` on the
            last page. Expires after 24 hours.
          example: gAAAAABn7vJ2kXq9...
      type: object
      required:
        - payout
        - records
        - summary_items
        - records_total
        - has_more
        - next_cursor
      title: PayoutDetail
    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
    PayoutRecord:
      properties:
        id:
          type: string
          title: Id
          description: Wix Payments ID of the balance record.
          example: 9e2b7d41-6a3c-4f18-8d05-1c7e4a9b3f62
        type:
          type: string
          title: Type
          description: >-
            Wix balance record type, lowercased, for example `credit`. `unknown`
            when Wix returns none.
          example: credit
        date:
          type: string
          title: Date
          description: Date the record was applied to the balance, as `YYYY-MM-DD`.
          example: '2026-07-15'
        money:
          $ref: '#/components/schemas/PayoutMoney'
          description: Gross amount of the record, before fees.
        fee:
          type: integer
          title: Fee
          description: >-
            Fee Wix took on the record, in the smallest unit of
            `money.currency`.
          example: 30
        net:
          type: integer
          title: Net
          description: Amount left after the fee, in the smallest unit of `money.currency`.
          example: 970
        transaction_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Transaction Id
          description: >-
            Wix Payments ID of the transaction behind the record, or `null` when
            the record has no transaction behind it.
          example: 2b8f4c61-7d93-4e05-a1c8-5f6e3d2b9a47
        transaction_timestamp:
          anyOf:
            - type: string
            - type: 'null'
          title: Transaction Timestamp
          description: >-
            When the transaction behind the record was created, as an ISO 8601
            timestamp, or `null` when there's no transaction.
          example: '2026-07-14T10:00:00Z'
        payment_method:
          anyOf:
            - type: string
            - type: 'null'
          title: Payment Method
          description: >-
            Wix's ID for the payment method the customer used, for example
            `creditCard`, or `null` when Wix doesn't return one.
          example: creditCard
      type: object
      required:
        - id
        - type
        - date
        - money
        - fee
        - net
        - transaction_id
        - transaction_timestamp
        - payment_method
      title: PayoutRecord
    PayoutSummaryItem:
      properties:
        type:
          type: string
          title: Type
          description: >-
            Wix summary type, lowercased, for example `credits`. `unknown` when
            Wix returns none.
          example: credits
        amount:
          $ref: '#/components/schemas/PayoutMoney'
          description: Gross total for this type.
        fees:
          $ref: '#/components/schemas/PayoutMoney'
          description: Fees for this type.
        net:
          $ref: '#/components/schemas/PayoutMoney'
          description: Amount left after fees for this type.
      type: object
      required:
        - type
        - amount
        - fees
        - net
      title: PayoutSummaryItem
    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
    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
  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.