Create Deposit Request

View as Markdown

This method allows you to create a new Deposit link.

Notes:

  • Enables multiple payments and can serve as a static deposit link for your platform.

Method: GET

Path: https://api.blockbee.io/deposit/request/

Parameters

Query Parameters

apikeystring•Required

API Key provided by BlockBee's Dashboard. Unsure how to get yours? Check this tutorial.

Note: The API key can also be sent as a header named apikey.

notify_urlstring•Required

URL where our system will send a payment notification (IPN), when a deposit is made.

Notes:

  • We advise you to URL Encode the notify URL, otherwise the GET parameters you add may be lost
  • GET parameters you add to the notify URL will be sent as GET, even if you enable the post parameter
  • For a complete list of fields sent by our system, please refer to our webhook documentation
  • To prevent repeated IPNs to your systems, the response to the IPN request should be *ok* in plain text
Example:https://example.com/callback/?user_id=1124

currencystring

Set the FIAT currency used in the value parameter.

Note: Will override the FIAT currency set in your Payment Settings at BlockBee's Dashboard.

Supported FIAT currencies:

  • (USD) United States Dollar
  • (EUR) Euro
  • (GBP) Great Britain Pound
  • (CAD) Canadian Dollar
  • (JPY) Japanese Yen
  • (AED) UAE Dollar
  • (MYR) Malaysian Ringgit
  • (IDR) Indonesian Rupiah
  • (THB) Thai Baht
  • (CHF) Swiss Franc
  • (SGD) Singapore Dollar
  • (RUB) Russian Ruble
  • (ZAR) South African Rand
  • (TRY) Turkish Lira
  • (LKR) Sri Lankan Rupee
  • (RON) Romanian Leu
  • (BGN) Bulgarian Lev
  • (HUF) Hungarian Forint
  • (CZK) Czech Koruna
  • (PHP) Philippine Peso
  • (PLN) Poland Zloti
  • (UGX) Uganda Shillings
  • (MXN) Mexican Peso
  • (INR) Indian Rupee
  • (HKD) Hong Kong Dollar
  • (CNY) Chinese Yuan
  • (BRL) Brazilian Real
  • (DKK) Danish Krone
  • (TWD) New Taiwan Dollar
  • (AUD) Australian Dollar
  • (NGN) Nigerian Naira
  • (SEK) Swedish Krona
  • (NOK) Norwegian Krone
  • (UAH) Ukrainian Hryvnia
  • (VND) Vietnamese Dong

Supported cryptocurrencies (for conversion):

  • (BTC) Bitcoin
  • (ETH) Ethereum
  • (USDT) Tether USDt
  • (USDC) USD Coin
  • (SOL) Solana

...and many more listed on our cryptocurrencies page (eg: currency=btc).

Example:eur

item_descriptionstring

Description of the product or service being paid. This information will appear on the Checkout page.

Example:Deposit #123

postnumber

Set this to 1 if you wish to receive the IPN as a POST request. If set to 0, API will default to GET.

Notes:

  • GET parameters you added to the notify_url URL will still be sent as GET
Example:1

suggested_valuenumber

Set this field if you'd like to suggest a specific amount in the deposit link. Must be a number higher than 0.

Notes:

  • If disabled, the deposit link will display the minimum transaction amount instead
  • This is a suggested value only. Transactions will still be processed if the customer sends less (or more) than the suggested amount, provided it meets our minimum transaction requirements
Example:10

Returns

Returns the deposit link response. Returns an error if there's there's a missing required parameter of if you didn't configure the payment settings correctly.

statusstring

Status of the request. Should be success if the request didn't fail.

payment_urlstring

Payment URL where your customer should be redirected to initiate the transaction.

Note: It's possible to pre-select a cryptocurrency for the checkout page by using the coin GET parameter.

  • All of our supported tickers can be found at our cryptocurrencies page. Please replace the / with a _.
  • Example: In order to pre-select Bitcoin for the payment, append ?coin=trc20_usdt to the payment_url as the following example: https://pay.blockbee.io/deposit/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N?coin=trc20_usdt.

payment_idstring

ID of the deposit. May be used with the logs endpoint.