> For the complete documentation index, see [llms.txt](https://manual-en.boxexchanger.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual-en.boxexchanger.net/exchange-done/merchant-i-api/birzha-whitebit/vyplaty-whitebit.md).

# Whitebit payouts

## Supported currencies

* Bank cards: EUR, USD, KTZ, UAH (temporarily unavailable) 
* Cryptocurrencies: BTC, ETH, LTC, USDT....

## Module installation

Using the parameters below, install the payout module via the ‘Install plugin’ functionality as instructed . [Install plugin / DONE](/additional-systems-done/install-plugin.md).

<details>

<summary>Install Plugin Parameters</summary>

**Plugin type**: <mark style="color:orange;">**`Payout module`**</mark>

**Plugin URL**: <mark style="color:orange;">**`@boxexchanger-plugins/payout-whitebit`**</mark>

**Directory path**: <mark style="color:orange;">**`whitebit`**</mark>

**Auth: (Deploy token)**: leave blank

**Package tag**: <mark style="color:orange;">**`latest`**</mark>

</details>

## Registration and preparation of a whitebit account

{% hint style="success" %}
In case you are not yet registered on whitebit - Register on the exchange - go through identity verification - enable 2FA.
{% endhint %}

### Creating an API key for whitebit payout

{% hint style="warning" %}
Make sure you have 2FA enabled for your whitebit account. Otherwise you will not be able to create an API key.
{% endhint %}

1. Go to account settings - ‘API’ section - API keys - click ‘Edit’ in the ‘API keys’ block (or click here for a quick access to this page) - then ‘Generate API key’ - enter 2FA.&#x20;
2. Copy the Key (public) and Secret Key to a safe place (the data will be needed to configure the module in the admin panel).
3. Enter key name - activate endpoints (see list below) - click ‘Confirm’ - enter 2FA.

<details>

<summary>Endpoints for the payout module</summary>

**Section ‘Withdrawal'**\
`/api/v4/main-account/withdraw`\
`/api/v4/main-account/withdraw-pay`

**Section ‘Transfer between balances’**\
`/api/v4/main-account/transfer`

**Balance and Wallet History section**\
`/api/v4/main-account/balance`\
`/api/v4/main-account/history`\
`/api/v4/main-account/fee`

**Section ‘Trading balance and order history’**\
`/api/v1/account/balance`

**Section ‘Order Management’**

`/api/v4/order/market`\
`/api/v4/order/stock_market`

</details>

4. On the ‘API Keys’ page, click ‘IP Access’ - then move the slider to the active position - enter the v4 IP address (also IPv6 if available. IPv6 may not be available then it can be skipped and insert only IPv4) back-end server - click ‘Add’ - enter 2FA.

{% hint style="info" %}
IP address of v4 and v6 format can be found out In the admin panel on the settings page of the whitebit payment module.&#x20;

To do this, go to the page ‘Merchant and API’ - section ‘PAYOUT SYSTEM’ - settings (settings icon) in the block with the merchant ‘WhiteBit Exchanger’ - at the bottom of the page ‘PUBLIC IP’ and ‘PUBLIC IPV6’.&#x20;

**In the account Licences - ‘Back-end server’ field.**
{% endhint %}

{% hint style="danger" %}
Please note that your API key will be automatically deactivated by whitebit if there is no API activity for 14 days. It can be reactivated on the API Keys page.
{% endhint %}

## Configuration of payment module in admin panel

### Main settings

1. In the admin panel, navigate to the payout module settings for WhiteBit.\
   To do this, go to the **"Merchant and API"** page, then the **"PAYOUT SYSTEM"** section, and click the settings icon in the "WhiteBit Exchanger" block.
2. In "**API Secret**" field:
   * Paste the previously copied Secret Key into the **"API Secret"** field and click **"Save"**.
   * After the page reloads, the API Secret will be hidden and will no longer be displayed in the admin panel for security reasons.
3. Paste the previously copied Public Key into the **"API Key"** field and click **"Save"**."[**Save**](#user-content-fn-1)[^1]".
4. [**Withdraw method**](#user-content-fn-2)[^2] - selection of withdrawal features.\
   \- **/api/v4/main-account/withdraw** - The withdrawal fee will be deducted from the final amount received by the client (**not recommended**).\
   \- **/api/v4/main-account/withdraw-pay** - The withdrawal fee will be deducted from your balance, and the client will receive the full amount specified in the request (**recommended**).
5. You can configure the "[**Withdraw from**](#user-content-fn-3)[^3]" functionality. The choice of parameter will determine how funds are acquired for withdrawal to the client based on their request.

{% hint style="info" %}
**DIRECT** - direct withdrawal of currency without exchange. For example, if you need to withdraw BTC, you should have BTC reserve on your whitebit balance. For LTC - LTC reserve on the balance, etc.

**USDT/USDC/EUR/BTC/ETH** - use the specified currency to receive the currency that the client should receive on the request. For example, a client needs to receive DOGE, and ‘USDT’ is selected for the ‘Withdraw from’ field - in this case you should have USDT reserve on your balance, for which the required amount of DOGE will be purchased in the DOGE/USDT pair.\
Usually ‘**USDT**’ is selected.
{% endhint %}

{% hint style="warning" %}
Also note that the currency to which the auto-conversion will be performed **(‘Convert to’ in the Merchant settings) and the currency from which the payment will be made (‘Withdraw from’ in the payment module settings) must match in order to automate the process.**
{% endhint %}

{% hint style="info" %}
Please note that in Currency/USDT pairs we will use buy stock market order, i.e. we will place an order to buy the exact amount of Currency to be withdrawn by the client + commission for withdrawal of Currency. That is, in such pairs, we consider that Currency is stock and USDT is money—for example, BTC (stock) / USDT (money).&#x20;

However, in USDT/Currency pairs, a regular sell market order will be used. This means that a USDT sell order will be placed + 0.3% slippage on the glass (as we cannot know the exact average purchase price) + Currency withdrawal fee. For example, USDT (stock) / EUR (money).
{% endhint %}

### Additional settings

* [**Fee method**](#user-content-fn-4)[^4] - If you have personalized fees on WhiteBit, set the parameter to "Private." By default, it is set to "Public," meaning standard fees apply.
* Name and Surname Request Settings for Fiat Currencies (**Type request name surname (for FIAT)**)\
  \- [**Compact**](#user-content-fn-5)[^5] - A compact mode for requesting the name and surname. In this case, the client enters both the name and surname in a single field, making the exchange form more streamlined and user-friendly. However, this mode may complicate the process for clients with double names or surnames.\
  \- [**Full** ](#user-content-fn-6)[^6]- Separate fields for entering the name and surname. This option is suitable if you expect clients with double names and/or require them to input separate fields for "First Name" and "Last Name."
* [**Type request Memo**](#user-content-fn-7)[^7] - This setting specifies how the memo is transmitted and whether the memo field is mandatory:\
  \- **Required from User (default)**: The memo field is mandatory. \
  \- **optional empty** - The memo field is optional. When withdrawing from WhiteBit, no memo will be transmitted.\
  \- **optional with default "12345"** - The memo field is optional. If left empty, the memo "12345" will be transmitted when withdrawing from WhiteB.
* [**Enable debug mode**](#user-content-fn-8)[^8] - Setting the value to "1" enables the transmission of additional logs for developers. This can be helpful for analyzing logs when encountering module issues. Without a pressing need, it is recommended to leave this setting at "0."

## Fiat currencies payout

{% hint style="success" %}
To work with fiat currencies - contact whitebit support with a request to activate the fiat gateway for the required currency.
{% endhint %}

{% hint style="warning" %}
**Attention**! To pay EUR,USD in the settings of these directions - step ‘Display fields’ - be sure to include the default field ‘E-mail’. On the part of whitebit the requirement to request the client to enter an Email address.
{% endhint %}

### Verification

* You can always check verification requirements with whitebit representatives

### Currency Verification

{% hint style="info" %}
To verify the ‘Currency B’ that the exchange service will send to the customer, follow the instructions here: [/pages/npvksqUjoWRlzkJhfzzI#2.-verifikaciya-rekvizitov-vyplata](https://manual-en.boxexchanger.net/exchange-done/merchant-i-api/birzha-whitebit/pages/npvksqUjoWRlzkJhfzzI#2.-verifikaciya-rekvizitov-vyplata "mention")
{% endhint %}

[^1]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-cf31226ab766ca20083daf1d328ffcfef76fd625%2Fimage%20(827).png?alt=media" alt="" data-size="original">

[^2]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-5e495c7ccf68e4ff91873e18c9f6d5f05af3a27a%2Fimage%20(835).png?alt=media" alt="" data-size="original">

[^3]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-cbef63445586c9a7d0517fa2e047029538a5b221%2Fimage%20(828).png?alt=media" alt="" data-size="original">

[^4]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-950f416b0f59ced8957b3f85803a57ead878bca2%2Fimage%20(833).png?alt=media" alt="" data-size="original">

[^5]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-97a16e76f459eafc3996b3fc0f7416edb17ff361%2Fimage%20(829).png?alt=media" alt="" data-size="original">

[^6]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-97a16e76f459eafc3996b3fc0f7416edb17ff361%2Fimage%20(831).png?alt=media" alt="" data-size="original">

[^7]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-8a0600eb6b829f67f64f5d650881903b6bc51148%2Fimage%20(834).png?alt=media" alt="" data-size="original">

[^8]: <img src="https://510499886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYc4e1MOylcSxJb4nS0Eo%2Fuploads%2Fgit-blob-961701bac871477b4e1e58b1bb4bdcec90b4992d%2Fimage%20(818).png?alt=media" alt="" data-size="original">