# Funds Withdrawal
### Authentication
A separate API key must be used for authentication. It can be generated in the «Security» section in your account settings. The key is displayed only once, so make sure to store it in a secure place and do not disclose it.
### What the method allows you to do
* Creates a withdrawal request in the specified currency.
* Minimum interval between requests — 12 seconds.
### Endpoint
`POST` `https://api.cryptocloud.plus/v2/invoice/api/out/create`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | ------------------------------------------------------------ |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | API key from the «Security» section in your account settings |
### Request Body
Key parameters
| Name | Type | Example | Description |
| ------------------------------------------------ | ------ | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| currency\_code\* | string | ETH | Currency code:
BTC, LTC, TRX, SOL, TON, BNB, ETH, ETH\_ARB, ETH\_BASE, ETH\_OPT, USDT\_ARB, USDT\_BSC, USDT\_ERC20, USDT\_OPT, USDT\_SOL, USDT\_TON, USDT\_TRC20, USDC\_ARB, USDC\_BASE, USDC\_BSC, USDC\_ERC20, USDC\_OPT, USDC\_SOL, DAI\_ARB, DAI\_BASE, DAI\_BSC, DAI\_ERC20, DAI\_OPT, USDD\_TRC20, PYUSD\_ERC20, PYUSD\_SOL, XAUT\_ERC20, XAUT\_TON, ARB\_ARB, OP\_OPT, PEPE\_BSC, PEPE\_ERC20, SHIB\_BSC, SHIB\_ERC20, TRUMP\_SOL
|
| to\_address\* | string | 0x396343<...>210945346fb82Aa49 | Recipient's wallet address |
| amount\* | float | 0.003 | Withdrawal request amount in the specified currency |
### Request examples
These examples show how to create a withdrawal request.
{% tabs %}
{% tab title="cURL" %}
```bash
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
}'
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
from typing import Optional
class PayoutAPIClient:
def __init__(self, api_key: str):
self.api_key = api_key
self.base_url = 'https://api.cryptocloud.plus'
self.headers = {
'Authorization': f'Token {self.api_key}',
'Content-Type': 'application/json'
}
def create_payout(self, currency_code: str, to_address: str, amount: float) -> dict:
"""
Creates a withdrawal request.
:param currency_code: Currency code (e.g. “BTC”, “ETH”, “USDT”, “LTC”).
:param to_address: Recipient's address.
:param amount: Amount to send.
:return: API response in dict format.
"""
url = f"{self.base_url}/v2/invoice/api/out/create"
payload = {
"currency_code": currency_code,
"to_address": to_address,
"amount": amount
}
response = requests.post(url, json=payload, headers=self.headers)
if response.status_code == 200:
return response.json()
else:
raise PayoutAPIError(response.status_code, response.json())
class PayoutAPIError(Exception):
def __init__(self, status_code: int, error_data: Optional[dict] = None):
self.status_code = status_code
self.error_data = error_data or {}
message = f"API Request failed with status {status_code}: {self.error_data}"
super().__init__(message)
# Example of use:
if __name__ == "__main__":
# Client Configuration
api_key = ""
client = PayoutAPIClient(api_key)
try:
result = client.create_payout(
currency_code="BTC",
to_address="",
amount=0.00023
)
print("Success:", result)
except PayoutAPIError as e:
print("Error occurred:", e)
```
{% endtab %}
{% tab title="JavaScript " %}
{% code title="Axios.js:" %}
```javascript
/**
* Custom error for handling payout API response failures.
*/
class PayoutAPIError extends Error {
/**
* @param {number} statusCode - HTTP status code returned by the API.
* @param {object} [errorData={}] - Error details returned by the API.
*/
constructor(statusCode, errorData = {}) {
super(`API Request failed with status ${statusCode}: ${JSON.stringify(errorData)}`);
this.name = 'PayoutAPIError';
this.statusCode = statusCode;
this.errorData = errorData;
}
}
/**
* Client for interacting with CryptoCloud Payout API.
*/
class PayoutAPIClient {
/**
* @param {string} apiKey - API token used for authentication.
*/
constructor(apiKey) {
this.apiKey = apiKey;
this.baseUrl = 'https://api.cryptocloud.plus';
this.headers = {
'Authorization': `Token ${this.apiKey}`,
'Content-Type': 'application/json'
};
}
/**
* Creates a payout request.
*
* @param {string} currencyCode - Currency code (e.g., "BTC", "ETH", "USDT", "LTC").
* @param {string} toAddress - Recipient address.
* @param {number} amount - Amount to send.
* @returns {Promise} - API response data.
* @throws {PayoutAPIError} - On failed request.
*/
async createPayout(currencyCode, toAddress, amount) {
const url = `${this.baseUrl}/v2/invoice/api/out/create`;
const payload = {
currency_code: currencyCode,
to_address: toAddress,
amount: amount
};
try {
const response = await axios.post(url, payload, {
headers: this.headers
});
return response.data;
} catch (error) {
const status = error.response?.status || 500;
const data = error.response?.data || {};
throw new PayoutAPIError(status, data);
}
}
}
// Example usage with Axios
(async () => {
const client = new PayoutAPIClient('');
try {
const result = await client.createPayout("BTC", "", 0.00023);
console.log("Success:", result);
} catch (error) {
console.error("Error occurred:", error);
}
})();
```
{% endcode %}
{% code title="Fetch.js:" %}
```javascript
const apiKey = '';
const payload = {
currency_code: 'BTC',
to_address: '',
amount: 0.00023
};
fetch('https://api.cryptocloud.plus/v2/invoice/api/out/create', {
method: 'POST',
headers: {
'Authorization': `Token ${apiKey}`,
'Content-Type': 'application/json'
},
body: JSON.stringify(payload)
})
.then(response => {
if (!response.ok) throw new Error(`HTTP error ${response.status}`);
return response.json();
})
.then(data => console.log('Success:', data))
.catch(err => console.error('Error:', err));
```
{% endcode %}
{% code title="Ajax.js:" %}
```javascript
const apiKey = '';
const xhr = new XMLHttpRequest();
xhr.open("POST", "https://api.cryptocloud.plus/v2/invoice/api/out/create");
xhr.setRequestHeader("Authorization", `Token ${apiKey}`);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onload = function () {
if (xhr.status === 200) {
console.log("Success:", JSON.parse(xhr.responseText));
} else {
console.error("Error:", xhr.status, xhr.responseText);
}
};
const payload = {
currency_code: 'BTC',
to_address: '',
amount: 0.00023
};
xhr.send(JSON.stringify(payload));
```
{% endcode %}
{% endtab %}
{% tab title="PHP" %}
<?php
/**
* Class PayoutAPIError
*
* Custom exception for API errors.
*/
class PayoutAPIError extends Exception
{
public int $statusCode;
public array $errorData;
/**
* PayoutAPIError constructor.
*
* @param int $statusCode
* @param array $errorData
*/
public function __construct(int $statusCode, array $errorData = [])
{
$this->statusCode = $statusCode;
$this->errorData = $errorData;
$message = "API Request failed with status $statusCode: " . json_encode($errorData);
parent::__construct($message, $statusCode);
}
}
/**
* Class PayoutAPIClient
*
* Client for creating crypto payouts via CryptoCloud API.
*/
class PayoutAPIClient
{
private string $apiKey;
private string $baseUrl;
private array $headers;
/**
* PayoutAPIClient constructor.
*
* @param string $apiKey
*/
public function __construct(string $apiKey)
{
$this->apiKey = $apiKey;
$this->baseUrl = 'https://api.cryptocloud.plus';
$this->headers = [
'Authorization: Token ' . $this->apiKey,
'Content-Type: application/json'
];
}
/**
* Create payout request.
*
* @param string $currencyCode Currency code (e.g., BTC, ETH).
* @param string $toAddress Recipient address.
* @param float $amount Amount to send.
* @return array Response from API.
* @throws PayoutAPIError On API failure.
*/
public function createPayout(string $currencyCode, string $toAddress, float $amount): array
{
$url = $this->baseUrl . '/v2/invoice/api/out/create';
$payload = json_encode([
'currency_code' => $currencyCode,
'to_address' => $toAddress,
'amount' => $amount,
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, $this->headers);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$decoded = json_decode($response, true);
curl_close($ch);
if ($httpCode === 200) {
return $decoded;
} else {
throw new PayoutAPIError($httpCode, $decoded ?? []);
}
}
}
// Example usage
try {
$client = new PayoutAPIClient('<your_api_key_here>');
$response = $client->createPayout('BTC', '<recipient_address>', 0.00023);
echo "Success:\n";
print_r($response);
} catch (PayoutAPIError $e) {
echo "Error occurred:\n" . $e->getMessage();
}
Name Type Example Description invoice_id string INV-89UX09KA Unique withdrawal request identifier with the INV prefix status string created Withdrawal request status — always created when the request is submitted currency string ETH Code of the selected cryptocurrency in the withdrawal request amount float 0.0029 Withdrawal request amount in cryptocurrency