Funds Withdrawal

Detailed description of the request to create a withdrawal request.

In order to create a withdrawal request, you need to send a POST request.

For authentication you need to use a separate API KEY. It can be generated in the «Security» section of your account settings. The key is displayed once, so be sure to keep it in a safe place and prevent its disclosure.

Creation of a withdrawal request

POST https://api.cryptocloud.plus/v2/invoice/api/out/create

Headers

Name
Type
Description

Authorization*

String

Token <API KEY>

Request Body

Name
Type
Description

currency_code*

String

Currency code: BTC, LTC, TRX, USDT_TRC20, USDD_TRC20 , ETH, USDT_ERC20, USDC_ERC20, TUSD_ERC20, SHIB_ERC20, ETH_ARB, USDT_ARB, USDC_ARB, ETH_OPT, USDT_OPT, USDC_OPT, ETH_BASE, USDC_BASE, BNB, USDT_BSC, USDC_BSC, TUSD_BSC, TON, USDT_TON, SOL, USDT_SOL, USDC_SOL

to_address*

String

Recipient's wallet address

amount*

Int

Withdrawal request amount in the specified currency

{
	"status": "success",
	"data": {
		"invoice_id": "INV-XXXXXXXX",
		"status": "created",
		"currency": "BTC",
		"amount": 0.05
	}
}

Parameter description

Parameter name
Data type
Values
Example

currency_code*

String

BTC, LTC, TRX, USDT_TRC20, USDD_TRC20 , ETH, USDT_ERC20, USDC_ERC20, TUSD_ERC20, SHIB_ERC20, ETH_ARB, USDT_ARB, USDC_ARB, ETH_OPT, USDT_OPT, USDC_OPT, ETH_BASE, USDC_BASE, BNB, USDT_BSC, USDC_BSC, TUSD_BSC, TON, USDT_TON, SOL, USDT_SOL, USDC_SOL

BTC

to_address*

String

Recipient's address

1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

amount*

Int

Withdrawal request amount

0.05

Description of response parameters

A successful request receives a response with a success status and a data object.

  • invoice_id — unique identifier of the withdrawal request with the prefix INV.

  • status — withdrawal request status, when sending a request is always equal to created.

  • currency — code of the selected cryptocurrency in the request.

  • amount — the amount of the withdrawal request in cryptocurrency.

Example request

These examples show how you can submit a request to create a withdrawal request. Note that you need to provide your API key from the «Security» section in the Authorization header to successfully authorize the request.

curl -X POST \
  https://api.cryptocloud.plus/v2/invoice/api/out/create \
  -H 'Authorization: Token YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency_code": "BTC",
    "to_address": "YOUR_RECIPIENT_ADDRESS",
    "amount": 0.00023
  }'

Last updated

Was this helpful?