Welcome to the Ncwallet NG! You can use our API to access Ncwallet NG API endpoints, which can be use to purchase any of our services, and breeds in our database.
\nWe have language bindings in PHP, Ruby, Python, react js and JavaScript! You can use any programming language of your choice to connect to Ncwallet NG endpoints.
\nThis Ncwallet NG API documentation page was created to assits you through the integration proccess.
\nThanks.
\nAll requests to Ncwallet NG API must be done using the web API URL below.
\nlive Url Base: https://ncwallet.ng/api/
Ncwallet NG uses {{Token}} as the security protocol.
\nTo access Ncwallet NG endpoints you'd need to get API Key and Transaction PIN ready to grants you access to the service.
\nFor Token Authorization
It should be passed as stated below
Please use the following details for authentication in header section.
Authorization: Your Ncwallet NG Transaction PIN followed by Your Ncwallet NG API Key.
Sample \"Authorization: 1234nrnvsgjyrnvndgjg\".
\nIf an API Key or Transaction PIN is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nThe following operation types are supported.
\nEach service endpoint has is own desicription for easy integration.
\nExpected status response to determine the transaction status.
\n\n\nstatus = success
\n
This means that the transaction is successful and you have been charged.
\n\n\nstatus = fail
\n
This means that the transaction failed and you have been refunded.
\n\n\nstatus = process or any other response
\n
This means that the transaction is pending and you have been charged, kindly wait for about 5mins or reachout to our support with you transaction ref ID for confirmation.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21426936","collectionId":"4225358e-28af-4b8b-9a7f-3985d8e966a3","publishedId":"2s9Yyy7dJT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-06T21:09:44.000Z"},"item":[{"name":"Fetch Details","item":[{"name":"Fetch account details","id":"da7b1a95-5b81-427d-91d1-6b960021eeda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This endpoint allows you to fetch account details related to your profile. i.e Available Balance, Referal balance and more
\n\n\nThis endpoint uses
\n
\"Authorization\": base64(\"Your_Ncwallet_NG_Transaction_PINYour_Ncwallet_NG_Username:Your_Ncwallet_NG_Password\")
The resulting Base64 encoded string should then be pass at the Header
This endpoint also allows you to fetch account details related to your profile. i.e Available Balance, Referal balance and more
\n\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"fa3d1400-082b-4a05-a1eb-efe991de9def","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92249ca1-1aa1-4e77-aa7b-311f8e4ca14f","type":"text/javascript","exec":[""]}}],"_postman_id":"81a07154-698b-4ab3-9f13-17342e507adb"},{"name":"Verify Transaction & Get IDs","item":[{"name":"Verify transaction","id":"15eb453e-e3a6-424a-970a-9a45d1bf9839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"7ed3728abd2"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Token 12347ed3728abd2","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref_id\": \"AIRTIMENCNG65BFAE3D1E3B9\" //Required\r\n}"},"url":"https://ncwallet.ng/api/transaction/","urlObject":{"path":["transaction",""],"host":["https://ncwallet.ng/api"],"query":[],"variable":[]}},"response":[{"id":"cf6a6618-2fa9-418a-a93b-577b517a3d62","name":"Verify transaction","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Token 12347ed3728abd2","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref_id\": \"AIRTIMENCNG65BFAE3D1E3B9\" //Required\r\n}"},"url":"https://ncwallet.ng/api/transaction/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.0.30"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-methods","value":"POST"},{"key":"access-control-allow-headers","value":"X-API-KEY, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Access-Control-Allow-Origin"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"content-security-policy","value":"upgrade-insecure-requests"},{"key":"feature-policy","value":"geolocation 'self'; microphone 'none'; camera 'none'"},{"key":"expect-ct","value":"enforce, max-age=86400"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"same-origin"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-frame-options","value":"DENY"},{"key":"permissions-policy","value":"geolocation=(), microphone=(), camera=()"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"332"},{"key":"date","value":"Fri, 16 Feb 2024 07:07:06 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"trnx_status\": \"success\",\n \"service\": \"Airtime\",\n \"ref_id\": \"AIRTIMENCNG65BFAE3D1E3B9\",\n \"oldbal\": \"₦3,745.00\",\n \"amount\": \"₦100.00\",\n \"discount_charges\": \"₦4.00\",\n \"newbal\": \"₦3,649.00\",\n \"channel\": \"WEB\",\n \"message\": \"Airtime purchase of GLO VTU NGN 100.00 to 09056495630.\",\n \"datetime\": \"2024-02-04 04:33:17 PM\"\n }\n}"}],"_postman_id":"15eb453e-e3a6-424a-970a-9a45d1bf9839"},{"name":"Get all Service IDs","id":"950747e3-cbbb-4323-b246-e2a6a680dcd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This endpoint uses
\n
\"Authorization\": Your_Ncwallet_NG_Transaction_PINYour_Ncwallet_NG_APIKEY
This should be pass at the Header
Does not require Header
\n"}],"body":{"mode":"raw","raw":""},"url":"https://ncwallet.ng/api/service_id/?fetch=network","urlObject":{"path":["service_id",""],"host":["https://ncwallet.ng/api"],"query":[{"description":{"content":"Needed value is stated at the service body
\n","type":"text/plain"},"key":"fetch","value":"network"}],"variable":[]}},"response":[{"id":"1c48b96f-a375-488e-b839-0e9c8c602efc","name":"Query IDs","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"77fe451f1dd13f1af5e9fb1047c28b7979bd656848d892ef238ae80e9acb","type":"text"},{"key":"trnx-pin","value":"1234","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://ncwallet.ng/api/service_id/?fetch=network","host":["https://ncwallet.ng/api"],"path":["service_id",""],"query":[{"key":"fetch","value":"network","description":"Use the service path name to fetch the associated IDs i.e data, network, cableTV."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.0.30"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-methods","value":"GET"},{"key":"access-control-allow-headers","value":"X-API-KEY, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Access-Control-Allow-Origin"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-length","value":"693"},{"key":"date","value":"Tue, 06 Feb 2024 23:50:10 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"}],"cookie":[],"responseTime":null,"body":"Array\n(\n [status] => success\n [message] => Network ID list fetched successfully.\n [network_list] => Array\n (\n [0] => Array\n (\n [network_id] => 1\n [network] => MTN\n )\n\n [1] => Array\n (\n [network_id] => 2\n [network] => AIRTEL\n )\n\n [2] => Array\n (\n [network_id] => 3\n [network] => GLO\n )\n\n [3] => Array\n (\n [network_id] => 4\n [network] => 9MOBILE\n )\n\n )\n\n)\n"}],"_postman_id":"950747e3-cbbb-4323-b246-e2a6a680dcd1"}],"id":"2abe1d78-38a8-4d4a-8eaa-700bf696cf33","description":"1. Query transaction
\nThis endpoint allows you to query transaction to get the current status of the transaction with ref_id
\n\n\nThis enpoint uses
\n
\"Authorization\": Your_Ncwallet_NG_Transaction_PINYour_Ncwallet_NG_APIKEY
This should be pass at the Header
2. Query IDs
\nThis endpoint allows you to fetch IDs for all our services, i.e data_plan ID, network ID and others.
\n\n\n","event":[{"listen":"prerequest","script":{"id":"70cfc923-a324-4524-bd42-094db18829fd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"071c8e08-9bd9-4cb7-bb46-c0a58b512b79","type":"text/javascript","exec":[""]}}],"_postman_id":"2abe1d78-38a8-4d4a-8eaa-700bf696cf33","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This enpoint uses
\n
\"Authorization\": Your_Ncwallet_NG_Transaction_PINYour_Ncwallet_NG_APIKEY
This should be pass at the Header
// Required
\n","type":"text/plain"},"key":"meter_id","value":"6"},{"description":{"content":"// Required
\n","type":"text/plain"},"key":"meter_type","value":"prepaid"},{"description":{"content":"// Required
\n","type":"text/plain"},"key":"meter_number","value":"45056851000"}],"variable":[]}},"response":[{"id":"fbf1983c-657c-4338-a38a-c1dc64bd3ec6","name":"Electricity validation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://ncwallet.ng/api/bill/bill-validation?meter_id=6&meter_type=prepaid&meter_number=45056851000","host":["https://ncwallet.ng/api"],"path":["bill","bill-validation"],"query":[{"key":"meter_id","value":"6","description":"// Required"},{"key":"meter_type","value":"prepaid","description":"// Required"},{"key":"meter_number","value":"45056851000","description":"// Required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.0.30"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-methods","value":"POST"},{"key":"access-control-allow-headers","value":"X-API-KEY, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Access-Control-Allow-Origin"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"219"},{"key":"date","value":"Tue, 06 Feb 2024 17:37:29 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Meter number validated successfully.\",\n \"meter_id\": \"6\",\n \"meter_company\": \"Ibadan Electricity (IBEDC)\",\n \"meter_number\": \"45056851000\",\n \"meter_name\": \"Mr Olu kaykay\",\n \"meter_address\": \"No 14 Nigeria\"\n}"}],"_postman_id":"e5707172-a920-4d7f-99da-ccf24b344788"},{"name":"CableTV validation","id":"440a6fad-06b2-411b-8027-e3d6833e1670","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"// Required
\n","type":"text/plain"},"key":"cable_number","value":"8214422754"}],"variable":[]}},"response":[{"id":"fded09a8-f7bf-4b32-8dee-d6edaf5753ca","name":"CableTV validation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://ncwallet.ng/api/cable/cable-validation?cable_id=2&cable_number=8214422754","host":["https://ncwallet.ng/api"],"path":["cable","cable-validation"],"query":[{"key":"cable_id","value":"2","description":" // Required"},{"key":"cable_number","value":"8214422754","description":" // Required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.0.30"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-methods","value":"POST"},{"key":"access-control-allow-headers","value":"X-API-KEY, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Access-Control-Allow-Origin"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"175"},{"key":"date","value":"Tue, 06 Feb 2024 17:04:30 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"CableTV account validated successfully.\",\n \"cable_company\": \"DSTV\",\n \"cable_number\": \"8214422777\",\n \"customer_name\": \"Olu kaykay\",\n \"current_plan\": \"Dstv Confam N5,300\"\n}"}],"_postman_id":"440a6fad-06b2-411b-8027-e3d6833e1670"}],"id":"34140c1e-dac2-4755-b097-326452b4f81d","description":"This endpoint allows you to purchse any of our services. and also to validate
\n\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This enpoint uses
\n
\"Authorization\": Your_Ncwallet_NG_Transaction_PINYour_Ncwallet_NG_APIKEY
This should be pass at the Header