Partner Dashboard User Guide

Creating New Roles and Assigning Permissions

When first gaining access to the Partner Dashboard, you will be able to add additional users from your company to the dashboard, however the primary account holder will first need to create roles and permissions before creating new users.

  1. Navigate to your Profile page from the top right hand corner drop down menu.
  2. Select the "Create New Role" button. An input form will appear and you can name the Role you want to create, for example "Developer", "Customer Office" or "Admin".
  1. Now that you have created a new Role, you will find it displayed on the page, and you will now be able to add Permissions to the Role. All permissions are set at the page level. For example, if a user has no access to "Read" the "Dashboard" permission, then the user will not be able to view the "Dashboard" page.
  1. After you have finished selecting the Permissions for the Role, you can click "Save".

Creating New Users and Assigning Roles

  1. Select the "Create New User" button.
  2. Enter the user's Name, Email Address (this email will be used to send a registration link) and Role.
  1. Click on "Submit". After you have done this, a registration email will be sent to the user, providing them with instructions on how to set up their account on your Partner Dashboard. When they log in, they will have the Permissions that have have assigned to them.

Available Configurations

πŸ•™

Saving Configurations

All configurations will take around 15 minutes to take effect on the live Banxa Checkout.

πŸ‘

Environment toggle

You can use the environment toggle at the top of your dashboard to switch between Sandbox and Production settings.

Disable WalletConnect and MetaMask Connection

This configuration will allows your users to connect their wallet's directly on Banxa Checkout using a MetaMask or Wallet Connect button.

Display User's Wallet Address and Memo

This configuration will make the user's wallet address and memo/tag (if passed in the API or link) be displayed when the user is redirected to Banxa. If this configuration is set to false, then the user's wallet address and memo/tag will be hidden.

Order Form with a Wallet Address

Order Form with a Wallet Address

Order Form without a Wallet Address

Order Form without a Wallet Address

Set the Default Cryptocurrency

This is the default cryptocurrency for all your users when they are redirected to Banxa Checkout.

Coins and Blockchains

This configuration will allow you to set what cryptocurrencies and blockchains are available for your users to select from. By default, all options will be available until they are de-selected. Please note that native tokens for a blockchain cannot be de-selected.

Cryptocurrency Selector

Cryptocurrency Selector

Upload Logo

This is the logo that will be displayed on the Banxa Checkout screens on all pages of the checkout flow. This image must be uploaded with a maximum of 70 pixels height. In this example, the Binance logo has been uploaded.

Order Form with Binance Logo

Order Form with Binance Logo

Primary Color

This will be your brand color that will be used for the buttons, highlighted texts and checkboxes.

Order Form with Binance Brand Colour

Order Form with Binance Brand Color

Secondary Color

This is the the color used when button hover over effects.

Theme

This configuration will allow selection between Dark and Light mode. Please note that if the user changes the theme from their browser, then this will override the default selected by you.

Example light mode

Example dark mode

Order Form with Binance Logo

Order Form with Binance Logo

Your Webhook URL

If you would like to receive webhooks for all status changes on your orders, you may put your webhook URL here and we will send your webhooks to that URL. You can put in different webhook URL's for your sandbox and production environments.

For more information on how to implement webhooks, please find the documentation here: https://docs.banxa.com/docs/webhooks

Enable HMAC Encrypted Webhook

If you enable this configuration, then Banxa will encrypt all webhooks that we send to you using HMAC authentication. This will provide extra security from bad actors who might send webhooks to your address.

For more information on how to implement HMAC encrypted webhooks, please find the documentation here: https://docs.banxa.com/docs/webhooks

Your NFT Webhook URL

Use this webhook if you are using NFT checkout. This is your webhook URL notify you to perform the fulfilment of the NFT to the customer’s address.

Send Webhook

After you have saved a Webhook URL, you may test the webhook by clicking on the Send button. We will send a webhook to the URL that you have set and the results will be displayed on the screen.

Return URL

This is the callback URL that will be used to return your user back to your application after they have completed the Banxa Checkout flow. If you are already passing this parameter in the API i.e. return_url_on_success then that will take precedence.

Order Summary Page with a Return button back to the Binance app

Order Summary Page with a Return button back to the Binance app

Dynamic callback URL variables

If you have set a Return URL, then this configuration will allow you to indicate if you want any order related parameters that can be appended to that Return URL. e.g. https://yourCompanyName/?orderId={509427}&fiat={AUD}&fiatAmount={0}&coin={BTC}&coinAmount={0}&orderRef={12a320b36117089a9e94b3e8acd4cf5d}&orderStatus={Expired}&fulfillmentStatus={Pending}&paymentStatus={Expired}&identityStatus={Complete}

This configurations provides the opportunity for you to know order details after the user has submitted their order, and to deep link your customer to specific pages on your application.

Orders

This page is where you can go to view the live status of orders and is designed to support you support your customers. You will be able to search orders by wallet address or the short form customer ID, search results will be displayed and you will be able to click into any order to view detailed order statuses.

πŸ“˜

Environment toggle

You can use the environment toggle at the top of your dashboard to switch between Sandbox and Production orders.