GSUBZ API: Powering Seamless VTU and Bill Payment Integrations
\nUnlock your business's full potential with the GSUBZ API, a leading solution for simple and efficient online/mobile recharges. Designed to streamline your services, our API allows you to effortlessly integrate diverse functionalities such as data subscriptions, bill payments, airtime purchases, TV subscriptions, and recharge card printing directly into your website.
\nGetting Started is Easy:
\nCreate Your Free GSUBZ Account: Sign up for free and immediately start exploring our API's capabilities.
\nIntegrate and Innovate: Use our well-documented API to enhance your service offerings and provide your customers with a seamless experience.
\nReceive an Upgrade: After integrating our API, we'll upgrade your account to allow you to get even cheaper prices.
\nWith GSUBZ API, you're not just staying competitive—you're setting the pace in the world of virtual top-up and bill payment solutions. Start building with GSUBZ today and transform how your business handles payments and subscriptions.
\nGet your Token[API KEY] here https://gsubz.com//dashboard/key.php
\nTRANSACTION_SUCCESSFUL',Example:
\n{\n \"code\": 200,\n \"status\": \"failed\",\n \"transactionID\": \"3485293xxx\",\n \"amount\": 125,\n \"phone\": \"08167926xxx\",\n \"serviceID\": \"mtn_sme\",\n \"amountPaid\": 140,\n \"initialBalance\": 6927928.0532408,\n \"finalBalance\": 6927833.0532408,\n \"date\": \"2024-09-14T19:31:06+01:00\",\n \"api_response\": \"Activation of Data Transfer 500MB was not successful. Please try again.\"\n}\n\nCode:'204':'REQUIRED_CONTENT_NOT_SENT',
Code:'206':'INVALID_CONTENT',
Code:'401':' INVALID_PLAN',
Code:'402':'INSUFFICIENT_BALANCE',
Code:'404':'CONTENT_NOT_FOUND',
Code:'405':'REQUEST_METHOD_NOT_IN_POST'
Code:'406':'SERVICE_DISABLED',
Code:'502':'GATEWAY_ERROR'
https://api.gsubz.com/api/plans?service=mtn_sme
\nEnd Point to get our list of available data plans
\n\n\nuseful for getting the appropriate
\nplanfor a particular data transfer
List of available data services (parameters)
\nservice=serviceID
\nservice=mtn_sme
\nservice=mtn_cg_lite (SME 2.0)
\nservice=mtn_gifting
\nservice=mtn_datashare (unavailable)
\nservice=mtn_coupon
\nservice=mtncg
\nservice=airtel_cg
\nservice=airtel_sme
\nservice=glo_data
\nservice=glo_sme
\nservice=etisalat_data
\n//use any of the available serviceID's above
\n","type":"text/plain"},"key":"service","value":"mtn_sme"}],"variable":[]}},"response":[{"id":"8862e68c-6e4b-4224-9a99-a6229ea767a9","name":"plans","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gsubz.com/api/plans?service=mtn_sme","protocol":"https","host":["gsubz","com"],"path":["api","plans"],"query":[{"key":"service","value":"mtn_sme","description":"Description"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/7.2.34"},{"key":"content-type","value":"application/json"},{"key":"last-modified","value":"Tue, 11 Aug 2020 20:40:20 GMT"},{"key":"etag","value":"118b5e932f47541c6e5539c4bdb3dd71"},{"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":"713"},{"key":"date","value":"Mon, 02 May 2022 16:47:11 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"service\": \"MTN-SME-Data(*461*4#)\",\n \"PlanName\": \"plan\",\n \"fixedPrice\": true,\n \"plans\": [\n {\n \"displayName\": \"10GB - 30days\",\n \"value\": \"260\",\n \"price\": \"2400\"\n },\n {\n \"displayName\": \"1GB - 30days\",\n \"value\": \"166\",\n \"price\": \"240\"\n },\n {\n \"displayName\": \"2GB - 30days\",\n \"value\": \"167\",\n \"price\": \"480\"\n },\n {\n \"displayName\": \"500MB - 30 Days\",\n \"value\": \"179\",\n \"price\": \"120\"\n },\n {\n \"displayName\": \"5GB - 30days\",\n \"value\": \"169\",\n \"price\": \"1200\"\n }\n ]\n}"}],"_postman_id":"8961e807-3548-42cc-afbd-a6b33fcba083"},{"name":"buy data","id":"576ec89c-f387-4dcb-a483-6c9bfa7a3eaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api"},{"key":"value","value":"//serviceID for the particular service you want to purchase
\n","type":"text"},{"key":"plan","value":"179","description":"//plan, Query GET data plans to get plans with serviceID
\n","type":"text"},{"key":"api","value":"ap_83c2ee17ca19e2c34e29a0f17cd5bd89","description":"// your api_key
\n","type":"text"},{"key":"amount","value":"","description":"//passed as an empty field
\n","type":"text"},{"key":"phone","value":"08140558898","description":"//phone number you want to subscribe
\n","type":"text"},{"key":"requestID","value":"duhfsibwudh3hg473rb73b7rb73br7v","description":"//optional
\n","type":"text"}]},"url":"https://api.gsubz.com/api/pay/","description":"Endpoint to send data to your customers
\napi is your API key and it can be gotten from here as API KEYmtncg, airtel_cg.. Query GET buy data to get the plans. They both must be spelt correctly with the proper case.//serviceID can be waec, neco or nabteb
\n","type":"text"},{"key":"plan","value":"waec","description":"//plan, can be waec, neco or nabteb
\n","type":"text"},{"key":"api","value":"ap_83c2ee17ca19e2c34e29a0f17cd5bd89","description":"// your api_key
\n","type":"text"},{"key":"amount","value":"","description":"//passed as an empty field
\n","type":"text"},{"key":"phone","value":"08140558898","description":"//phone number you want to subscribe
\n","type":"text"}]},"url":"https://api.gsubz.com/api/pay/","description":"Endpoint to send data to your customers
\nThe api is your API key and it can be gotten from here as API KEY
The serviceID allowed here are waec,neco,nabteb
There is only one plan per service waec or neco or nabteb
//serviceID
\n","type":"text"},{"key":"api","value":"ap_83c2ee17ca19e2c34e29a0f17cd5bd89","description":"//your api_key
\n","type":"text"},{"key":"amount","value":"100","description":"//amount of airtime, minimum is 100
\n","type":"text"},{"key":"phone","value":"08140558898","description":"//phone number
\n","type":"text"}]},"url":"https://api.gsubz.com/api/pay/","description":"Endpoint to send data to your customers
\napi is your API key and it can be gotten from here as API KEYmtn, airtel, etisalat, glo only.. They both must be spelt correctly with the proper case.// your api_key
\n","type":"text"}]},"url":"https://api.gsubz.com/api/balance/","description":"Endpoint to check user balance
\napi is your API key and it can be gotten from here as API KEY// your api_key
\n","type":"text"},{"key":"requestID","value":"7wbd7wbdw7d72g6vd","description":"//requestID passed during purchase
\n","type":"text"}]},"url":"https://api.gsubz.com/api/verify/","description":"Endpoint to check transaction status and response
\napi is your API key and it can be gotten from here as API KEY//required: mtn, airtel, glo, 9mobile
\n"},{"key":"value","value":"500","description":"//required: amount to generate, 100, 200, 400, 500
\n","type":"text"},{"key":"number","value":"1","description":"//required: number of pins to be generated, minimum is 10 for values below 500.
\n","type":"text"}]},"url":"https://api.gsubz.com/apiV2/generate/","description":"Endpoint to send generate recharge pins.
The api is your API key and it can be gotten from here as API KEY
The network allowed here are
airtelglo9mobilegloThey all must be spelt correctly with the proper case.
\n","urlObject":{"protocol":"https","path":["apiV2","generate",""],"host":["api","gsubz","com"],"query":[],"variable":[]}},"response":[{"id":"a7aec8c1-3744-41c8-9da7-13892416e8e6","name":"recharge pins/epins printing","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ap_83c2ee17ca19e2c34e29a0f17cd5bd89","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"network","value":"airtel","type":"text","description":"//required: mtn, airtel, glo, 9mobile"},{"key":"value","value":"500","description":"//required: amount to generate, 100, 200, 400, 500","type":"text"},{"key":"number","value":"1","description":"//required: number of pins to be generated","type":"text"}]},"url":"https://gsubz.com/apiV2/generate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/7.2.34"},{"key":"content-type","value":"application/json"},{"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":"388"},{"key":"date","value":"Tue, 03 May 2022 09:41:57 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"We Received your order, 1 of 1 delivered\\n Thank you for your patronage\",\n \"status\": \"success\",\n \"id\": \"c143e774874a59623aa928292d128f97\",\n \"network\": \"Airtel\",\n \"value\": \"500\",\n \"number\": \"1\",\n \"delivered\": \"1\",\n \"pending\": 0,\n \"pins\": [\n {\n \"pin\": \"5794977707301520\",\n \"sn\": \"26026825914918714922\"\n }\n ]\n}"}],"_postman_id":"669823de-ca94-49d3-bd90-787b435671ef"},{"name":"cable tv sub plans","id":"5c5234c3-1d62-4feb-b53f-3942787cc8fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.gsubz.com/api/plans?service=gotv","description":"https://gsubz.com/api/plans?service=mtn_sme
\nEnd Point to get a list of all available cable tv plans
\n\n\nuseful for getting the appropriate
\nplana particular cable subscription
List of available data services (parameters)
\nservice = serviceID
\nservice = gotv
\nservice = dstv
\nservice = startimes
\n//dstv, gotv, startimes
\n","type":"text/plain"},"key":"service","value":"gotv"}],"variable":[]}},"response":[{"id":"64f71cc1-daee-4e16-8fea-41a58940c830","name":"plans","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gsubz.com/api/plans?service=gotv","protocol":"https","host":["gsubz","com"],"path":["api","plans"],"query":[{"key":"service","value":"gotv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/7.2.34"},{"key":"content-type","value":"application/json"},{"key":"last-modified","value":"Tue, 11 Aug 2020 20:40:20 GMT"},{"key":"etag","value":"118b5e932f47541c6e5539c4bdb3dd71"},{"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":"947"},{"key":"date","value":"Tue, 03 May 2022 01:45:02 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"service\": \"GOTV\",\n \"PlanName\": \"variation_code\",\n \"fixedPrice\": true,\n \"plans\": [\n {\n \"displayName\": \"GOtv Jinja N1,900\",\n \"value\": \"gotv-jinja\",\n \"price\": \"1900\"\n },\n {\n \"displayName\": \"GOtv Jolli N2,800\",\n \"value\": \"gotv-jolli\",\n \"price\": \"2800\"\n },\n {\n \"displayName\": \"GOtv Max N4,150\",\n \"value\": \"gotv-max\",\n \"price\": \"4150\"\n },\n {\n \"displayName\": \"GOtv Smallie - monthly N900\",\n \"value\": \"gotv-smallie\",\n \"price\": \"900\"\n },\n {\n \"displayName\": \"GOtv Smallie - quarterly N2,400\",\n \"value\": \"gotv-smallie-3months\",\n \"price\": \"2400\"\n },\n {\n \"displayName\": \"GOtv Smallie - yearly N7,000\",\n \"value\": \"gotv-smallie-1year\",\n \"price\": \"7000\"\n }\n ]\n}"}],"_postman_id":"5c5234c3-1d62-4feb-b53f-3942787cc8fd"},{"name":"buy tv/decoder/cablesub","id":"457ba6f5-4c74-43a2-ae89-497d5725b646","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api"},{"key":"value","value":"//dstv, gotv, startimes
\n","type":"text"},{"key":"api","value":"ap_83c2ee17ca19e2c34e29a0f17cd5bd89","description":"//your api_key
\n","type":"text"},{"key":"variation_code","value":"gotv-smallie","description":"//query GET cable tv sub plans to get plans for various plans
\n","type":"text"},{"key":"phone","value":"08140558898","description":"//phone number, can be any number
\n","type":"text"},{"key":"amount","value":"","description":"//passed as empty string
\n","type":"text"},{"key":"customerID","value":"0000000000","description":"//IUC or Smartcard Number of the decoder
\n","type":"text"}]},"url":"https://api.gsubz.com/api/pay/","description":"Endpoint to send data to your customers
\napi is your API key and it can be gotten from here as API KEYgotv, dstv, startimes only.. They both must be spelt correctly with the proper case.//check comment above for available serviceID's
\n","type":"text"},{"key":"api","value":"ap_83c2ee17ca19e2c34e29a0f17cd5bd89","description":"//your api key
\n","type":"text"},{"key":"phone","value":"08140558898","description":"//phone number can be any number
\n","type":"text"},{"key":"customerID","value":"00000000000","type":"text","description":"//meter number
\n"},{"key":"amount","value":"1100","description":"//amount to be generated
\n","type":"text"},{"key":"variation_code","value":"prepaid","description":"//prepaid or postpaid
\n","type":"text"}]},"url":"https://api.gsubz.com/api/pay/","description":"Endpoint to send generate electricity tokens.
The api is your API key and it can be gotten from here as API KEY
The serviceID allowed here are
abuja-electric
eko-electric
ibadan-electric
ikeja-electric
jos-electic
Kaduna-electric
kano-electric
portharcourt-electric
aba-electric
yola-electric
benin-electric
enugu-electric
They all must be spelt correctly with the proper case.
\n","urlObject":{"protocol":"https","path":["api","pay",""],"host":["api","gsubz","com"],"query":[],"variable":[]}},"response":[{"id":"6feea696-24ff-42a7-b01e-f1ef4be2948d","name":"buy electric token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ap_83c2ee17ca19e2c34e29a0f17cd5bd89","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"serviceID","value":"kaduna_electric","type":"text"},{"key":"plan","value":"179","description":"{plan}","type":"text","disabled":true},{"key":"api","value":"ap_83c2ee17ca19e2c34e29a0f17cd5bd89","description":"{api_key}","type":"text"},{"key":"plan","value":"gotv-smallie","type":"text","disabled":true},{"key":"phone","value":"08140558898","description":"type number {phone}","type":"text"},{"key":"amount","value":"1100","description":"passed as empty string","type":"text"},{"key":"customerID","value":"00000000000","type":"text","description":"meter number"}]},"url":"https://gsubz.com/api/pay/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/7.2.34"},{"key":"last-modified","value":"Tue, 03 May 2022 02:00:59 GMT"},{"key":"clear-site-data","value":"\"cache\""},{"key":"content-type","value":"application/json"},{"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":"746"},{"key":"date","value":"Tue, 03 May 2022 02:01:00 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"status\": \"TRANSACTION_SUCCESSFUL\",\n \"description\": \"TRANSACTION_SUCCESSFUL\",\n \"content\": {\n \"transactionID\": 3574357094,\n \"requestID\": \"\",\n \"amount\": \"1100\",\n \"phone\": \"08140558898\",\n \"serviceID\": \"kaduna_electric\",\n \"amountPaid\": 1100,\n \"initialBalance\": \"1280\",\n \"finalBalance\": 180,\n \"image\": \"//gsubz.com/uploads/service/1867790347.png\",\n \"fee\": \"0\",\n \"serviceName\": \"Kaduna Electricity\",\n \"status\": \"TRANSACTION_SUCCESSFUL\",\n \"code\": 200,\n \"description\": \"TRANSACTION_SUCCESSFUL\",\n \"date\": \"2022-05-03T03:00:59+01:00\",\n \"diplayValue\": null\n },\n \"gateway\": {\n \"referrer\": \"\"\n }\n}"}],"_postman_id":"b224f410-8206-4074-89c6-3f44c81b71c6"}],"variable":[{"key":"serviceId","value":"mtn_sme"},{"key":"serviceID","value":"mtn_sme"}]}