How to integrate KoraPay
Learn how to integrate KoraPay with B2CORE via PSS, including configuring connections and adding deposit and withdrawal methods with supported currencies
KoraPay can be connected to B2CORE through PSS. It supports:
Deposits in the following currencies:
NGN,GHS,KES,XAF, andXOF.Withdrawals to bank accounts in
NGN,GHS, andKES. This method only works for Nigeria.Withdrawals to mobile wallets via mobile money in
NGN,GHS,KES,XAF, andXOF. This method works for Cameroon, Côte d’Ivoire, Ghana, Kenya, Nigeria, and South Africa.
Follow the instructions below to configure the KoraPay connection 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 KoraPay.
Configure connections to KoraPay
If you plan to use KoraPay for both deposits and withdrawals, you must configure separate connections, each dedicated to a specific deposit or withdrawal method.
Each connection must be configured with the appropriate driver to ensure the correct operation of the respective deposit or withdrawal method.
To configure a connection to KoraPay:
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_KoraPayorWithdrawals_KoraPay).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:
KoraPay — for deposits.
KoraPay bank account — for withdrawals to bank accounts.
KoraPay mobile money — for withdrawals to mobile wallets via mobile money.
In the Credentials section that appears, configure the KoraPay-specific settings:
In the API base URL field, specify
https://api.korapay.com.In the Secret key field, enter the secret key from your KoraPay account.
In the Public key field, enter the public key from your KoraPay account.
To find both your secret and public keys, sign in to your KoraPay account, navigate to Settings, and open the API Configuration tab.
Click Save to create the connection.
The KoraPay 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 additional KoraPay connections for other payment methods, follow the same instruction to create a new connection with a different driver.
Add a deposit method through KoraPay
To add and set up a method for making deposits through KoraPay:
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 that are supported for deposits, such as
NGN,GHS,KES,XAF, andXOF. Deposits through KoraPay will be available to accounts denominated in the selected currencies.In the Driver dropdown, select KoraPay.
In the Connection dropdown, select the previously configured KoraPay connection for deposits.
In the Configuration section, set the Merchant bears cost option to:
Yes — the broker (merchant) pays the transaction fee.
No — the trader (client) pays the transaction fee.
Click Save to create the deposit method.
The KoraPay 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-korapayto display the predefined icon for the KoraPay 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 currencies. 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 KoraPay deposit method is now configured in the B2CORE Back Office.
Add a withdrawal method through KoraPay
To add and set up a method for making withdrawals through KoraPay:
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 KoraPay will be available from accounts denominated in the selected currencies.
In the Driver dropdown, select:
KoraPay bank account — for withdrawals to bank accounts.
KoraPay mobile money — for withdrawals to mobile wallets via mobile money.
In the Connection dropdown, select the previously configured KoraPay connection for withdrawals.
In the Configuration section, complete the following settings:
For the KoraPay bank account driver:
In the Merchant bears cost dropdown, select:
Yes — the broker (merchant) pays the transaction fee.
No — the trader (client) pays the transaction fee.
For the KoraPay mobile money driver:
Configure the Merchant bears cost option as described above.
In the Country dropdown, select the where this withdrawal method will be available, such as Cameroon, Côte d’Ivoire, Ghana, Kenya, Nigeria, or South Africa.
Click Save to create the withdrawal method.
The KoraPay 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-korapayto display the predefined icon for the KoraPay withdrawal method in the B2CORE UI. To use a custom icon, specify the URL of the image to be displayed.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 currencies. 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 KoraPay withdrawal method is now configured in the B2CORE Back Office. To add another withdrawal method via KoraPay using a different driver, follow the same instructions and select the other driver.
Last updated
Was this helpful?