Get Wix Payments payout

Changed on

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

get/api/apps/{app_id}/payments/wix/payouts/{payout_id}

Request

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

Path parameters

payout_idstring required

ID of the payout, taken from id on a payout from List Wix Payments payouts.

app_idstring required

ID of the Base44 app.

Query parameters

cursorstring

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

limitinteger

Balance records per page, from 1 to 100. Defaults to 50. Send it only on the first page.

Response

The payout and one page of its balance records.

records_totalinteger required

Total number of the payout's balance records created before the first page was read.

has_moreboolean required

Whether more records follow this page.

next_cursorstring nullable required

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

Example response

{
  "payout": {
    "id": "7c1a3e52-4b0d-4f7e-9a61-2d8f5c3b9e10",
    "date": "2026-07-15",
    "estimated_arrival": "2026-07-18",
    "status": "sent",
    "money": {
      "amount": 21485,
      "currency": "usd"
    },
    "account_profile_id": "3f6d2a90-8e14-4c57-b2a9-6e0f1d7c4b28",
    "bank_transfer_reference": "WIX-PO-20260715-0042"
  },
  "records": [
    {
      "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": [
    {
      "amount": {
        "amount": 22500,
        "currency": "usd"
      },
      "fees": {
        "amount": 1015,
        "currency": "usd"
      },
      "net": {
        "amount": 21485,
        "currency": "usd"
      },
      "type": "credits"
    }
  ],
  "records_total": 51,
  "has_more": true,
  "next_cursor": "gAAAAABn7vJ2kXq9..."
}

Changes

  • c23775445de2Revision changes
    • breaking

      query request parameter cursor list-of-types was narrowed by removing types null

    • breaking

      query request parameter limit list-of-types was narrowed by removing types null

    • breaking

      for the query request parameter limit, the type changed from no type to integer

    • warning

      for the query request parameter limit, the max was set to 100.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      for the query request parameter cursor, the type was generalized from no type to string

  • 5e139db2e643Revision changes
    • info

      the endpoint scheme security PersonalAccessTokenAuth was added to the API