Open widgets

Generate a URL to open a widget

This endpoint generates a URL to open a widget where Topper facilitates signing

post/open-widget/{widgetId}

Request

  • Base URL: https://api.topperpay.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.topperpay.com/open-widget/{widgetId}
  • Auth: none declared

Path parameters

widgetIdstring uuid required

The widget id to open

Query parameters

campaign_idsstring[]

Public campaigns to be added to the widget session, it overrides any private campaign that would be applied to the session. Only one id can be provided for now. If they cannot be attributed to the session they will be silently ignored.

emailstring email

The user email to be used to prefill on the getting started page

embedboolean

Enable embed mode

locale'en' | 'en-US' | 'pt' | 'pt-BR' | 'es' | 'es-ES'

The locale to set the widget

redirectboolean

Redirect instead of responding with the URL

source_amountstring

Amount to be paid from the source.

source_assetstring

Currency code in ISO 4217 format or Cryptoasset used to make the payment.

Request body

campaignIdsstring[]

Public campaigns to be added to the widget session, it overrides any private campaign that would be applied to the session. Only one id can be provided for now. If they cannot be attributed to the session they will be silently ignored.

periodicity'once' | 'weekly' | 'monthly'

The order periodicity

Response

Success response

bootstrapTokenstring

The bootstrap token in case you want to open the widget using our SDK

urlstring required

The URL to open up the widget

Changes

No recorded changes to this operation across all 1 revision of this API.