Get Account Form
Introduction
Build the front-end form for bank account-based payment, partners need to calls the Get Account Form API to obtain field definitions such as bank selection, account number input, and any other user-required data fields.
API Description
Request Method:POST
Request Path:open/api/transfer/requiredField
Parameters
Request Parameters
| Parameter | Sign | Mandatory | Type | Length | Description |
|---|---|---|---|---|---|
| appId | Y | Y | string | 64 | AppId is unique for merchant |
| sign | N | Y | string | 512 | Sign |
| currency | Y | Y | string | 20 | Fiat currency:MXN,NGN |
Request Parameter Example
{
"currency": "NGN",
"appId":"TEST000001",
"sign":"TEST000001"
}Response Parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Success |
| error | boolean | Error |
| code | long | Response code |
| msg | string | Response message |
| traceId | string | Trace id |
| model | object | Response content |
Response Parameter Example
{
"code": "0",
"msg": "success",
"model": {
"fields": [
{
"regex": "",
"fieldName": "bankName",
"dataSourceKey": "bankList",
"formElement": "select",
"length": "",
"fieldType": "string"
},
{
"regex": "",
"fieldName": "bankCode",
"dataSourceKey": "bankList",
"formElement": "select",
"length": "",
"fieldType": "string"
},
{
"regex": "",
"fieldName": "bankAccountNumber",
"dataSourceKey": "",
"formElement": "input",
"length": "10",
"fieldType": "string"
}
],
"dataSource": {
"bankList": [
{
"bankCode": "311",
"bankName": "Parkway - ReadyCash"
},
{
"bankCode": "51293",
"bankName": "QuickFund MFB"
},
{
"bankCode": "51251",
"bankName": "Hackman Microfinance Bank"
},
{
"bankCode": "106",
"bankName": "Signature Bank Ltd"
},
{
"bankCode": "303",
"bankName": "Lotus Bank"
},
{
"bankCode": "501",
"bankName": "FSDH Merchant Bank Limited"
},
{
"bankCode": "51322",
"bankName": "Uhuru MFB"
},
{
"bankCode": "50968",
"bankName": "Supreme MFB"
},
{
"bankCode": "50582",
"bankName": "Shield MFB"
},
{
"bankCode": "50491",
"bankName": "LOMA MFB"
},
{
"bankCode": "415",
"bankName": "IMPERIAL HOMES MORTAGE BANK"
},
{
"bankCode": "562",
"bankName": "Greenwich Merchant Bank"
},
{
"bankCode": "090560",
"bankName": "Crust Microfinance Bank"
},
{
"bankCode": "070027",
"bankName": "CITYCODE MORTAGE BANK"
},
{
"bankCode": "50739",
"bankName": "Goodnews Microfinance Bank"
},
{
"bankCode": "090664",
"bankName": "GOOD SHEPHERD MICROFINANCE BANK"
},
{
"bankCode": "50442",
"bankName": "Ilaro Poly Microfinance Bank"
},
{
"bankCode": "090164",
"bankName": "FIRST ROYAL MICROFINANCE BANK"
},
{
"bankCode": "090679",
"bankName": "NDCC MICROFINANCE BANK"
},
{
"bankCode": "50162",
"bankName": "Dot Microfinance Bank"
},
{
"bankCode": "51316",
"bankName": "Unilag Microfinance Bank"
},
{
"bankCode": "090478",
"bankName": "AVUENEGBE MICROFINANCE BANK"
},
{
"bankCode": "082",
"bankName": "Keystone Bank"
},
{
"bankCode": "076",
"bankName": "Polaris Bank"
},
{
"bankCode": "221",
"bankName": "Stanbic IBTC Bank"
},
{
"bankCode": "068",
"bankName": "Standard Chartered Bank"
},
{
"bankCode": "232",
"bankName": "Sterling Bank"
},
{
"bankCode": "032",
"bankName": "Union Bank of Nigeria"
},
{
"bankCode": "033",
"bankName": "United Bank For Africa"
},
{
"bankCode": "215",
"bankName": "Unity Bank"
},
{
"bankCode": "050023",
"bankName": "PROSPERIS FINANCE LIMITED"
},
{
"bankCode": "044",
"bankName": "Access Bank"
},
{
"bankCode": "50800",
"bankName": "Solid Rock MFB"
},
{
"bankCode": "090678",
"bankName": "EXCEL FINANCE BANK"
},
{
"bankCode": "023",
"bankName": "Citibank Nigeria"
},
{
"bankCode": "050021",
"bankName": "PFI FINANCE COMPANY LIMITED"
},
{
"bankCode": "51297",
"bankName": "Crescent MFB"
},
{
"bankCode": "063",
"bankName": "Access Bank (Diamond)"
},
{
"bankCode": "090680",
"bankName": "PATHFINDER MICROFINANCE BANK LIMITED"
},
{
"bankCode": "050",
"bankName": "Ecobank Nigeria"
},
{
"bankCode": "090171",
"bankName": "MAINSTREET MICROFINANCE BANK"
},
{
"bankCode": "090162",
"bankName": "STANFORD MICROFINANCE BANK"
},
{
"bankCode": "070",
"bankName": "Fidelity Bank"
},
{
"bankCode": "090496",
"bankName": "RANDALPHA MICROFINANCE BANK"
},
{
"bankCode": "011",
"bankName": "First Bank of Nigeria"
},
{
"bankCode": "214",
"bankName": "First City Monument Bank"
},
{
"bankCode": "50298",
"bankName": "Fedeth MFB"
},
{
"bankCode": "645",
"bankName": "Amucha Microfinance Bank"
},
{
"bankCode": "561",
"bankName": "NOVA BANK"
},
{
"bankCode": "51308",
"bankName": "KANOPOLY MFB"
},
{
"bankCode": "058",
"bankName": "Guaranty Trust Bank"
},
{
"bankCode": "50697",
"bankName": "OLUCHUKWU MICROFINANCE BANK LTD"
},
{
"bankCode": "090574",
"bankName": "Goldman MFB"
},
{
"bankCode": "035",
"bankName": "Wema Bank"
},
{
"bankCode": "057",
"bankName": "Zenith Bank"
},
{
"bankCode": "301",
"bankName": "Jaiz Bank"
},
{
"bankCode": "100",
"bankName": "Suntrust Bank"
},
{
"bankCode": "101",
"bankName": "Providus Bank"
},
{
"bankCode": "104",
"bankName": "Parallex Bank"
},
{
"bankCode": "035A",
"bankName": "ALAT by WEMA"
},
{
"bankCode": "00716",
"bankName": "Pocket App"
},
{
"bankCode": "602",
"bankName": "Accion Microfinance Bank"
},
{
"bankCode": "50123",
"bankName": "Beststar Microfinance Bank"
},
{
"bankCode": "090561",
"bankName": "Akuchukwu Microfinance Bank Limited"
},
{
"bankCode": "50761",
"bankName": "REHOBOTH MICROFINANCE BANK"
},
{
"bankCode": "51142",
"bankName": "Nigerian Navy Microfinance Bank Limited"
},
{
"bankCode": "51226",
"bankName": "PECANTRUST MICROFINANCE BANK LIMITED"
},
{
"bankCode": "51361",
"bankName": "NET MICROFINANCE BANK"
},
{
"bankCode": "899",
"bankName": "Kolomoni MFB"
},
{
"bankCode": "MFB50992",
"bankName": "Baobab Microfinance Bank"
},
{
"bankCode": "51403",
"bankName": "TENN"
},
{
"bankCode": "51351",
"bankName": "AWACASH MICROFINANCE BANK"
},
{
"bankCode": "50809",
"bankName": "STATESIDE MICROFINANCE BANK"
},
{
"bankCode": "90077",
"bankName": "AG Mortgage Bank"
},
{
"bankCode": "51353",
"bankName": "Cashbridge Microfinance Bank Limited"
},
{
"bankCode": "51100",
"bankName": "BellBank Microfinance Bank"
},
{
"bankCode": "100025",
"bankName": "KONGAPAY (Kongapay Technologies Limited)(formerly Zinternet)"
},
{
"bankCode": "120004",
"bankName": "Airtel Smartcash PSB"
},
{
"bankCode": "120002",
"bankName": "HopePSB"
},
{
"bankCode": "090706",
"bankName": "UCEE MFB"
},
{
"bankCode": "120001",
"bankName": "9mobile 9Payment Service Bank"
},
{
"bankCode": "120003",
"bankName": "MTN Momo PSB"
},
{
"bankCode": "090701",
"bankName": "ISUA MFB"
},
{
"bankCode": "090708",
"bankName": "TransPay MFB"
},
{
"bankCode": "51286",
"bankName": "Rigo Microfinance Bank Limited"
},
{
"bankCode": "105",
"bankName": "PremiumTrust Bank"
},
{
"bankCode": "51355",
"bankName": "Waya Microfinance Bank"
},
{
"bankCode": "51276",
"bankName": "GROOMING MICROFINANCE BANK"
},
{
"bankCode": "50453",
"bankName": "Imowo MFB"
},
{
"bankCode": "312",
"bankName": "Chikum Microfinance bank"
},
{
"bankCode": "268",
"bankName": "Platinum Mortgage Bank"
},
{
"bankCode": "40165",
"bankName": "SAGE GREY FINANCE LIMITED"
},
{
"bankCode": "090629",
"bankName": "Amegy Microfinance Bank"
},
{
"bankCode": "000304",
"bankName": "The Alternative bank"
},
{
"bankCode": "50739",
"bankName": "Prospa Capital Microfinance Bank"
},
{
"bankCode": "50092",
"bankName": "Assets Microfinance Bank"
},
{
"bankCode": "MFB51093",
"bankName": "Garun Mallam MFB"
},
{
"bankCode": "645",
"bankName": "Amucha MFB"
},
{
"bankCode": "51337",
"bankName": "AZTEC MICROFINANCE BANK LIMITED"
},
{
"bankCode": "594",
"bankName": "Yes MFB"
},
{
"bankCode": "50036",
"bankName": "Ahmadu Bello University Microfinance Bank"
},
{
"bankCode": "50994",
"bankName": "Rephidim Microfinance Bank"
},
{
"bankCode": "51318",
"bankName": "Fairmoney Microfinance Bank"
},
{
"bankCode": "50870",
"bankName": "Unaab Microfinance Bank Limited"
},
{
"bankCode": "50767",
"bankName": "ROCKSHIELD MICROFINANCE BANK"
},
{
"bankCode": "946",
"bankName": "Money Master PSB"
},
{
"bankCode": "50629",
"bankName": "NPF MICROFINANCE BANK"
},
{
"bankCode": "832",
"bankName": "FUTMINNA MICROFINANCE BANK"
},
{
"bankCode": "50871",
"bankName": "Unical MFB"
},
{
"bankCode": "50204",
"bankName": "Corestep MFB"
},
{
"bankCode": "50171",
"bankName": "Chanelle Microfinance Bank Limited"
},
{
"bankCode": "51253",
"bankName": "Stellas MFB"
},
{
"bankCode": "51113",
"bankName": "Safe Haven MFB"
},
{
"bankCode": "413",
"bankName": "FirstTrust Mortgage Bank Nigeria"
},
{
"bankCode": "51146",
"bankName": "Personal Trust MFB"
},
{
"bankCode": "812",
"bankName": "Gateway Mortgage Bank LTD"
},
{
"bankCode": "50126",
"bankName": "Eyowo"
},
{
"bankCode": "51244",
"bankName": "Ibile Microfinance Bank"
},
{
"bankCode": "999991",
"bankName": "PalmPay"
},
{
"bankCode": "50117",
"bankName": "Banc Corp Microfinance Bank"
},
{
"bankCode": "50315",
"bankName": "Aella MFB"
},
{
"bankCode": "50515",
"bankName": "Moniepoint MFB"
},
{
"bankCode": "51341",
"bankName": "BANKLY MFB"
},
{
"bankCode": "050020",
"bankName": "Vale Finance Limited"
},
{
"bankCode": "401",
"bankName": "ASO Savings and Loans"
},
{
"bankCode": "098",
"bankName": "Ekondo Microfinance Bank"
},
{
"bankCode": "057",
"bankName": "Zenith Bank"
},
{
"bankCode": "951113",
"bankName": "Safe Haven Microfinance Bank Limited"
},
{
"bankCode": "50211",
"bankName": "Kuda Bank"
},
{
"bankCode": "302",
"bankName": "TAJ Bank"
},
{
"bankCode": "125",
"bankName": "Rubies MFB"
},
{
"bankCode": "50746",
"bankName": "Petra Mircofinance Bank Plc"
},
{
"bankCode": "50457",
"bankName": "Infinity MFB"
},
{
"bankCode": "50840",
"bankName": "U&C Microfinance Bank Ltd (U AND C MFB)"
},
{
"bankCode": "559",
"bankName": "Coronation Merchant Bank"
},
{
"bankCode": "90067",
"bankName": "Refuge Mortgage Bank"
},
{
"bankCode": "50910",
"bankName": "Consumer Microfinance Bank"
},
{
"bankCode": "404",
"bankName": "Abbey Mortgage Bank"
},
{
"bankCode": "50563",
"bankName": "Mayfair MFB"
},
{
"bankCode": "031",
"bankName": "Living Trust Mortgage Bank"
},
{
"bankCode": "865",
"bankName": "CASHCONNECT MFB"
},
{
"bankCode": "502",
"bankName": "Rand Merchant Bank"
},
{
"bankCode": "50743",
"bankName": "Peace Microfinance Bank"
},
{
"bankCode": "MFB50094",
"bankName": "Astrapolaris MFB LTD"
},
{
"bankCode": "51314",
"bankName": "Firmus MFB"
},
{
"bankCode": "FC40128",
"bankName": "County Finance Limited"
},
{
"bankCode": "51062",
"bankName": "Solid Allianze MFB"
},
{
"bankCode": "50304",
"bankName": "Mint MFB"
},
{
"bankCode": "50926",
"bankName": "Amju Unique MFB"
},
{
"bankCode": "FC40163",
"bankName": "Branch International Finance Company Limited"
},
{
"bankCode": "51336",
"bankName": "AKU Microfinance Bank"
},
{
"bankCode": "107",
"bankName": "Optimus Bank Limited"
},
{
"bankCode": "00103",
"bankName": "Globus Bank"
},
{
"bankCode": "50083",
"bankName": "Aramoko MFB"
},
{
"bankCode": "566",
"bankName": "VFD Microfinance Bank Limited"
},
{
"bankCode": "50439",
"bankName": "Ikoyi Osun MFB"
},
{
"bankCode": "50894",
"bankName": "Uzondu Microfinance Bank Awka Anambra State"
},
{
"bankCode": "51310",
"bankName": "Sparkle Microfinance Bank"
},
{
"bankCode": "102",
"bankName": "Titan Bank"
},
{
"bankCode": "51334",
"bankName": "Davenport MICROFINANCE BANK"
},
{
"bankCode": "090190",
"bankName": "MUTUAL BENEFITS MICROFINANCE BANK"
},
{
"bankCode": "50823",
"bankName": "CEMCS Microfinance Bank"
},
{
"bankCode": "51211",
"bankName": "IBANK Microfinance Bank"
},
{
"bankCode": "50549",
"bankName": "Links MFB"
},
{
"bankCode": "51229",
"bankName": "Bainescredit MFB"
},
{
"bankCode": "100022",
"bankName": "GoMoney"
},
{
"bankCode": "50200",
"bankName": "Kredi Money MFB LTD"
},
{
"bankCode": "100002",
"bankName": "Paga"
},
{
"bankCode": "51269",
"bankName": "Tangerine Money"
},
{
"bankCode": "50502",
"bankName": "Kadpoly MFB"
},
{
"bankCode": "51204",
"bankName": "Above Only MFB"
},
{
"bankCode": "51267",
"bankName": "Benysta Microfinance Bank Limited"
},
{
"bankCode": "50383",
"bankName": "Hasal Microfinance Bank"
},
{
"bankCode": "50931",
"bankName": "Bowen Microfinance Bank"
},
{
"bankCode": "50864",
"bankName": "Polyunwana MFB"
},
{
"bankCode": "90052",
"bankName": "Lagos Building Investment Company Plc."
},
{
"bankCode": "565",
"bankName": "Carbon"
},
{
"bankCode": "51312",
"bankName": "Abulesoro MFB"
},
{
"bankCode": "50263",
"bankName": "Ekimogun MFB"
},
{
"bankCode": "100039",
"bankName": "Paystack-Titan"
}
]
}
},
"traceId": "685a2c0e0e8f4e73f2077d6a09348575",
"success": true,
"error": false
}Updated about 5 hours ago