Configure the On-Ramp URL

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.

address

No

Enter the destination wallet address for the cryptocurrency purchase. If provided, this address will be pre-filled and locked - customers won't need to enter their own wallet address. Otherwise, customers will be prompted to provide a wallet address during checkout. Passing an address makes cryptoAsset and network required.

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

No

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