| Property | Product Type | Description | Type | Required |
|---|---|---|---|---|
| apiKey | BUY,SELL | The Partner API Key | string | Yes |
| mode | BUY,SELL,SWAP | The product modes to enable on the widget | string | Yes |
| fiat | BUY,SELL | The fiatcurrency e.g EUR,USD,INR | string | Yes |
| crypto | BUY,SELL | The cryptocurrency e.g BTC,ETH | string | Yes |
| network | BUY,SELL | The cryptocurrency network e.g bitcoin, ethereum | string | Yes |
| paymentMethod | BUY,SELL | The payment method e.g credit_debit_card, IMPS | string | Yes |
| amount | BUY,SELL | number | Yes | |
| redirectUrl | BUY,SELL,SWAP | string | No | |
| sessionId | BUY,SELL | Used in tracking the same session across multiple devices | string | Yes |
| partnerContext | BUY,SELL | A custom ID that can be passed into the request and also will be available in webhooks | string | No |
Widget Integration
Query Parameters
Supported onramp and offramp parameters.