Configure the Off-Ramp URL

The following parameters can be used to customize the user journey in the widget.

Off-Ramp URL parameters: Copied!

Parameter

Required

Description

publicKey

Yes

Specify the Business PublicKey to recognize that a transaction is referred by a specific business' application.

side

Yes

Specify whether the customer intends to buy or sell

cryptoAsset

No

Specify the cryptocurrency asset (e.g., BTC, ETH, MATIC) for the customer's purchase. The customer must use the specified cryptocurrency - no substitutions are allowed.

network

No

Specify the cryptocurrency network (e.g., ERC20, POLYGON) for the customer's purchase. The customer must use the specified network - no substitutions are allowed.

fiatCurrency

No

Specify the cryptocurrency asset (e.g., NGN, KES) for the customer's purchase. When passed, the customer must use the specified fiat currency - no substitutions are allowed.

cryptoAmount

No

Specify the crypto amount to be processed.

fiatAmount

No

Specify the fiat amount to be processed. If passed, cryptoAmount is ignored.

redirectUrl

Yes

URL to redirect the user to when they to complete a sell transaction.

Sample URL configuration:Copied!

https://sandbox.sell.busha.co/?publicKey=PublicKey&cryptoAsset=ETH&network=ETH
&fiatCurrency=NGN&cryptoAmount=0.005345&redirectUrl=https://www.partner.com