Getting Paycheap APIs
Paycheap API
Integrate Paycheap APIs into your website or mobile application. Available services include VTU API, Data API, TV Subscription API, Electricity API, Betting API, and Cash Transfer API. Our fast and secure APIs help you scale your business and keep your customers satisfied.
Base URL
All API requests should be made to:
https://paycheap.ng/apiAuthentication Endpoints
1. Login
Endpoint: /login
Method: POST
| Parameter | Type | Description |
|---|---|---|
| string | User email address | |
| password | string | User password |
Success Response:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbG..."
}Authentication
To access protected endpoints, include your Bearer Token in the request header:
Authorization: Bearer TOKENUser Profile
Endpoint: /user-profile
Method: GET
1. Airtime
Buy Airtime
Endpoint: /buy-airtime
Method: POST
| phone | string | 11-digit phone number |
| amount | numeric | Amount to purchase |
Check Airtime Status
Endpoint: /check-airtime-status
Method: POST
| transaction_id | string | Transaction ID |
2. Data
Get Networks
Endpoint: /get-networks
Method: POST
Get Data Plans
Endpoint: /get-data-plans
Method: POST
| network_id | integer | Network ID |
Buy Data
Endpoint: /buy-data
Method: POST
| network_id | integer | Network ID |
| data_plan | string | Data plan code |
| phone | string | Phone number |
3. Electricity
Get All Vendors
Endpoint: /all-electricity-vendors
Method: GET
Verify Meter Number
Endpoint: /verify-meter-number
Method: POST
| category_id | string | Vendor ID |
| account | string | Meter or account number |
Purchase Electricity
Endpoint: /electricity-subscription
| electricity_company_code | string | Company code |
| electricity_company_name | string | Company name |
| meter_number | string | Meter number |
| account_name | string | Account name |
| amount | numeric | Amount |
Get Meter Token
Endpoint: /get-meter-token
| transaction_id | integer | Transaction ID |
| order_id | string | Order ID |
4. TV Subscription
Verify Customer
Endpoint: /verify-tv-customer
| cable_tv | string | Product code |
| smartcard_no | string | Smartcard number |
Subscribe TV
Endpoint: /tv-subscription
| smartcard_no | string | Smartcard number |
| customer_name | string | Customer name |
| subscription_package | string | Package code |
5. Cash Transfer
Send Cash
Endpoint: /send-cash
| amount | numeric | Amount |
| bank_code | string | Bank code |
| account_number | string | Account number |
| account_name | string | Beneficiary name |
| sender_name | string | Sender name |
6. Betting
Get Betting Providers
Endpoint: /get-betting-providers
Method: GET
Verify Betting Account
Endpoint: /betting-verification/{product}/{customerId}
Method: GET
| product | string | Provider slug or ID |
| customerId | string | Customer user ID |
Fund Betting Wallet
Endpoint: /fund-bet-wallet
| account_id | string | Customer account ID |
| account_name | string | Customer name |
| provider | string | Betting provider |
| amount | numeric | Amount |