Trade Widget SDK
API Reference

Getting started

Trade Widget is a single page app that implements a full trade solution to be embedded in an iframe.

By default, it features a full customer onboarding flow, but it can also be combined with our API
to create a custom onboarding flow. See our Frictionless Sign-up and Sign-in flows guide. This can be useful, for example, in mobile wallets where the user is already onboarded in the mobile app.

❗️

Important:

To correctly embed the Trade Widget into your web page you must add an iframe element as shown in the examples.

❗️

For user identity verification the following attributes are required to be specified for the iframe element:

  • The allow="camera;fullscreen;accelerometer;gyroscope;magnetometer;payment" allowfullscreen attributes must be included to enable the camera and provide the best user experience for user identity verification.
  • In case you are nesting the iframe in another iframe the allow="camera;fullscreen;accelerometer;gyroscope;magnetometer;payment" allowfullscreen attributes must be added to every iframe.

Example of embedding the widget link in an iframe, sandbox env:

<iframe src="https://trade-ui.sandbox.coinify.com?partnerId={replace-with-assigned-id}&primaryColor=blue&cryptoCurrencies=BTC,ETH,XLM" width="100%" height="576px" allow="camera;fullscreen;accelerometer;gyroscope;magnetometer;payment" allowfullscreen></iframe>

Example of embedding the widget link in an iframe, production env:

<iframe src="https://trade-ui.coinify.com?partnerId={replace-with-assigned-id}&primaryColor=blue&cryptoCurrencies=BTC,ETH,XLM" width="100%" height="576px" allow="camera;fullscreen;accelerometer;gyroscope;magnetometer;payment" allowfullscreen></iframe>

Example to pass partnerContext as stringified json:

<iframe src="https://trade-ui.coinify.com?partnerId={replace-with-assigned-id}&partnerContext=%7B%22clientId%22%3A123%2C%22refId%22%3A12%7D" width="100%" height="576px" allow="camera;fullscreen;accelerometer;gyroscope;magnetometer;payment" allowfullscreen></iframe>

See Supported Query parameters for more info on partnerContext and other supported Trade Widget parameters.

🚧

Partner ID:

The partnerId query parameter must be set to the proper value so that users can be registered with your company

👍

Frictionless Sign-up/Sign-in flow:

Check our documentation on the Frictionless Sign-up & Sign-in flow for the optimal onboarding user experience.