> For the complete documentation index, see [llms.txt](https://docs.b2core.b2broker.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.b2core.b2broker.com/how-to-articles/manage-payment-methods/how-to-add-deposit-and-withdrawal-methods-through-pss/how-to-integrate-payretailers.md).
# How to integrate PayRetailers
[PayRetailers](https://payretailers.com/en/) can be connected to B2CORE through [PSS](/integrations/payment-systems.md#payment-system-service-pss), with support for deposits and withdrawals.
Follow the instructions below to configure the PayRetailers connections and set up the deposit and withdrawal methods in the B2CORE Back Office. These instructions correspond to the [General procedure](/how-to-articles/manage-payment-methods/how-to-add-deposit-and-withdrawal-methods-through-pss.md) for adding methods for PSS-supported payment systems, but include details specific to PayRetailers.
{% hint style="info" %}
Before proceeding with the instructions, you must have signed up for PayRetailers and have an active account. You can consult the official [PayRetailers documentation](https://payretailers.dev/docs/welcome) or contact their support in case you have any questions.
{% endhint %}
## Supported currencies
Below is the table listing the currencies supported for deposits and withdrawals via PayRetailers:
| Alpha code | Name | Supported for deposits | Supported for withdrawals |
| ---------- | ------------------ | ----------------------------------- | ----------------------------------- |
| ARS | Argentine peso | ✔ | ✔ |
| BRL | Brazilian real | ✔ | ✔ |
| CLP | Chilean peso | ✔ | ✔ |
| COP | Colombian peso | ✔ | ✔ |
| CRC | Costa Rican colon | ✔ | ✘ |
| USD | US dollar | ✔ | ✔ |
| MXN | Mexican peso | ✔ | ✔ |
| PEN | Peruvian sol | ✔ | ✔ |
| RWF | Rwandan franc | ✔ | ✘ |
| TZS | Tanzanian shilling | ✔ | ✘ |
| KES | Kenyan shilling | ✔ | ✘ |
| NGN | Nigerian naira | ✔ | ✘ |
| ZAR | South African rand | ✔ | ✘ |
## Configure connections to PayRetailers
If you plan to use PayRetailers for both deposits and withdrawals, you must configure two separate connections: one for deposits and another for withdrawals.
To configure a connection to PayRetailers:
{% stepper %}
{% step %}
In the B2CORE Back Office, navigate to **System** > **External connections**.
{% endstep %}
{% step %}
Click **+Create** in the upper-right page corner.
{% endstep %}
{% step %}
On the **Create connection** page, fill in the following fields:
* In the **Name** field, enter a name for the connection. The name must be unique and may only contain Latin letters, numbers, dashes, and underscores (for example, `Deposits_PayRetailers` or `Withdrawals_PayRetailers`).
* In the **Caption** field, enter a caption that will be applied to the connection in the Back Office.
* In the **Provider** dropdown, select:
* **PaymentSystemDeposit** — to add a connection that will be used for a deposit method.
* **PaymentSystemWithdrawal** — to add a connection that will be used for a withdrawal method.
{% endstep %}
{% step %}
In the **Driver** dropdown that appears, select **PayRetailers**.
{% endstep %}
{% step %}
In the **Credentials** section that appears, configure the PayRetailers-specific settings:
* In the **API base URL** field, specify:
* `https://api.payretailers.com` — for the production environment
* `https://api-sandbox.payretailers.com` — for the sandbox testing environment
* In the **Shop ID** field, enter the identifier assigned to your account by PayRetailers.
* In the **Secret key** field, specify the secret key from your PayRetailers account.
* In the **Subscription key** field, specify the subscription key from your PayRetailers account.
All of these details are provided by PayRetailers during the onboarding process and can also be found in the **Shops** section of your PayRetailers account.
PayRetailers — Shops menu
{% endstep %}
{% step %}
Click **Save** to create the connection.
The **PayRetailers** connection will appear in the list of external connections.
{% endstep %}
{% step %}
Check the connection status.
If the connection is inactive (**No** is displayed in the **Enabled** column), click the **Edit** button to open the connection details and set the **Enabled** dropdown to **Yes**.
{% endstep %}
{% step %}
Click **Save** to apply the changes.
{% endstep %}
{% endstepper %}
If you need to support both deposits and withdrawals via PayRetailers, follow the same instruction to create a new connection for the other operation.
## Add a deposit method through PayRetailers
To add and set up a method for making deposits through PayRetailers:
{% stepper %}
{% step %}
In the B2CORE Back Office, navigate to **System** > **Deposit system** > **Deposit methods**.
{% endstep %}
{% step %}
Click **+Create** in the upper-right page corner.
{% endstep %}
{% step %}
On the **Create a deposit method** page, fill in the following fields:
* In the **Name** field, enter a name for the method. The name must be unique and may only contain Latin letters, numbers, dashes, and underscores.
* In the **Caption** field, enter a caption for the method. This caption will be assigned to the method in the Back Office and will be visible to clients in the B2CORE UI.
* In the **Provider** dropdown, select **PaymentSystemDeposit**.
{% endstep %}
{% step %}
After selecting **PaymentSystemDeposit**, the following fields appear:
* In the **Available account currencies** dropdown, select one or more currencies. Deposits through this method will be available to accounts denominated in the selected currencies.
* In the **Driver** dropdown, select **PayRetailers**.
* In the **Connection** dropdown, select the previously configured [PayRetailers connection for deposits](#configure-connections-to-payretailers).
{% endstep %}
{% step %}
In the **Configuration** section that appears, fill in the following fields:
* In the **Channel** dropdown, select the payment channel:
* **Online** — for online payments
* **Wallet** — for payments via e-wallets
* **Credit card** — for funding deposits with bank cards
* **Cash** — for making cash payments through banks
* In the **Country** dropdown, select the country where the payment will be processed.
{% endstep %}
{% step %}
Click **Save** to create the deposit method.
The **PayRetailers** deposit method will appear in the list of deposit methods.
{% endstep %}
{% step %}
Click **Edit** to enter the method details and complete the following fields:
* On the **Settings** tab, use the **Group** dropdown to select one or more groups where the method should be included.
* In the **Icon** field, specify `paymethod-payretailers` to display the [predefined icon](/integrations/payment-systems.md) for the PayRetailers deposit method in the B2CORE UI. To use a custom icon, specify the URL of the image to be displayed.
* Check the method status.
If the method is inactive (**No** is displayed in the **Enabled** field), activate it by setting the **Enabled** dropdown to **Yes**.
* On the **PS Currencies** tab, add the needed currency. To enable the method to process deposits in a specific currency, ensure it is added on this tab.
{% hint style="info" %}
For PayRetailers **deposits**, the currencies used to process deposits are tied to the country selected in the method **Configuration** section. A single country may support more than one **deposit currency**:
* **Argentina** → ARS, USD
* **Brazil** → BRL, USD
* **Chile** → CLP, USD
* **Colombia** → COP, USD
* **Costa Rica** → CRC, USD
* **Ecuador** → USD
* **El Salvador** → USD
* **Mexico** → MXN, USD
* **Panama** → USD
* **Peru** → PEN, USD
* **Rwanda** → RWF, USD
* **Tanzania** → TZS, USD
* **Kenya** → KES, USD
* **Nigeria** → NGN, USD
* **South Africa** → ZAR, USD
For example, for Brazil, deposits can be processed in `BRL` and `USD`, both of which can be added on the **PS Currencies** tab.
Additionally, the method can be restricted for use in a specific country by applying country restrictions (for details, refer to [How to restrict the use of deposit and withdrawal methods](/how-to-articles/manage-payment-methods/how-to-restrict-the-use-of-deposit-and-withdrawal-methods.md#how-to-restrict-the-use-by-country)).
{% endhint %}
* If needed, configure commissions for the method on the **Commissions** tab (for details, refer to [How to configure commissions for deposit and withdrawal methods](/how-to-articles/manage-payment-methods/how-to-configure-commissions-for-deposit-and-withdrawal-methods.md)).
PayRetailers deposit method — Settings tab
{% endstep %}
{% step %}
Click **Test configuration** to validate the connection settings of the deposit method.
The test result will be displayed on the page.
{% endstep %}
{% step %}
After successfully validating the configuration, click **Save**.
{% endstep %}
{% endstepper %}
The **PayRetailers** deposit method is now configured in the B2CORE Back Office.
## Add a withdrawal method through PayRetailers
To add and set up a method for making withdrawals through PayRetailers:
{% stepper %}
{% step %}
In the B2CORE Back Office, navigate to **System** > **Payout system** > **Payout methods**.
{% endstep %}
{% step %}
Click **+Create** in the upper-right page corner.
{% endstep %}
{% step %}
On the **Create a payout method** page, fill in the following fields:
* In the **Name** field, enter a name for the method. The name must be unique and may only contain Latin letters, numbers, dashes, and underscores.
* In the **Caption** field, enter a caption for the method. This caption will be assigned to the method in the Back Office and will be visible to clients in the B2CORE UI.
* In the **Provider** dropdown, select **PaymentSystemWithdrawal**.
{% endstep %}
{% step %}
After selecting **PaymentSystemWithdrawal**, the following fields appear:
* In the **Available account currencies** dropdown, select one or more currencies. Withdrawals through this method will be available from accounts denominated in the selected currencies.
* In the **Driver** dropdown, select **PayRetailers**.
* In the **Connection** dropdown, select the previously configured [PayRetailers connection for withdrawals](#configure-connections-to-payretailers).
{% endstep %}
{% step %}
In the **Configuration** section, select the payment channel in the **Channel** dropdown.
{% endstep %}
{% step %}
Click **Save** to create the withdrawal method.
The **PayRetailers** withdrawal method will appear in the list of withdrawal methods.
{% endstep %}
{% step %}
Click **Edit** to enter the method details and complete the following fields:
* On the **Settings** tab, use the **Group** dropdown to select one or more groups where the method should be included.
* In the **Icon** field, specify `paymethod-payretailers` to display the [predefined icon](/integrations/payment-systems.md) for the PayRetailers withdrawal method in the B2CORE UI. To use a custom icon, specify the URL of the image to be displayed.
* Check the method status.
If the method is inactive (**No** is displayed in the **Enabled** field), activate it by setting the **Enabled** dropdown to **Yes**.
* On the **PS Currencies** tab, add the needed currency. To enable the method to process withdrawals in a specific currency, ensure it is added on this tab.
{% hint style="info" %}
For PayRetailers **withdrawals**, each currency is tied to a specific country in a strict one-to-one relationship. This means that a withdrawal in a given currency is available only for its corresponding country. As a result, clients must select the appropriate country and provide the required bank details for that location.
The following mapping shows which country is associated with each **withdrawal currency**:
* **Argentina** → ARS
* **Brazil** → BRL
* **Chile** → CLP
* **Colombia** → COP
* **Ecuador** → USD
* **Mexico** → MXN
* **Peru** → PEN
{% endhint %}
* If needed, configure commissions for the method on the **Commissions** tab (for details, refer to [How to configure commissions for deposit and withdrawal methods](/how-to-articles/manage-payment-methods/how-to-configure-commissions-for-deposit-and-withdrawal-methods.md)).
PayRetailers withdrawal method — Settings tab
{% endstep %}
{% step %}
Click **Test configuration** to validate the connection settings of the withdrawal method.
The test result will be displayed on the page.
{% endstep %}
{% step %}
After successfully validating the configuration, click **Save**.
{% endstep %}
{% endstepper %}
The **PayRetailers** withdrawal method is now configured in the B2CORE Back Office.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.b2core.b2broker.com/how-to-articles/manage-payment-methods/how-to-add-deposit-and-withdrawal-methods-through-pss/how-to-integrate-payretailers.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.