IDidealspot

Get Wix Payments dashboard link

Changed on

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

Returns a one-time link to the app's Wix Payments dashboard.

This endpoint depends on the app's Wix site connection rather than on Wix Payments being actively connected, so it can still return a working link after Wix Payments is disconnected.

get/api/apps/{app_id}/payments/wix/dashboard-url

Request

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

Path parameters

app_idstring required

ID of the Base44 app.

Query parameters

redirect_urlstring

Optional redirect on the same origin as the request. Invalid destinations are ignored. Takes priority over destination and open_assistant.

open_assistantboolean

Whether to open the payment methods assistant, when neither redirect_url nor a named destination applies. Defaults to false.

destination'dashboard' | 'payment_settings' | 'payouts'

Where in the Wix dashboard a link should land.

Which Wix Payments page to open: dashboard, payment_settings, or payouts. Defaults to dashboard. Takes priority over open_assistant, but redirect_url takes priority over both.

prefetchboolean

Whether to only mint the link, for a caller that may never open it. A prefetching caller confirms an actual open through the commit route. Defaults to false.

Response

Successful Response

redirect_urlstring required

One-time Wix dashboard link. Treat it as a credential and open it in a browser.

Example response

{
  "redirect_url": "https://manage.wix.com/example-dashboard-link"
}

Changes

  • c23775445de2Revision changes
    • breaking

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

    • info

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

  • 80287813ab84Revision changes
    • info

      the endpoint scheme security PersonalAccessTokenAuth was added to the API