RESELLER API v1.0

Welcome to the GetWellPay developer documentation. Use this guide to integrate our services.

AUTHENTICATION

Include your API Token in every request header or as a POST parameter.

PURCHASE DATA BUNDLE

Endpoint: https://www.getwellpay.com/api/v1/data

Request Parameters

Success Response

{
  "status": "success",
  "Status": "successful",
  "msg": "Transaction Successful",
  "trans_id": "BT12345678",
  "balance": "5000.00"
}
                

PURCHASE AIRTIME

Endpoint: https://www.getwellpay.com/api/v1/airtime

📺 CABLE TV SUBSCRIPTION

Supports every provider returned by GET /api/cable_providers, with real-time smartcard/IUC validation.

1. Validate Smartcard / IUC Number

Endpoint: https://www.getwellpay.com/api/validate_iuc   POST

{ "status": "success", "name": "JOHN DOE", "iuc": "1234567890" }

2. Subscribe Cable Package

Endpoint: https://www.getwellpay.com/api/cable   POST

⚡ ELECTRICITY BILL PAYMENTS

Supports every DisCo returned by GET /api/meter_providers, with instant prepaid token generation.

1. Validate Meter Number

Endpoint: https://www.getwellpay.com/api/validate_meter   POST

2. Pay Electricity Bill

Endpoint: https://www.getwellpay.com/api/electricity   POST

{ "status": "success", "msg": "Payment Successful", "token": "4392-1094-8493-2948", "units": "45.2 kWh" }

SEND BULK SMS

Endpoint: https://www.getwellpay.com/api/send_sms

Request Parameters

PURCHASE DATA CARD (DATA PIN)

Endpoint: https://www.getwellpay.com/api/purchase_datapin

Request Parameters

PURCHASE RECHARGE PIN (EPIN)

Endpoint: https://www.getwellpay.com/api/purchase_rechargepin

Request Parameters

PURCHASE EXAM PIN

Endpoint: https://www.getwellpay.com/api/purchase_exam

Request Parameters

1. LIST IDENTITY SERVICES & LIVE PRICING

Endpoint: https://www.getwellpay.com/api/identity_services   GET

Fetch real-time catalog of all enabled identity and TIN verification services along with the exact fee that will be debited for your account tier.

Supported Service Codes & Real-time API Fees

Response Sample

{
  "status": "success",
  "msg": "Identity services catalog retrieved",
  "data": [
    {
      "service_code": "nin_phone",
      "name": "NIN Search with Phone Number",
      "fee": 150.00,
      "description": "Verify NIN details using registered phone number"
    },
    {
      "service_code": "cac_tin",
      "name": "CAC Number to TIN",
      "fee": 200.00,
      "description": "Lookup Corporate Tax Identification Number via CAC RC/BN"
    }
  ]
}

2. UNIFIED IDENTITY & TIN VERIFICATION (MASTER ENDPOINT)

Endpoint: https://www.getwellpay.com/api/identity_verify   POST

Single master endpoint powering all 8 identity, TIN, and phone searches. Debits wallet atomically and provides automatic immediate refunds if the record cannot be verified or provider downtime occurs.

Request Parameters

Success Response

{
  "status": "success",
  "msg": "Identity verification completed successfully",
  "data": {
    "ref": "IDNIN8F1B94C172978",
    "service_code": "nin_phone",
    "data": {
      "firstname": "IBRAHIM",
      "middlename": "MUSA",
      "surname": "BELLO",
      "birthdate": "1992-05-14",
      "gender": "male",
      "phone": "08012345678",
      "masked_phone": "0801****678",
      "masked_nin": "123****8901",
      "residence_state": "Kano",
      "residence_lga": "Nassarawa",
      "tin": "23891048-0001",
      "tax_office": "Kano Central Tax Office",
      "company_name": "ACME ENTERPRISES LTD",
      "network": "MTN",
      "carrier": "MTN Nigeria",
      "photo": "data:image/jpeg;base64,..."
    }
  }
}

Multi-Language Code Samples

cURL

curl -X POST "https://www.getwellpay.com/api/identity_verify" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service_code": "nin_phone",
    "query_value": "08012345678",
    "consent": true
  }'

