Widget (iFrame)

By implementing a widget, you will be able to embed the Banxa site in an iFrame and allow customers to complete the checkout process within this iFrame. This can be done using a code snippet that Banxa will provide to you in the Create Order response.

Note. the iFrame cannot be used in Safari as Safari does not allow third party cookies that the iFrame requires.

👍

Use these instructions if you are implementing the Banxa API. If you are implementing the Referral Method, see here.

Before you begin

  • Provide your Account Manager with the domain of the specific site page that you will be using to host the Banxa iFrame. This must include the full domain including any subdomain that you are using. This may be for your test and your production environments. We will then whitelist these domains so that the iFrame can be successfully initiated on our site.

Steps

  1. Call the Create Order API, and include the iframe_domain parameter in the body of the request. The iframe_domain should be the exact domain that you will be using to host the iFrame e.g. [yourCompany].com, as our CSP headers will allow this frame-ancestor to be using Banxa checkout in an Iframe element. Do not include https:// in front of the domain.

  2. The checkout_iframe value that is returned in the Create Order response will be the checkout URL that can be used within the iFrame element on your site, because of the domain you have provided us in "Before you begin".