This application gives room for any third party to integrate to VAS2Nets billers’ platform. Each biller is categorized in a logical group depending on the actual service that the biller is offering. Few example of billers are Startimes, DSTV Subscription, Abuja Electricity Distribution Company (Prepaid), Enugu Electricity Distribution Company (Postpaid), NairaBet, WAEC Pin, BangBet,Smile Recharge, MTN Airtime, Airtel Data etc while examples of biller categories are Electricity Distribution, Television (Multichoice Network), Educational, Betting and/or Lottery, Banking Operation, Virtual TopUp etc.
\nEach service supports two main APIs:
\nValidation API – to verify and return customer details
\nPayment API – to initiate payment only after successful validation
\nValidation is mandatory before payment to avoid failed transactions (e.g., invalid smartcard or mobile numbers). Some services are bouquet-based, requiring the use of the bouquet retrieval API to display valid packages.
\nFailed transactions are automatically and instantly reversed.
\nThis API uses Basic Authentication.
\nImportant – To successfully make API requests, your source IP address must be whitelisted.
\nDevelopment Environment:
\nYou can whitelist your IP directly via the Reconciliation Portal:
\nhttps://b2bsandbox.v2nportal.com
\nProduction Environment:
\nYou are expected to send your IP address via email to the VAS2Nets support team to request whitelisting.
\nThis returns every necessary technical detail of the third party’s account.
\n","urlObject":{"host":["https://b2bapi.v2napi.com/dev/meta/getDetails"],"query":[],"variable":[]}},"response":[{"id":"018c3a0b-9d36-4a20-815c-b8d570b70807","name":"failed","originalRequest":{"method":"GET","header":[],"url":"https://b2bapi.v2napi.com/{{SANDBOX_URI}}meta/getDetails"},"status":"Authorization Required","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Nov 2023 08:42:28 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"message\": \"invalid api credentials\",\n \"description\": \"access denied\"\n}"},{"id":"a3e5e055-9d10-401c-861f-d18b21955989","name":"pass","originalRequest":{"method":"GET","header":[],"url":"https://b2bapi.v2napi.com/{{SANDBOX_URI}}meta/getDetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Nov 2023 08:43:52 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"421"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"profile\": {\n \"id\": \"vas2net-office\",\n \"name\": \"Vas2Nets Technologies Limited\",\n \"category\": \"User\",\n \"emailAddress\": \"support@vas2nets.com\",\n \"status\": \"Active\",\n \"canAccessAPI\": true,\n \"whitelistedIPs\": [\n \"102.90.43.128\",\n \"102.90.44.133\",\n \"102.90.45.66\",\n \"197.211.58.82\"\n ],\n \"canAccessReconciliationPortal\": true,\n \"type\": \"Prepaid\"\n },\n \"balance\": {\n \"wallet\": \"996271.5\",\n \"commission\": \"7795\"\n }\n },\n \"description\": \"request has been processed\"\n}"}],"_postman_id":"60c1d131-5dd2-4594-866f-3fd712e2ef3e"},{"name":"Get All Biller Categories","id":"cb250fb4-564e-4635-9471-59774d2727cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b2bapi.v2napi.com/dev/meta/getBillerCategories","description":"This returns all the categories in which all the billers are grouped into. Every
biller in the same category has the same API request and response format with
very few exceptions.
This endpoint returns a list of all available billers. It accepts the following optional query parameter to filter results:
\ncategory (optional)— Filters billers by the specified category (e.g., vtu).
billerId (optional) – Filter by specific biller ID (e.g., DSTV)
isBouquetService (optional) – Filter billers that are bouquet-based (Yes or No)
This API allows the third party to retrieve the list of billers that have been specifically profiled for their account.
It supports the following optional query parameters for filtering the results:
category (optional) – Filter by biller category (e.g., disco)
billerId (optional) – Filter by specific biller ID (e.g., DSTV)
isBouquetService (optional) – Filter billers that are bouquet-based (Yes or No)
These are preliminary web services that provide essential information about the actual transactional web services. They serve as a guide and offer the necessary background context for integrating and interacting with transactional endpoints.
\nThe meta services include: Profile Details, Biller Categories, VAS2Nets B2B Billers, and Third Party’s Billers.
\n","_postman_id":"46d0ef97-c2f3-4b71-afb4-e5c4470f50d8","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API accepts a single mandatory parameter:
\nrequestId – The mandatory request ID of the transaction that the third party wants to requery.Third-party platforms can use this service to double confirm the final status of any transaction . Please note the following guidelines:
\nTime Limit: Only transactions that occurred within the last two (2) months are eligible for status requery using this service.
\nOlder Transactions: For transactions older than two months, a requery is not supported via the API. Such cases must be escalated to the VAS2Nets support team for manual resolution.
\nKYC Requests: KYC verification service requests are not eligible for status requery under any circumstance.
\ninternet – this segment represents the service category (e.g., internet, tv, vtu, etc.).
SMILE – this segment represent a specific biller under that category (e.g., SMILE, MTN-DATA, etc.)
This service returns the list of available or active bouquet packages for supported services. Customers are restricted to purchasing only from these predefined options. Custom bouquets are not supported.
\n","_postman_id":"bfd606c7-12ff-43c0-900d-03a0747d334b","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The folowing are the request payload to validate default phone Number Network:
\nbillerId (optional) – The unique identifier of the biller.
customerId – The customer’s mobile phone number. Any valid format
requestId – The third party’s unique identifier for this request.
The following are the request payload to successfully purchase Airtime:
\nbillerId – The unique identifier of the biller.
customerId– The customer’s mobile phone number.
requestId– Third party’s unique identifier for this request.
amount– The value of the airtime to be purchased or the price of the data bundle to be purchased.
The following are request parameters for Data purchase after a successful validatin:
\nbillerId – The unique identifier of the biller.
customerId – The customer’s mobile phone number.
requestId – Third party’s unique identifier for this request.
bouquetCode – The bouquet associated with the transaction.
This service is used to validate all billers under the VTU (Virtual Top-Up) category. It can also be used to identify the default network operator associated with a customer's mobile number.
Note:
Third-party platforms are encouraged to allow end users the option to select a network operator different from the detected default before initiating an airtime or data transaction.
Please note that for airtime and data biller services, validation is not a prerequisite for making a payment. However, the third party may use this validation service when necessary to enhance accuracy or user experience.
\n","_postman_id":"2f218cbc-e156-4734-8d3d-37c8a1b833d9","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"billerId– The unique identifier of the biller.
requestId– Third party’s unique identifier for this request.
bouquetCode– The bouquet code for the airtime recharge card to be purchased.
amount– The price of the bouquet
These services generate airtime recharge card PINs and also return a USSD string that the end user can dial to load the airtime.
\n","_postman_id":"9c2e8a36-33eb-40ce-b054-c0baf21bf58e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The following parameters are required to validate a customer's meter or account number:
\nbillerId– The unique identifier of the biller.
customerId– Customer’s meter number or account number.
requestId– Third party’s unique identifier for this request.
The following parameters are required to proceed after a successful validation:
\nbillerId – The unique identifier of the biller.
customerId – Customer’s meter number or account number.
requestId– Third party’s unique identifier for this request.
customerName– The name of the customer, as returned during validation.
customerAddress – The address of the customer, as returned during validation.
emailAddress (optional)– Customer’s email address.
phoneNumber (optional) – Customer’s phone number.
Third parties can make use of these services to validate customer meter number or account number and also to initiate a payment request on behalf of the customers.
\n","_postman_id":"9f5981d3-6308-4eae-a0e8-95c06ea6f6cf","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The following are the request payload parameters for DSTV/GOTV Validation for Upgrade/Downgrade:
\nbillerId – The unique identifier of the biller.
customerId – Customer’s smartcard number.
requestId – Third party’s unique identifier for this request.
The following are the request payload parameters for DSTV/GOTV Validation for renewal:
\nbillerId – The unique identifier of the biller.
customerId – Customer’s smartcard number.
requestId – Third party’s unique identifier for this request.
The following are the request payload parameters for DSTV/GOTV upgrate/Downgrade purchase after a successful validation :
\nbillerId – The unique identifier of the biller.
customerId – Customer’s smartcard number.
requestId – Third party’s unique identifier for this request.
amount– The amount the customer wants to pay or the price of the bouquet the customer wants to subscribe to.
customerName– The name of the customer obtained during validation.
customerNumber (optional) – The number tied to the smartcard on Multichoice’s platform, obtained during validation. Required for DSTV and GOTV billers.
bouquetCode (optional) – The code of the bouquet the customer wants to subscribe to. Required for DSTV and GOTV billers.
addonCode (optional) – The code of any addon the customer wants. An addon is like icing on a cake — an additional feature or service added to a bouquet.
Note: DSTV renewal and GOTV renewal are NOT bouquet-oriented. Third parties are
advised to use these services whenever customers want to renew their existing
GOTV/DSTV subscription.
The following are the request payload parameters for DSTV/GOTV renewal purchase after a successful validation :
\ncustomerId – Customer’s smartcard number.
billerId – The unique identifier of the biller.
requestId – Third party’s unique identifier for this request.
amount– The amount the customer wants to pay.
customerName– The name of the customer obtained during validation.
The following are the request payload parameters :
\ncustomerId – Customer’s smartcard number.
billerId – The unique identifier of the biller.
requestId – Third party’s unique identifier for this request.
Note: Startimes is also a bouquet service. However, startimes gives room for their customer to pay any amount of their choice at any time, and startimes will charge the customer a daily tariff depending on the bouquet the customer is subscribed to.
\nThe following are the request payload for payment after a successful validation:
\nbillerId – The unique identifier of the biller.
customerId – Customer’s smartcard number.
requestId – Third party’s unique identifier for this request.
amount– The amount the customer wants to pay or the price of the bouquet the customer wants to subscribe to.
customerName– The name of the customer obtained during validation.
bouquetCode (optional) – The code of the bouquet the customer wants to subscribe to
The following are the request payload for payment after a successful validation:
\nbillerId – The unique identifier of the biller.
customerId – Customer’s smartcard number.
requestId – Third party’s unique identifier for this request.
amount– The amount the customer wants to pay or the price of the bouquet the customer wants to subscribe to.
customerName– The name of the customer obtained during validation.
bouquetCode (optional) – The code of the bouquet the customer wants to subscribe to
This category includes television subscription services such as DSTV subscription, DSTV renewal, GOTV subscription, GOTV renewal, and Startimes subscription.
\nDSTV subscription and GOTV subscription are bouquet services; customers can only purchase predefined active bouquets. Third parties should use these services primarily for customers looking to upgrade or downgrade their current DSTV or GOTV subscriptions.
\nDSTV renewal and GOTV renewal are not bouquet-oriented. These services should be used when customers want to renew existing subscriptions. Occasionally, Multichoice offers commissions that customers can only benefit from through the renewal services.
\nStartimes is also a bouquet service but allows customers to pay any amount at any time. Startimes applies a daily tariff based on the bouquet the customer is subscribed to.
\nThe following parameters are required for Bet validation
\nbillerId– The unique identifier of the biller.
customerId– Customer’s bet ID.
requestId– Third party’s unique identifier for this request.
The following parameters are required for payment after a successful validation:
\nbillerId– The unique identifier of the biller.
customerId– Customer’s bet ID.
customerName– The name of the customer obtained during validation.
amount– The amount the customer wants to pay into their betting wallet.
requestId– Third party’s unique identifier for this request.
Third parties can make use of these services to validate a customer's betting or lottery ID and to initiate a payment request on behalf of the customer.
\n","_postman_id":"a535e0bf-73a8-427d-a8ec-99315f310090","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The following parameters are required for internet validation
\nbillerId– The unique identifier of the biller.
customerId– Customer’s device ID.
requestId– Third party’s unique identifier for this request.
The following parameters are required for payment after a successful validation:
\nbillerId– The unique identifier of the biller.
customerId– Customer’s device ID.
customerName– The name of the customer obtained during validation.
customerAddress– The address of the customer obtained during validation.
amount– The amount of the bouquet the customer wants to purchase.
bouquetCode– The code of the bouquet the customer wants to buy.
requestId– Third party’s unique identifier for this request.
Third parties can make use of these services to validate a customer's internet service account or ID and to initiate a payment request on behalf of the customer.
\n","_postman_id":"9ac8856f-5f3a-4223-9d82-144dae8cc11c","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The following parameters are required for bank service validation:
\nbillerId– The unique identifier of the biller.
customerId– Beneficiary account number.
requestId– Third party’s unique identifier for this request.
bankCode– The code of the beneficiary’s bank, obtained from the bouquet retrieval service.
The following parameters are required for payment after a successful validation:
\nbillerId– The unique identifier of the biller.
customerId– Beneficiary account number.
customerName– The name of the beneficiary obtained during validation.
amount– The amount (including service charge) that the customer wants to transfer to the beneficiary’s account.
requestId– Third party’s unique identifier for this request.
senderName– The customer’s name on the third party’s platform. This will be included in the credit alert sent to the beneficiary.
bankCode– The code of the beneficiary’s bank, obtained from the bouquet retrieval service.
sessionId– A unique identifier for the transaction within the Nigerian banking system.
beneficiaryReference– A unique identifier for the beneficiary within the Nigerian banking system.
kycLevel– The KYC level of the beneficiary.
narration (optional) – A short comment (max 15 characters) that will appear in the credit alert sent to the beneficiary.
The only service under this category is fund transfer (i.e payout service). It allows customers to send money to any beneficiary’s bank account in Nigeria. To get the list of banks, third parties are advised to make use of the bouquet API.
\n","_postman_id":"8a2bc213-45ad-4a34-b8a1-892223628682","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Note: Please note that a validation service is not available for WAEC.
\nThe following parameters are required for education service validation:
\nbillerId– The unique identifier of the biller.
customerId – Profile code of the student.
bouquetCode– The code of the bouquet the user wants to purchase.
The following parameters are required for payment after a successful validation:
\nbillerId– The unique identifier of the biller.
requestId– Third party’s unique identifier for this request.
bouquetCode– The code of the bouquet the user wants to purchase.
amount– The price of the bouquet.
customerName (optional) – The name of the customer.
Third parties can make use of these services to validate a customer's educational service account and to initiate a payment request on behalf of the customer.
\n","_postman_id":"e8da5768-172a-4d88-bc7d-d4768f7f6b1d","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The following parameters are required for education kyc validation:
\nbillerId– The unique identifier of the biller.
customerId– Customer’s identifier; this could be BVN, NIN, or phone number.
requestId– Third party’s unique identifier for this request.
Third parties can make use of these services to verify the details (i.e BVN, NIN
and Phone number etc) of their customers.
This is the development environment API.
\n","_postman_id":"6f048fd3-ada5-4ab8-9c4b-39376faeffb4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"