PHP (cURL)

<?php
$payload = [
    'service_code' => 'nin_phone',
    'query_value'  => '08012345678',
    'consent'      => true
];

$ch = curl_init('https://www.getwellpay.com/api/identity_verify');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => json_encode($payload),
    CURLOPT_HTTPHEADER     => [
        'Authorization: Token YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
print_r($result);

Python (requests)

import requests

url = "https://www.getwellpay.com/api/identity_verify"
headers = {
    "Authorization": "Token YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "service_code": "nin_phone",
    "query_value": "08012345678",
    "consent": True
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

Node.js (fetch)

const response = await fetch('https://www.getwellpay.com/api/identity_verify', {
  method: 'POST',
  headers: {
    'Authorization': 'Token YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    service_code: 'nin_phone',
    query_value: '08012345678',
    consent: true
  })
});
const data = await response.json();
console.log(data);

VERIFY NIN (NIN LOOKUP)

Endpoint: https://www.getwellpay.com/api/verify_nin   POST

Returns verified NIN holder details (name, DOB, address, phone). A lookup fee of ₦150.00 is charged per request.

Request Parameters

Success Response

{
  "status": "success",
  "msg": "NIN verified successfully",
  "data": {
    "ref": "NIN4F2A1B...",
    "data": {
      "nin": "12345678901",
      "firstname": "John",
      "middlename": "Doe",
      "surname": "Smith",
      "gender": "m",
      "birthdate": "1990-01-15",
      "phone": "08012345678",
      "address": "12 Main St, Lagos",
      "state": "Lagos",
      "lga": "Ikeja"
    }
  }
}

GENERATE NIN SLIP

Endpoint: https://www.getwellpay.com/api/nin_slip   POST

Generate an official downloadable/printable NIN slip. Each type has a different fee:

Request Parameters

Success Response

{
  "status": "success",
  "msg": "NIN Slip generated successfully",
  "data": {
    "ref": "NSL4F2A1B...",
    "slip_type": "regular",
    "slip_url": "https://api.aspget.com/slips/xxx.pdf",
    "data": { ... }
  }
}

VERIFY BVN

Endpoint: https://www.getwellpay.com/api/verify_bvn   POST

Returns verified BVN holder details. A fee of ₦150.00 is charged per request.

Request Parameters

Success Response

{
  "status": "success",
  "msg": "BVN verified successfully",
  "data": {
    "ref": "BVN9A3D2C...",
    "data": {
      "bvn": "22345678901",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "01-Jan-1990",
      "phoneNumber": "08012345678"
    }
  }
}

🏆 BETTING WALLET FUNDING

Validate player accounts and fund betting wallets programmatically. Powered by MerryBills. A service charge is added to each funding request.

LIST BETTING PLATFORMS

Endpoint: https://www.getwellpay.com/api/betting_platforms   GET

Returns all active betting platforms with their service_id, minimum and maximum funding amounts.

Response Sample

{
  "status": "success",
  "data": [
    { "id": 1, "name": "SportyBet", "service_id": "sportybet", "min_amount": 100, "max_amount": 500000 },
    { "id": 2, "name": "Bet9ja",    "service_id": "bet9ja",    "min_amount": 100, "max_amount": 500000 }
  ]
}

VALIDATE BETTING ACCOUNT

Endpoint: https://www.getwellpay.com/api/validate_betting_id   POST

Verify a player's account ID exists on the selected platform before funding. No fee charged for this lookup.

Request Parameters

FUND BETTING WALLET

Endpoint: https://www.getwellpay.com/api/fund_betting   POST

Fund a player's betting wallet. The funding amount plus a service charge are deducted from your wallet.

Request Parameters

Success Response

{
  "status": "success",
  "msg": "Betting wallet funded successfully",
  "data": {
    "ref": "BETAPI4F2A..."
  }
}

⚡ INTERACTIVE API PLAYGROUND

Test the B2B endpoints directly from your browser. Input your parameters below to execute real-time VTU calls.

Technical Support: support@getwellpay.com.ng