# Payout system

In this subsection, you can set up and manage supported withdrawal methods.

## Payout methods

On this page, you can view a list of configured withdrawal methods and create new ones.

### General information

The following information is provided about each withdrawal method:

**Priority**

The priority index assigned to the withdrawal method.

The order in which withdrawal methods are displayed to clients in the B2CORE UI depends on priority indexes assigned to methods. A lower index means a higher priority. For example, a method with the index `1` will appear at the top of the list in the B2CORE UI.

The priority index can be changed on the [Settings tab](#settings-tab) in the method details.

***

**Caption**

The name assigned to the method in the Back Office, which is also visible to clients in the B2CORE UI.

***

**Name**

The unique name for the method. It can only contain Latin letters, numbers, dashes, and underscores.

***

**Group**

One or more [groups](#payout-groups) in which the method is included, such as **Crypto**, **Fiat**, or other.

***

**Provider**

The name of the payment system.

For [PSS-connected](https://docs.b2core.b2broker.com/integrations/payment-systems#payment-system-service-pss) payment systems, **PaymentSystemsWithdrawal** is displayed as a provider.

***

**Driver**\
\&#xNAN;*Applicable only to payment systems connected via* [*PSS*](https://docs.b2core.b2broker.com/integrations/payment-systems#payment-system-service-pss)

The driver used to connect to a payment system. It reflects the name of the payment system and, in some cases, the supported payment method.

***

**Currency**

One or more currencies supported by the method. The method will be available for accounts denominated in the selected currencies.

***

**Enabled**

The method status:

* **No** — the method is inactive and unavailable for withdrawals.
* **Yes** — the method is active and available for withdrawals.

***

**Status**

![exclamation icon](https://514898401-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGoRxAprhHu1goANW7FXt%2Fuploads%2Fgit-blob-8f7b077e73b4648aac6db2795459df94b9280763%2Fexclamation-icon.png?alt=media) — indicates that some method settings need to be configured. Hovering over the icon displays a list of required settings, which can be adjusted in the method details.

If the column is empty, all required settings for the method have been specified.

To view withdrawal method details, click the **Edit** button.

### Details

The details page is divided into the following tabs:

* [Settings tab](#settings-tab)
* [TR Currencies tab](#tr-currencies-tab)
* [PS Currencies tab](#ps-currencies-tab)
* [Commissions tab](#commissions-tab)

#### Settings tab

On this tab, you can view or modify the general settings of the withdrawal method, as well as the connection settings of a payment provider.

**Name**

The unique name for the method. It can only contain Latin letters, numbers, dashes, and underscores.

***

**Enabled**

The method status:

* **No** — the method is inactive and unavailable for withdrawals.
* **Yes** — the method is active and available for for withdrawals.

***

**Group**

One or more [groups](#payout-groups) in which the method is included, such as **Crypto**, **Fiat**, or other.

***

**Caption**

The name assigned to the method in the Back Office, which is also visible to clients in the B2CORE UI.

***

**Provider**

The name of the payment system.

***

**Result URL**

The URL that receives callbacks with notifications about withdrawal status updates.

***

**Time to fund**

The hint text displayed to clients in the B2CORE UI, indicating the estimated processing time for withdrawals. Two standard options are available:

* `Depending on the Blockchain`
* `From 3 to 5 Days`

It's possible to modify the hint text of the standard options or add new ones in **System** > **Key storage** > **Key storage values**. Use the `method_time` tag to locate the relevant keys and update the text.

{% hint style="info" %}
The hint text can be specified in HTML format, but using different formats may cause difficulties in displaying the hint on different devices.

For example, while the HTML format renders correctly in the B2CORE UI, it may not work properly in mobile apps.
{% endhint %}

***

**Icon**

The method icon displayed to clients in the B2CORE UI for quick identification of the method.

You can use predefined icons or specify a URL for a custom image.

For a list of predefined icons and their names, refer to [Payment systems](https://docs.b2core.b2broker.com/integrations/payment-systems) and [Supported cryptocurrency payment methods](https://docs.b2core.b2broker.com/back-office-guide/references/supported-cryptocurrency-payment-methods). To use a predefined icon for the method, enter its name in the **Icon** field.

If you prefer a custom icon, specify the URL of the image to be displayed as the method icon.

***

**Priority**

The priority index assigned to the withdrawal method.

The order in which withdrawal methods are displayed to clients in the B2CORE UI depends on priority indexes assigned to methods. A lower index means a higher priority. For example, a method with the index `1` will appear at the top of the list in the B2CORE UI.

***

**IP White list**

A list of IP addresses from which it is allowed to make withdrawals.

***

**Rates provider**

The name of the rate provider configured on the [Currencies > Rates](https://docs.b2core.b2broker.com/back-office-guide/currencies/rates) page.

This field is optional.

If specified, the system will prioritize requesting rates from this provider when the payout method is used.

***

**Auto withdrawal enabled**

* **Yes** — clients can make automatic withdrawals using this method, without the need for admin approval.
* **No** — automatic withdrawals are disabled. In this case, each withdrawal request must be approved by the admin in the Back Office.

{% hint style="info" %}
The use of this option depends on the settings configured for the `payout` operation type in [System > Operation types](https://docs.b2core.b2broker.com/back-office-guide/operation-types#the-payout-operation-type).

Auto withdrawal can't be enabled for the method in the following cases:

* If the **Auto withdrawal** option for the `payout` operation type is disabled, which indicates that automatic withdrawals are globally disabled.
* If the [group](#payout-groups) associated with the method isn't listed in the **Auto processing rules** field, meaning that automatic withdrawals are prohibited for that group and all the withdrawal methods included in it.
  {% endhint %}

***

**Configuration**\
\&#xNAN;*Applicable to PSS methods*

The withdrawal method configuration form. Its structure and available fields depend on the selected **Driver**.

The **external connection** contains technical integration data required to connect to a specific payment system, while the **configuration** defines how the withdrawal process operates. As a result, you can configure two or more withdrawal methods with different configurations that all use the same external connection.

If no configuration is available for the selected driver, the following message is displayed: `Configuration form is empty`.

***

**Provider settings**\
\&#xNAN;*Applicable to non-PSS methods*

The settings required to connect to a payment provider.

The set of connection settings varies depending on the payment provider.

After specifying the connection settings, it’s possible to check if the credentials used to access the payment provider are valid. To do this, click the **Check connection** button.

{% hint style="info" %}
Currently, the **Check connection** button is available only for the B2BINPAY payment provider.
{% endhint %}

* If the specified credentials are valid, the status `Success` is displayed under the button.
* If the credentials are invalid, the status `Fail` is displayed, followed by an explanation message. In this case, contact the Support team.

***

**Custom fields**

Applicable for the **Constructor** provider only.

Configure a list of fields that clients should fill in when they make withdrawals using the **Constructor** method in the B2CORE UI (for details, refer to [How to add custom fields for the Constructor deposit or withdrawal method](https://docs.b2core.b2broker.com/how-to-articles/manage-payment-methods/how-to-add-the-constructor-deposit-or-withdrawal-method#how-to-add-custom-fields-for-the-constructor-deposit-or-withdrawal-method)).

#### TR Currencies tab

On this tab, you can view and manage a list of transaction currencies added to the withdrawal method. The method will be available for accounts denominated in these currencies.

The following information is provided about each currency:

**ID**

The identifier assigned to the currency added to the method.

***

**Currency**

The caption assigned to the currency.

#### PS Currencies tab

On this tab, you can view and manage a list of currencies supported by the payment provider for processing withdrawals. To enable the method to process withdrawals in a specific currency, ensure it is added to this list.

The following information is provided about each currency:

**ID**

The identifier assigned to the currency added to the method.

***

**Currency**

The caption assigned to the currency.

***

**Supported by PS**

The `Supported` status indicates that the added currency is supported by the payment provider and can be used for making withdrawals.

When adding a currency with a status that doesn't guarantee compatibility with the payment provider, the `Support is unknown` message is displayed. In this case, the currency can still be added to the tab, and the configuration can be saved. However, the currency might not be fully supported by the withdrawal method, so it should be used with caution.

When adding a currency that isn't supported, the `Not supported` message appears. In this case, the currency can't be added to the tab, and saving the configuration isn't allowed.

#### Commissions tab

On this tab, you can view and manage a list of commissions configured for the withdrawal method.

The following information is provided about each commission:

**ID**

The commission identifier in the Back Office.

***

**Currency**

One or more commission currencies.

***

**Commission**

The commission rates that follow the formula:

`Minimum commission amount <= Fixed rate + Percentage rate % <= Maximum commission amount`

For details, refer to [How to configure commissions for deposit and withdrawal methods](https://docs.b2core.b2broker.com/how-to-articles/manage-payment-methods/how-to-configure-commissions-for-deposit-and-withdrawal-methods).

***

**Type**

The commission type:

* **TR** (Vendor commission) — the commission that is calculated based on the currency and amount that a client specifies for withdrawal.

  If this commission type is configured, the client specifies an amount for withdrawal, which then will be reduced by the calculated commission.
* **PSP** (Provider commission) — the commission that is calculated only for financial reports and doesn't affect the amount a client withdraws from their account.

  If this commission type is configured, it only applies to calculations for reports regarding completed withdrawals and is displayed in the **Provider commission** column in [Finance > Payouts](https://docs.b2core.b2broker.com/back-office-guide/finance/payouts).

## Payout groups

Groups are used to organize withdrawal methods into categories, such as crypto and fiat methods, for easier management.

**Priority**

The priority index assigned to the group.

***

**Name**

The group name.

***

**Caption**

The group description.

***

**Enabled**

The group status:

* **No** — the group is inactive and cannot be used to include withdrawal methods.
* **Yes** — the group is active and can include withdrawal methods.
