API - Bitvolo Web Services



Use this method instead of our standard UI integration in order to create a new pending transaction in Bitvolo. The transaction price can be specified in a cryptocurrency or in a fiat currency in which case it's converted to the cryptocurrency and the amount to be sent is returned by this method.


reference_number string required
Unique reference number of ID from your system used to identify the transaction (up to 64 characters: alphanumeric, dash, underscore). This is often your order number.
coin string required
Coin / cryptocurrency (e.g. IOTA / XLM / XRP / ETH / ADA / EOS / BANK). For Stellar network tokens use Stellar/xxx e.g. Stellar/MOBI. For EOS network tokens use EOS/xxx e.g. EOS/PEOS. For ETH network tokens use ETH/xxx
requested_currency string required
Currency or cryptocurrency in which the price is requested (e.g. USD/EUR/IOTA)
requested_amount float required
Total amount requested (in requested_currency)
ipn_url string optional
URL of the IPN callback script on your server to be called upon confirmation
custom_field string optional
Custom field (max 64 characters)
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.


transaction_id string
Transaction ID. You should ask your customer to use this ID in the tag or message field in order to identify the transaction
qr_code string
URL of the QR code for the payment to be made which you can present to your customer
total_amount float
Amount to be sent (in selected coin)
destination_address string
The destination address where the payment must be sent
destination_tag int
Destination tag for XRP transactions. Note that for all coins other than XRP, this is not returned and the transaction_id field must be used for this purpose (see above)

API playground:

Click here to test this function in the API playground.