Skip to main content

OnrampRequest

amountFrom object

Source amount to convert from (optional)

oneOf
null
amountTo object

Destination amount to receive (optional)

oneOf
null
cryptoAddressstringrequired

Cryptocurrency wallet address

Possible values: <= 2147483647 characters

currencyFrom object
oneOf
null
currencyTo object
oneOf
null
failureReturnUrl object

URL to redirect on failed transaction

oneOf
null
locale object

Locale for widget UI (defaults to 'en')

oneOf
null
networkCryptoTransferNetworkId (string)required

Blockchain network (e.g. ERC20, BEP20, POLYGON, SOLANA)

Possible values: [ERC20, TRC20, BEP20, POLYGON, ARBITRUM, BASE, CARDANO, TEZOS, BTC_LEGACY, BTC_SEGWIT, HAQQ, SOLANA, TON]

successReturnUrl object

URL to redirect on successful transaction

oneOf
null
OnrampRequest
{
"amountFrom": "null",
"amountTo": "null",
"cryptoAddress": "string",
"currencyFrom": "null",
"currencyTo": "null",
"failureReturnUrl": "null",
"locale": "null",
"network": "ERC20",
"successReturnUrl": "null"
}