Build payment solutions easily and quickly with our APIs. Connect your customers to high-quality financial products.
\nWith growing adoption of mobile payment apps by consumers to complete day to day
\ntransactions, we see an opportunity for developers and businesses to offer financial services to their existing customer base through REST APIs and without doing the heavy lifting. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\nAPIs available are:
\nTop up customers airtime seamlessly. Get fast online recharges for all the mobile networks in the world.
\nTop up data balance of any phone number. Available for all the mobile networks in the world.
\nPurchase Utility Bills such as Electricity bills, Cable bills and Internet routers easily.
\nPurchase gift cards for over 5,000 brands including international brands like Apple, Amazon, Google, Spotify etc and local brands like Jumia, Spar, Slot etc.
\nEasily request for airtime to cash conversion with our Apis.
\nPerform KYC checks for your customers with this endpoint.
\nGet all banks in Nigeria and resolve account numbers with our Apis.
\nTo see list of our pricing for all services, navigate to our pricing page
\nYou would need to be a verified user on Bingpay.
\nWhen logged in, navigate to Top right menu bar-> Api to either request for API keys if its your first time or copy the api keys displayed if you have previously generated one.
\nTest secret key : 1dd501141dffd9d68f254b241f05871b8f10754c90f4832ad9\n\n200 - Successful
\n400 - Failed
\nIf you are experiencing any issues while integrating, contact us via developers@bingpay.ng
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"}],"owner":"17112744","collectionId":"d79411ea-6e90-45a5-8270-60be029ef09f","publishedId":"U16nKPpt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"cb3298"},"publishDate":"2022-07-25T01:00:34.000Z"},"item":[{"name":"Self","item":[{"name":"Check Balance","id":"4516d6a5-1c9e-45b5-b861-df3ee6a665b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://bingpay.ng/api/v1/self/balance","description":"Use this to fetch your bingpay wallet balance.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this to fetch all networks.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this to verify customer's phone number.
Only country ISO codes are allowed. example NG for Nigeria, US for United States of America etc.
You can find list of all ISO codes here.
Use this to perform airtime purchase.
You get 2% discount on every airtime purchase instantly.
Purchase airtime for all mobile networks in Nigeria with this endpoint.
\n","event":[{"listen":"prerequest","script":{"id":"e131543e-5663-4319-a97a-0499b046a039","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"37f1255d-cceb-4c27-ba4a-95e62ab635f4","type":"text/javascript","exec":[""]}}],"_postman_id":"27dd7f4c-ffa0-492f-939e-d46f1e7254a1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this to fetch all data plans.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Fetch Data plans for a specific network.
Network id can be gotten from All networks endpoint.
Use this to perform a data purchase.
You get 2% discount on every data purchase instantly.
Purchase data for all mobile networks in Nigeria with this endpoint.
\n","event":[{"listen":"prerequest","script":{"id":"a7133664-d09d-488f-9319-c1b6fd776d66","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1f246e76-5492-4b4b-a6c1-e5dc3fbd71b8","type":"text/javascript","exec":[""]}}],"_postman_id":"f10d9054-bd62-41a9-81ca-aa6a0a41e1da","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Fetch all available bills services from this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Fetch variation for a bill service.
Service id can be gotten from all-services endpoint.
Use this to validate customer's details before performing a bill purchase.
\nUse this to perform a bill purchase.
\nPay utility bills like Cable TV subscriptions, Electricity, Education and Internet routers easily with this endpoint.
\n","_postman_id":"646b1f19-123b-452e-8d44-aa8d458995cc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this endpoint to fetch all local gift cards.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this to validate a gift card and fetch gift card info.
\nUse this to make a local gift card purchase
Service fee of NGN50 applies
Purchase Local Gift cards for brands like jumia, spar, slot, istore etc with this endpoint.
\n","_postman_id":"c213690e-083f-4491-b739-453529b7598e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this endpoint to fetch all gift cards available for a country.
\nYou can only fetch and purchase with the supported country codes below:
\nYou can also use search parameter to filter product name.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this to validate a gift card and fetch gift card info.
\nUse this to fetch fee for a gift card.
NOTE: This is the amount we will charge you after sucessful purchase.
Use this to make a gift card purchase
\nPurchase International Gift cards for brands like amazon, apple, spotify etc with this endpoint.
\n","_postman_id":"50810246-8d72-4b8a-8cf4-9fdefccf34d6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Fetch network charges and recipient phone number for each network before processing airtime to cash transactions.
The data->charge response is the percentage of charge and the data->value response is the amount you'll receive if the conversion is approved.
Use this to perform airtime to cash transactions.
Transactions may take 5-10 mins to be approved, You can automatically get notification if the transaction is approved or declined by using our Webhooks.
With this endpoint, you can enable your customers convert their excess airtime to cash.
Funds will added to your wallet immediately the request is approved.
Bank Verification Number or BVN is a biometric identification widely used by Banks in Nigeria. This endpoint allows you to fetch a user's information from their BVN. It supports only BVNs generated by Nigerian Banks.
\nService charge of NGN25 applies for every successful data fetch.
\nThis endpoint allows you to verify a Nigeria National ID.
\nService charge of NGN80 applies for every successful data fetch.
\nThis endpoint allows you to verify Nigerian businesses registered with corporate affairs commission.
\nService charge of NGN200 applies for every successful data fetch.
\nBingpay allows you to verify the identities of other individuals all over the country. This could be for user verifications, hiring, Background checks, etc.
\n","_postman_id":"d4f415fd-6925-4590-9ced-5b52dc394d3d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Fetch all Nigerian banks with this endpoint
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this to resolve customer's account details.
\nYou can fetch all banks in Nigeria and resolve your customer's account number with this endpoint.
\n","event":[{"listen":"prerequest","script":{"id":"e3ee309d-80e7-4ac2-8e6f-6fbd16da11ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"208af1b1-f750-4ae0-8f89-9e6c6d85b22a","type":"text/javascript","exec":[""]}}],"_postman_id":"ea1ff7fa-7c5b-4e81-9116-e33d3abacd8c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Listen and get event notifications whenever certain actions occur on your integration.
\nWhenever certain transaction actions occur on your Bingpay account, we trigger events which your application can listen to.
\nA webhook is a URL on your server where we send payloads for such events.
For example, if you add a webhook to your bingpay account, once an airtime to cash transaction is approved, we will immediately send a webhook to your specified Webhook URL so you can offer value to your customers.
Here is a list of events we can send to your webhook URL:
\n\n1. Airtime to Cash
\n
\n\n\n
\n- Navigate to the Api page.
\n- Enter your webhook url to the Webhook input field.
\n- Click the check icon and you're set!
\n
Please make sure you verify transaction reference and status before giving value.
\nAirtime to Cash Payload Example
\n{\n \"message\": \"Transaction Status\",\n \"data\": {\n \"EventType\": \"AirtimeToCash\",\n \"reference\": \"XXXX\",\n \"status\": \"approved\",\n \"amount\": \"5000\",\n \"value\": \"4000\",\n \"time\": \"02/04/2022 09:18pm\",\n \"currency\": \"NGN\"\n }\n}\n\n