Optional Customisation

Create seamless experiences specific to your app

All query parameters used in your integration must be URL-encoded to ensure they work correctly. For example use satoshi%40blockchain.com for email addresses.

Optional Query Parameters



The cryptocurrency your customer will buy. Setting this parameter means the user will not be able to specify a different currency to purchase. Specify as the ticker symbol, for example BTC, ETH, USDT, etc. (Coming soon) Support for layer-2 networks.


The default wallet address of where the customer will receive their purchased tokens. If specified, the customer won't need to fill in their wallet address. You must specify baseCurrency and walletAddressSignature when specifying walletAddress.


Ensures that walletAddress value was not altered en-route to us. Must be used when using the walletAddress parameter. See Query parameter signing for how to generate the signature.


(Coming soon)

The secondary cryptocurrency wallet address identifier/memo for coins such as XLM and XRP. This parameter will be skipped if walletAddress, walletAddressSignature or baseCurrency are not passed.


The currency your customer will use to buy their desired cryptocurrency. We currently support US Dollars, Pound Sterling and Euros, specified as USD, GBP, or EUR. (Coming soon) Support for more fiat currencies.


The default amount of fiat used to buy cryptocurrency. Users will be able to change this value. We recommend using this parameter together with quoteCurrency.


(Coming soon)

The email address of the user. When used, the user won't need to specify their email address with us, they will skip the email entry screen and will be prompted directly for their one-time passcode. Make sure to URL-encode the email you pass. For example use satoshi%40blockchain.com instead of satoshi@blockchain.com. (Coming soon) as part of v1 release.


A reference you assign to this order. We will include this identifier when sending you order related information. Useful to relate order records from us to those in your internal systems. It is limited to 100 characters.


A reference of a 3rd party that is involved in the processing flow. We will use this information for internal metrics. It is limited to 50 characters.


(Coming soon)

The default payment method for the order. We currently support credit and debit card payments, specified as CARD. (Coming soon) Many more payment methods including mobile wallets (Apple Pay and Google Pay), ACH bank transfer, GBP and EUR bank transfers, GBP and EUR Open Banking.


A URL to which customer will be able to proceed after completing the buy flow.

The URL can include your own custom parameters. You must specify redirectUrlSignature when specifying walletAddress.


Ensures that redirectUrl value was not altered en-route to us. Must be used when using the redirectUrl parameter. See Query parameter signing for how to generate the signature.

Last updated