Payout
When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.
Countries and regions | Nigeria, South Africa |
Payment currencies | NGN, ZAR |
Payment amount limits | Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard. |
Payment processing time | Contact your key account manager at Monetix for details. |
Currency conversion | On the Monetix side |
Refund | |
Onboarding and access fee | Contact your key account manager at Monetix for details. |
Operations support
Interfaces | |||
---|---|---|---|
Payment Page | Gate | Dashboard | |
Payout |
You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.
The following sections provide more information about the payment processing flow and the analysis of completed payments.
Payout by using Gate
General information
To perform a payout by using Gate with the Bank transfers in Africa payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Accept the callback with the payout result from the payment platform.
The following picture provides the details of the payout processing flow in the Bank transfers in Africa payment method.
- The customer initiates a payout in your system.
- Your system sends the payout request to the Monetix payment platform.
- The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service informs the payment platform about the payout result.
- The payment platform sends a callback with the payout result to your system.
- Your system sends the payout result to the customer.
Request
This section provides the instructions on how to build the request for payout with the Bank transfers in Africa payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/bank-transfer/africa/payout |
Full API endpoint specification | /v2/payment/bank-transfer/{payment_method}/payout |
|
||||
---|---|---|---|---|
Object | Object/Parameter | Description | ||
general | project_id | Project ID you obtained from Monetix when integrating. Example: | ||
payment_id | Payment ID unique within your project. Example: | |||
signature | Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | |||
customer | id | Unique ID of the customer within your project. Example: | ||
ip_address | IP address of the customer's device. Example: | |||
first_name | Customer's first name. Example: | |||
last_name | Customer's last name. Example: | |||
email | Customer's email. Example: | |||
phone | Customer phone number without a plus sign (+), only digits without spaces and punctuation. Example: | |||
identify | doc_number | The number of the document establishing the identity of the customer. Required when performing a purchase in South Africa. Document number can be one of the following: passport number (1 letter and 8 digits), identification number of customer (13 digits). Example: | ||
account | number | Customer account number, only digits without spaces or punctuation marks. If the payment currency is NGN , then the account number should have 10 digits, if the payment currency is ZAR , then the account number can be 10 or 11 digits.Example: | ||
type | Customer's account type. Possible values:
Example: | |||
bank_id | Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for payout. Example: | |||
security_code | Bank Verification Number (BVN) consisting of 11 digits. Required when performing a payout in Nigeria. Example: | |||
payment | currency | Code of the payment currency in the ISO-4217 alpha-3 format. Example: | ||
amount | Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units. If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes. Example: 100.00 NGN must be sent as | |||
You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference. |
Here is an example of the data from a request to initiate a payout with the Bank transfers in Africa payment method:
{ "general": { "project_id": 1234, "payment_id": "payment_47", "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==" }, "customer": { "id": "customer_123", "ip_address": "198.51.100.47", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "phone": "123456789", "identify": { "doc_number": "1234567891012" } }, "account": { "number": "0123456789", "type": "savings", "bank_id": 12345, "security_code": "1234567890" }, "payment": { "currency": "NGN", "amount": 10000 } }
Callback
In the Bank transfers in Africa payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks in Gate.
The following is an example of a callback body with the information about a successfully completed payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"method": "Bank transfer africa",
"sum": {
"amount": 10000,
"currency": "NGN"
},
"description": ""
},
"customer": {
"id": "customer_123"
},
"operation": {
"id": 47,
"type": "payout",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"created_date": "2024-12-07T19:08:05+0000",
"request_id": "1a23456bc7890de",
"sum_initial": {
"amount": 10000,
"currency": "NGN"
},
"sum_converted": {
"amount": 10000,
"currency": "NGN"
},
"code": "0",
"message": "Success",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
The following is an example of a callback for a declined payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"method": "Bank transfer africa",
"sum": {
"amount": 10000,
"currency": "NGN"
},
"description": ""
},
"customer": {
"id": "customer_123"
},
"operation": {
"id": 47,
"type": "payout",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"created_date": "2024-12-07T19:08:05+0000",
"request_id": "1a23456bc7890de",
"sum_initial": {
"amount": 10000,
"currency": "NGN"
},
"sum_converted": {
"amount": 10000,
"currency": "NGN"
},
"code": "20000",
"message": "General decline",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
Payout by using Dashboard
- single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
- as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.
Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.
For more information about payout processing by using Dashboard, see Performing payouts.
Banks available for payout
Supported banks
In the Bank transfers in Africa payment method, payouts are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.
The table below lists the banks available for purchase in the Bank transfers in Africa payment method.
Bank | ID |
---|---|
9 Payment Service Bank | 72452 |
AB Microfinance Bank | 72462 |
Abbey Mortgage Bank | 72472 |
Above Only Microfinance Bank | 72482 |
ABU Microfinance Bank | 72492 |
AbucoopMicrofinance Bank | 82694 |
ACCELEREX NETWORK | 83434 |
ACCESS BANK NIGERIA | 193 |
ACCESS MOBILE | 194 |
Access Yello | 72512 |
ACCESSMONEY | 83454 |
Accion Microfinance Bank | 72522 |
Ada MFB | 82704 |
Addosser Microfinance Bank | 72532 |
Adeyemi College Staff Microfinance Bank | 72542 |
ADVANS LA FAYETTE MFB | 83464 |
AG Mortgage Bank | 72552 |
AL-Barakah Microfinance Bank | 72442 |
Al-Hayat Microfinance Bank | 72562 |
Alekun Microfinance Bank | 72572 |
Alert MFB | 72582 |
Allworkers Microfinance Bank | 72592 |
Alpha Kapital Microfinance Bank | 72602 |
ALTERNATIVE BANK | 78172 |
AMJU Unique Microfinance Bank | 72612 |
AMML Microfinance Bank | 72622 |
Apeks Microfinance Bank | 72632 |
APEX TRUST MICROFINANCE BANK | 83474 |
ARCA PAYMENTS COMPANY LIMITED | 83484 |
Arise Microfinance Bank | 72642 |
Aso Savings and Loans | 196 |
Assets Matrix MFB | 82714 |
Astrapolaris Microfinance Bank | 72652 |
Auchi Microfinance Bank | 72662 |
Baines Credit Microfinance Bank | 72672 |
Balogun FulaniMicrofinance Bank | 82724 |
Balogun Gambari MFB | 72682 |
BANK OF INDUSTRY FINANCIAL DEPARTMENT | 78202 |
BANKLY MICROFINANCE BANK | 78242 |
BAOBAB MICROFINANCE BANK | 78252 |
Bayero Microfinance Bank | 72692 |
BC Kash Microfinance Bank | 72702 |
BETA-ACCESS YELLO | 83494 |
BIPC MICROFINANCE BANK | 72712 |
Boctrust Microfinance Bank | 72722 |
Boji Boji Microfinance Bank | 82734 |
Borgu MFB | 82744 |
Borno Renaissance Microfinance bank | 82754 |
Bosak Microfinance Bank | 72732 |
Bowen Microfinance Bank | 72742 |
Brent Mortgage Bank | 72752 |
BRETHREN MICROFINANCE BANK | 72762 |
BRIDGEWAY MICROFINANCE BANK | 72772 |
Brightway Microfinance Bank | 72782 |
Business Support Microfinance Bank | 82764 |
CAPITALMETRIQ SWIFT MICROFINANCE BANK | 82774 |
Capricorn Digital | 82784 |
CARBON MICROFINANCE BANK LIMITED | 78212 |
Cellulant | 604 |
CEMCS Microfinance Bank | 72792 |
ChamsMobile | 598 |
Chanelle Bank | 82794 |
Changan RTS Microfinance Bank | 82804 |
Chikum Microfinance Bank | 72802 |
CIT Microfinance Bank | 72812 |
CitiBank | 587 |
Citizen Trust Microfinance Bank Ltd | 82814 |
CloverleafMFB | 82824 |
Consumer Microfinance Bank | 72822 |
Contec Global Infotech Limited (NowNow) | 72832 |
CORESTEP MICROFINANCE BANK | 78272 |
Coronation Merchant Bank | 222 |
Covenant Microfinance Bank | 600 |
Credit Afrique Microfinance Bank | 72842 |
CROWDFORCE | 82834 |
Davodani Microfinance Bank | 83504 |
Daylight Microfinance Bank | 72852 |
Delta Trust Mortgage bank | 82844 |
DIAMOND BANK PLC | 197 |
Doje Microfinance Bank Limited | 83514 |
DOT MICROFINANCE BANK | 78262 |
e-Barcs Microfinance Bank | 72862 |
Eagle Flight MFB | 72872 |
Eartholeum | 588 |
EBSU MICROFINANCE Bank | 82854 |
EcoBank Express Account | 72882 |
Ecobank Mobile | 198 |
ECOBANK NIGERIA LIMITED | 199 |
Edfin MFB | 72892 |
EK-Reliable Microfinance Bank | 83524 |
Ekondo MFB | 72902 |
Empire Trust Microfinance Bank | 72912 |
ENTERPRISE BANK LIMITED | 200 |
Esan Microfinance Bank | 72922 |
Eso-E Microfinance Bank | 72932 |
eTranzact | 586 |
Evangel MFB | 72942 |
Evergreen MICROFINANCE BANK | 72952 |
Evib Finance | 83534 |
Eyowo MFB | 72962 |
FAIRMONEY | 82864 |
FAST Microfinance Bank | 72972 |
FBN MOBILE | 201 |
FBN Mortgages Limited | 72982 |
FBNQuest Merchant Bank | 72992 |
FCMB Easy Account | 73002 |
FCMB Plc | 73012 |
FCT MFB | 73022 |
Federal Polytechnic Nekede Microfinance Bank | 82874 |
FEDERAL UNIVERSITY DUTSE MICROFINANCE BANK | 73032 |
FederalPoly NasarawaMFB | 73042 |
Fedeth MFB | 82884 |
FETS | 73052 |
FFS Microfinance Bank | 73062 |
FIDELITY BANK PLC | 202 |
Fidelity Mobile | 592 |
Fidfund Microfinance Bank | 73072 |
FINATRUST MICROFINANCE BANK | 21381 |
Firmus MFB | 73082 |
FIRST BANK PLC | 203 |
First Generation Mortgage Bank | 73092 |
First Heritage MFB | 82894 |
First Multiple MFB | 73102 |
First Option MFB | 73112 |
First Royal Microfinance Bank | 73122 |
First Trust Mortgage Bank Plc | 73132 |
FirstMonie Wallet | 73142 |
Flutterwave Technology Solutions Limited | 73152 |
Fortis Microfinance Bank | 596 |
FortisMobile | 582 |
FSDH | 607 |
Futo Microfinance Bank | 73162 |
GABSYN MICROFINANCE BANK LIMITED | 83544 |
Gadol Finance | 83554 |
Gashua Microfinance Bank | 73172 |
Gateway Mortgage Bank | 73182 |
Giant Stride MFB | 82904 |
GiGinya Microfinance Bank | 82914 |
Globus Bank | 73192 |
Glory MFB | 73202 |
GoMoney | 73212 |
Good Neighbours Microfinance Bank | 82924 |
GOODNEWS MICROFINANCE BANK | 73222 |
Green Energy Microfinance Bank Ltd | 73232 |
Greenville Microfinance Bank | 73242 |
Greenwich Merchant Bank | 73252 |
Grooming Microfinance Bank | 73262 |
GT MOBILE | 73272 |
GTBank Mobile Money | 205 |
GTBANK PLC | 206 |
Hackman Microfinance Bank | 73282 |
Haggai Mortgage Bank Limited | 73292 |
Hala MF | 73302 |
Hasal Micro-finance Bank | 73312 |
Hedonmark | 589 |
HERITAGE BANK | 207 |
Highland Microfinance Bank | 82944 |
HopePSB | 82954 |
IBETOMicrofinance Bank | 82964 |
IBILE Microfinance Bank | 73322 |
Ibom fadama Microfinance Bank | 82974 |
IC GLOBALMicrofinance bank | 82984 |
Igbo-ukwu MFB | 83574 |
IKENNE MFB | 73332 |
Ikire MFB | 73342 |
ILE-OLUJI MFB | 83584 |
Imo State Microfinance Bank | 73352 |
Imperial Homes Mortgage Bank | 601 |
Infinity Microfinance Bank | 73362 |
Infinity Trust Mortgage Bank | 73372 |
Innovectives Kesh | 73382 |
Intellfin | 73392 |
Interland MFB | 82994 |
IRL Microfinance Bank | 73402 |
JAIZ Bank | 591 |
Jessefield Microfinance Bank | 83004 |
Jubliee Life | 73412 |
Kadick Integration Limited | 73422 |
Kadpoly MICROFINANCE BANK | 73432 |
KCMB Microfinance Bank | 73442 |
Kegow | 73452 |
KEGOW(CHAMSMOBILE) | 83014 |
KEYSTONE BANK PLC | 208 |
Kingdom CollegeMicrofinance Bank | 83024 |
KOLOMONI MFB | 83594 |
Kontagora MFB | 73462 |
Koraypay | 83034 |
KREDI MONEY MICROFINANCE BANK | 83044 |
Kuda Micro-finance Bank | 73472 |
Kwasu MF Bank | 83054 |
La Fayette Microfinance Bank | 73482 |
Lagos Building Investment Company | 73492 |
LandgoldMicrofinance Bank | 83064 |
Lapo Microfinance Bank | 73502 |
Lavender Microfinance Bank | 73512 |
Letshego MFB | 73522 |
Liquidcrest MFB | 83604 |
LIVINGTRUST MORTGAGE BANK PLC | 83614 |
Lotus Bank | 83074 |
LOTUS BANK LIMITED | 78182 |
M36 | 73532 |
Mainland MICROFINANCE BANK | 73542 |
Mainstreet Micro-finance Bank | 73552 |
Maintrust MFB | 83084 |
Malachy Microfinance Bank | 73562 |
Manny Microfinance bank | 73572 |
Maritime Microfinance Bank | 83094 |
MAUTECH Microfinance Bank | 73582 |
Mayfair MFB | 73592 |
MayFresh Mortgage Bank | 73602 |
Megapraise Microfinance Bank | 73612 |
MICHAEL OKPARA UNIAGRIC MICROFINANCE BANK | 83624 |
Microcred Microfinance Bank | 73622 |
Microsystems Investment and Development Limited | 83104 |
MINT-FINEX Microfinance Bank | 78232 |
MKOBO Microfinance Bank | 78222 |
Mkudi | 608 |
MoMo PSB | 83114 |
Money Master PSB | 83124 |
Money Trust Micro-finance Bank | 73632 |
MoneyBox | 590 |
Moremonee Microfinance Bank Limited | 83634 |
Mutual Benefits Microfinance Bank | 73642 |
Mutual Trust Microfinance Bank | 73652 |
Nagarta Microfinance Bank | 73662 |
Nasarawa Microfinance bank | 83134 |
Navy Microfinance Bank | 73672 |
Ndiorah Microfinance Bank | 73682 |
NetApps Technology Limited | 83144 |
New Dawn Microfinance Bank | 73692 |
NEW GOLDEN PASTURES MICROFINANCE BANK | 83644 |
New Prudential Bank | 73702 |
NEXIM BANK | 83654 |
NIBSSUSSD PAYMENTS | 83154 |
Nigeria Prisons Microfinance bank | 83164 |
NIP Virtual Bank | 594 |
NIRSAL Microfinance Bank | 73712 |
Nnew women MFB | 73722 |
Nomba financial services Limited | 83174 |
Northquest Finance | 83664 |
Nova Merchant Bank | 73732 |
NPF MicroFinance Bank | 602 |
NSUK MICROFINANCE BANK LTD | 83674 |
Nwannegadi MFB | 83184 |
Oche MFB | 73742 |
ODOAKPU MICROFINANCE BANK LIMITED | 83684 |
Ohafia Microfinance Bank | 73752 |
Ojokoro Mfb | 83194 |
Okpoga Microfinance Bank | 73762 |
Olabisi Onabanjo University Microfinance Bank | 73772 |
OLOFIN OWENA Microfinance Bank | 83204 |
Omiye MFB | 73782 |
Omoluabi Mortgage Bank | 585 |
One Finance | 73792 |
OPAY | 75502 |
OPTIMUS BANK | 83694 |
Pagatech | 606 |
Page Micro-finance Bank | 73802 |
PALMPAY | 73812 |
PARALLEX BANK | 73822 |
Parkway | 209 |
ParkWay-ReadyCash | 73832 |
PARRALEX BANK | 224 |
PatrickGold Microfinance Bank | 73842 |
PayAttitude Online | 597 |
PAYCOM | 210 |
PecanTrust Microfinance Bank | 73852 |
Pennywise Microfinance Bank | 73862 |
Personal Trust Microfinance Bank | 73872 |
Pillar MFB | 73882 |
Platinum Mortgage Bank | 73892 |
POCKETAPP | 83704 |
Poder finance | 83714 |
Polaris bank | 21371 |
Polyuwanna MFB | 73902 |
PREMIUM TRUST BANK | 83724 |
Pristine Divitis Microfinance Bank | 83214 |
Prodigy MFB | 83734 |
Prospa Capital Microfinance Bank | 83744 |
Providus Bank | 223 |
Purplemoney MFB | 73912 |
Quickfund Microfinance Bank | 73922 |
Rahama MFB | 73932 |
Rand Merchant Bank | 73942 |
Refuge Mortgage Bank | 73952 |
Regent Micro-finance Bank | 73962 |
Reliance Microfinance Bank | 73972 |
RenMoney Microfinance Bank | 73982 |
Rephidim MICROFINANCE BANK | 73992 |
Resident Fintech Limited | 83224 |
Richway Microfinance Bank | 74002 |
Rima Growth pathway Microfinance Bank | 83234 |
ROYAL BLUE MICROFINANCE BANK | 83754 |
Royal Exchange Microfinance Bank | 74012 |
Rubies Micro-finance Bank | 74022 |
Safe Haven MFB | 74032 |
Safegate Microfinance Bank | 83244 |
SafeTrust Mortgage Bank | 599 |
Sagamu Micro-finance Bank | 74042 |
Seed Capital Micro-finance Bank | 74052 |
SHALOM MICROFINANCE BANK LTD | 83764 |
SmartCash Payment Service bank | 83254 |
Solid Allianze MFB | 83264 |
Sparkle | 74062 |
SPAY business | 83274 |
Stanbic IBTC @ease Wallet | 74072 |
STANBIC IBTC BANK PLC | 212 |
Stanbic Mobile | 213 |
STANDARD CHARTERED BANK NIGERIA LIMITED | 214 |
Standard MFB | 83284 |
Stanford Microfinance Bak | 74082 |
SIGNATURE BANK LIMITED | 78192 |
STERLING BANK PLC | 215 |
Sterling Mobile | 584 |
Sulsap MFB | 74092 |
SunTrust Bank | 603 |
TagPay | 583 |
Taj Bank | 74102 |
TajWallet | 83294 |
Tangerine Money MFB | 83304 |
TCF Micro-finance Bank | 74112 |
TeasyMobile | 593 |
TF MICROFINANCE BANK | 83774 |
Titan Trust Bank | 74122 |
TITAN-PAYSTACK MICROFINANCE BANK | 83314 |
Trident Microfinance Bank | 74132 |
Triple A Microfinance bank | 83324 |
Trust MFB | 74142 |
TRUSTBANC J6 MICROFINANCE BANK LIMITED | 83784 |
Trustbond | 610 |
Trustfund Microfinance Bank | 74152 |
U AND C MFB | 74162 |
Uhuru Microfinance bank | 83334 |
Umuchinemere Procredit Microfinance Bank | 83344 |
UNAAB MFB | 74172 |
Uniben Microfinance Bank | 74182 |
Unical Microfinance Bank | 74192 |
UNION BANK OF NIGERIA PLC | 216 |
UNITED BANK FOR AFRICA PLC | 217 |
UNITY BANK PLC | 218 |
UNN MFB | 74202 |
VALE FINANCE LIMITED | 83804 |
Vas2nets Limited | 83364 |
Venture Garden Nigeria Limited | 83814 |
Verdant Microfinance Bank | 83374 |
Verite Microfinance Bank | 74212 |
VFD Micro-finance Bank | 74222 |
VIRTUE MFB | 83824 |
Visa Microfinance Bank | 74232 |
VTNetworks | 595 |
Wallet MFB | 83834 |
WEMA BANK PLC | 219 |
WetLand Micro-finance Bank | 74242 |
WinView Bank | 83384 |
XPRESS PAYMENTS | 83844 |
XPRESS WALLET | 83854 |
Xslnce Microfinance Bank | 74252 |
YCT Microfinance Bank | 83394 |
Yello Digital financial services | 83404 |
Yes Microfinance Bank | 74262 |
Yobe MFB | 83414 |
ZENITH BANK PLC | 220 |
ZENITH EAZY WALLET | 83864 |
ZENITH Mobile | 221 |
Zikora Microfinance bank | 83424 |
ZINTERNET - KONGAPAY | 74272 |
Bank | ID |
---|---|
ABSA Bank ZA | 21311 |
Access Bank ZA | 74282 |
African Bank ZA | 74292 |
Albaraka Bank ZA | 74302 |
Bank Zero ZA | 74312 |
Bidvest Bank ZA | 74322 |
Capitec Bank ZA | 21341 |
Citi Bank ZA | 74332 |
Discovery Bank ZA | 74342 |
First National Bank ZA | 438 |
FNB ZA | 21321 |
Grindrod ZA | 74352 |
HSBC Bank ZA | 74362 |
Investec Bank ZA | 21351 |
Mercantile Bank ZA | 74372 |
Nedbank Limited ZA | 2841 |
Olympus Mobile ZA | 74382 |
Rand Merchant Bank ZA | 74392 |
Sasfin Bank ZA | 74402 |
Standard Bank ZA | 21331 |
Standard Chartered Bank ZA | 74412 |
TymeBank ZA | 74422 |
Ubank Limited ZA | 74432 |
The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Bank transfers in Africa payment method supports, send a request to the payment platform.
Request for the list of available banks
The list of banks may change that's why we recommend that you send the payment platform a request for the list of banks currently available in the Bank transfers in Africa payment method. The request format and structure should be the following:
HTTP request method | POST |
Request body format | JSON |
API endpoint |
/v2/info/banks/bank-transfer/africa/payout/list
|
Full API endpoint specification | /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general |
project_id |
Project ID you obtained when integrating with Monetix.
Example: |
|
payment_id |
Payment ID unique within the project.
If the payment is not yet created, set this parameter to a unique value. Example: |
||
signature |
Signature created after you specify all the required parameters. For more information about, signature generation, see Signature generation and verification. | ||
payment |
amount |
Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units. If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes. Example: 100.00 NGN must be sent
as |
|
currency |
Code of the payout currency in the ISO-4217 alpha-3 format.
Example: |
||
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference. |
Here is an example of the data from the request for the list of banks available in the Bank transfers in Africa payment method.
{ "general": { "project_id": 200, "payment_id": "ORDER_155860015", "signature": "K6jll2ym+PtOb3ocZtr345st...==" }, "payment": { "amount": 10000, "currency": "NGN" } }
[ { "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units) "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units) "limitCurrency": "NGN", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format "id": 123, // Bank ID "abbr": "EXB", // Bank shortcut name (for internal use) "name": "Example Bank", // General bank name "nativeName": "Example Bank", // Native bank name "currencies": [ // Array with currencies supported by the bank { "id": 123, // Currency ID in the payment platform "alpha_3_4217": "NGN", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format "currency_type": "fiat", // Type of the currency "exponent": 2 // Number of decimal places after decimal point } ] } ]