Buy bitcoin widget modification options

Modify widget to your needs for example by showing only specific offer, certain payment methods and even send bitcoins to your provided bitcoin address after a successful purchase.

  • Set prefilled BTC or fiat amount (scroll below for options)
  • Show offers from specific payment method
  • Show offers from specific payment method group
  • Show only specific offer
  • After trade was completed send bitcoins to your provided external address. Great use-case is for websites where user needs to top up their bitcoin balance
During testing different parameters you may see that you are always redirected to same widget step. This is because Paxful widget saves the existing state of buying process and in cases where bitcoin buyer accidently closes widget by re-opening same step is shown where he left.
To see correctly, go back to first step and then open your link with new parameters.
Old user states are deleted in 24 hours.

Parameter name Value type Constraints Example Notes
affiliate string required ‘yAZ3Y3XkbEN’
widget string optional ‘8jdMLQ2mYWy’
fiat_currency string optional ‘EUR’ ISO code
fiat_amount float optional 10.50
crypto_amount_btc float optional 1.05
is_exact_amount string optional ‘yes’ Missing or any other value than ‘yes‘ means false. Needed when exact bitcoin amount is required. Check below for possible combinations of fiat_amount and crypto_amount_btc
track_id string optional ‘1234567’ Required to use callbacks
payment_method_group string optional ‘online-transfers’ Available options: ‘gift-cards‘, ‘cash-deposits‘, ‘online-transfers‘, ‘debitcredit-cards‘
payment_method string optional ‘paypal’ Slug of payment method. Overrides payment_method_group parameter.
offer string optional ‘xAGeEWnvmV4’ Overrides payment_method_group and payment_method
ext_crypto_address string optional ‘1MnWENVYf1VqKetc4zcuUuMNMg2XPrCWPr’ If filled bitcoins will be sent automatically to this bitcoin address after trade is completed. apiseal parameter is required

When you are passing fiat_amount or crypto_amount_btc combinations the results are following

  • fiat_amount=100&crypto_amount_btc=2 – fiat amount is taken
  • fiat_amount=100&crypto_amount_btc=2&is_exact_amount=yes – crypto amount is taken
  • fiat_amount=100&is_exact_amount=yes – error
  • crypto_amount_btc=2 – error
  • fiat_amount=100 – fiat amount is taken

This was developed for cases when fiat amount is passed meaning that offers with various bitcoin amounts are shown (vendors set their own margins). But when user needs exactly 1 bitcoin, ‘is_exact_amount’ needs to be added so the offers with various fiat amounts will be shown. Buying 1 BTC costs less when buying with cash deposits (Western Union, Moneygram, and others) compared to gift cards (Amazon, Target, and others).

 

Callbacks

The Kiosk can be configured to provide callbacks to an outside address on user registration and on a successful trade.

Configuration can be set up on your Kiosk dashboard, under Customize your Kiosk link > Customize your callbacks links. Callbacks can be configured using POST requests only.

First, you have can test your POST request using the Test integration button in Callback Customization Panel. For test it’s enough ti make POST request and not send anything yet, but we expect the code 200/500 to make sure your URL is accessible.

To make integration work, you need to provide the following parameters:

  • track_id
  • status
  • fiat_amount
  • fiat_currency
  • crypto_amount
  • crypto_currency