Widget Parameters
hen using the Bridge widget, you can pass in the following parameters to reduce user input, which will simplify the user's operation proces.
Example of how to pass the required details can be found on the previous page.
Here we will explain what each input field is for and how the function for each currencies:
Parameter | Onramp Request | Offramp Request |
---|---|---|
key | Public Key of the business which can be gottten from their bridge dashbaord. *required. | Public Key of the business which can be gottten from their bridge dashbaord. *required |
type | constant: "buy" | constant: "sell". |
amount | Amount in (USD or in NGN) that the users wishes to onramp to get asset (USDC). *required. | Amount in (USDC) that the users wishes to onramp to get fiat (USD or NGN). *required. |
network | wallet_address network to recieve asset. We presently support 4 networks: (polygon, solana, stellar, and avalanche) | Not Required |
wallet_address | User's Wallet address of receive asset based on netowrk selected | Not Required |
currency | Currency in which users wants to pay for asset. Right now we support 2 payment currencies; (NGN & USD). *required | Currency in which users wants to offramp to fiat. Right now we support 2 payment currencies; (NGN & USD). *required. |
Updated 4 months ago