How to integrate PayRetailers
Learn how to integrate PayRetailers with B2CORE via PSS to enable deposits and withdrawals in supported currencies
PayRetailers can be connected to B2CORE through PSS, with support for deposits and withdrawals.
Below is the table listing the currencies supported for deposits and withdrawals via PayRetailers:
ARS
✔
✔
BRL
✔
✔
CLP
✔
✔
COP
✔
✔
CRC
✔
✘
USD
✔
✔
MXN
✔
✔
PEN
✔
✔
RWF
✔
✘
TZS
✔
✘
KES
✔
✘
NGN
✔
✘
ZAR
✔
✘
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 for adding methods for PSS-supported payment systems, but include details specific to PayRetailers.
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:
In the B2CORE Back Office, navigate to System > External connections.
Click +Create in the upper-right page corner.
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_PayRetailersorWithdrawals_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.
In the Driver dropdown that appears, select PayRetailers.
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 environmenthttps://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.
Click Save to create the connection.
The PayRetailers connection will appear in the list of external connections.
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.
Click Save to apply the changes.
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:
In the B2CORE Back Office, navigate to System > Deposit system > Deposit methods.
Click +Create in the upper-right page corner.
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.
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.
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.
Click Save to create the deposit method.
The PayRetailers deposit method will appear in the list of deposit methods.
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-payretailersto display the predefined icon 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.
If needed, configure commissions for the method on the Commissions tab (for details, refer to How to configure commissions for deposit and withdrawal methods).
Click Test configuration to validate the connection settings of the deposit method.
The test result will be displayed on the page.
After successfully validating the configuration, click Save.
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:
In the B2CORE Back Office, navigate to System > Payout system > Payout methods.
Click +Create in the upper-right page corner.
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.
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.
In the Configuration section, select the payment channel in the Channel dropdown.
Click Save to create the withdrawal method.
The PayRetailers withdrawal method will appear in the list of withdrawal methods.
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-payretailersto display the predefined icon 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.
If needed, configure commissions for the method on the Commissions tab (for details, refer to How to configure commissions for deposit and withdrawal methods).
Click Test configuration to validate the connection settings of the withdrawal method.
The test result will be displayed on the page.
After successfully validating the configuration, click Save.
The PayRetailers withdrawal method is now configured in the B2CORE Back Office.
Last updated
Was this helpful?