API Documentation

 

aidpay.com.ng API Documentation

 

Our API allows you to easily integrate bill payment services available on the aidpay.com.ng platform on your mobile or web application.

 

Base URL: https://aidpay.com.ng/api

Airtime VTU API Integration

VTU Airtime API Integration

This section contains your RESTful API for Airtime VTU API integration.

 

Authentication

Our API uses API Key for Authentication.

Please use the following details for authentication

Apikey = kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

API Key: Your Gateway API Key

Please create your API key here Create API Key

 

Purchase products

Airtime VTU services can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/airtime

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
network R String Network as specified. These includes, mtn, airtel, glo, etisalat
phone R Number The phone number to receive the airtime
amount R Number The amount you wish to recharge
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

Recharge Card PINs Generator API Integration

Recharge Card PINs API Integration

This section contains your RESTful API for Recharge card PIN Generator API integration.

 

Authentication

The ePINs API uses API Key for Authentication.

Please use the following details for authentication

Apikey = kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

API Key: Your Gateway API Key

Please create your API key here Create API Key

 

Purchase products

Recharge card PIN services can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/epin

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String service name as specified. This should be, epin
network R String Network as specified. These includes, mtn, airtel, glo, etisalat
pinDenomination R Number The denomination of pin to generate. These includes,

Denominations

Service variation

100

1

200

2

400

4

500

5

750

7.5

1000

10

1500

15
pinQuantity R Number The number of pins to generate
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

    {
    "code":101,
    "description":{
    "status":"TRANSACTION SUCCESSFUL",
    "PIN":"02357485946496925482100BC\r",
    "network":"mtn",
    "pinDenomination":"100",
    "pinQuantity":1,
    "product_name":"MTN ePIN 100",
    "TransactionDate":"2023-03-20 05:58:AM"
     }
    }

DATA CARD API Integration

Purchase DATA CARD

DATA CARD services can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/datacard

Request Method: POST

Network: as specified in the parameters below;

Network

Service variation
MTN
01

Airtel

04

9Mobile

03

Glo

02

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service id should be datacard.
network R String Network as specified in the service variation above.
pinQuantity R Number The number of DATA CARD PINs to generate
DataPlan R Number The Data plan variation includes 1500; for 1.5GB
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

 {
    "code": 101,
    "description": {
        "status": "TRANSACTION SUCCESSFUL",
        "PIN": "808346012S\n541093716S\n",
        "network": "MTN",
        "pinDenomination": "1500",
        "pinQuantity": "2",
        "product_name": "MTN DATACARD 1.5 GB ",
        "TransactionDate": "2023-03-19 03:12:PM"
    }
}

Electricity Payment API Integration

Electricity Payment API Integration

This section contains your RESTful API for Electricity Payment API integration.

 

Authentication

The ePINs API uses API Key for Authentication.

Please see the following sample API key for authentication

Apikey = kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

API Key: Your Gateway API Key

Please create your API key here Create API Key

 

VALIDATE METER NUMBER

You can validate meter number with the following endpoint:

Endpoint URL: {{baseurl}}/merchant-verify

Endpoint URL: {{baseurl}}/electric-verify

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, ikeja-electric, eko-electric, portharcourt-electric, jos-electric, kano-electric, ibadan-electric, enugu-electric, abuja-electric,benin-electric

smartNo R Number The meter number to load the electricity token
type R String This is the meter type. Example: prepaid or postpaid

 

EXPECTED RESPONSE

{
    "code": 119,
    "description": {
        "Customer": "PAUL BECKY",
        "Address": "ELEME - PORTHARCOURT",
        "MeterNumber": "1022101199113"
    }
}

 

Generate Token

This endpoint allows you to generate electricity token using meter number.

Endpoint URL: {{baseurl}}/biller

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, ikeja-electric, eko-electric, portharcourt-electric, jos-electric, kano-electric, ibadan-electric,benin-electric
accountno R Number The meter number to load the electricity token
vcode R String This is the meter type. Example: prepaid or postpaid
amount R Number The amount of electricity token you want to buy
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,
"description":{"Status":"TRANSACTION SUCCESSFUL",
"Token":"40364652026905256691",
"Units":"500 kWh",
"meterNumber":"100221233",
"product_name":"Ikeja Electric Payment - PHCN"
	
    }
}

TV Payment API Integration

TV Payment API Integration

This section contains your RESTful API for TV Payment API integration.

 

Authentication

The ePINs API uses API Key for Authentication.

Please see the following sample API key for authentication

Apikey = kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

API Key: Your Gateway API Key

Please create your API key here Create API Key

 

GET VARIATION CODES

Using a GET method, the ePINs variation codes for GOTV,DSTV, Startimes bouquets can be accessed with the endpoint below:

GOTV Variations: {{baseurl}}/variations?service=gotv
DSTV Variations: {{baseurl}}/variations?service=dstv
Startime Variations: {{baseurl}}/variations?service=startimes

View Gotv variation code View Dstv variation code View Startimes variation code

 

VALIDATE SMARTCARD/IUC NUMBER

You can validate smartcard/IUC number with the following endpoint:

Endpoint URL: {{baseurl}}/merchant-verify

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, dstv, gotv, startimes
smartNo R Number The smartcard or IUC number to make the subscription on
type R String same as service parameter.

 

EXPECTED RESPONSE

{"code":119,
"description":{"Customer":"PAUL BECKY",
"Due_Date":"2019-07-23T00:00:00",
"Status":"Open"
	}
}

 

Recharge Decoder

This endpoint allows you to recharge GOTV/DSTV/Startimes decoder using it’s smartcard/IUC number.

Endpoint URL: {{baseurl}}/biller

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, dstv, gotv, startimes
accountno R Number The smartcard or IUC number to make the subscription on
vcode R String This is the meter type. Example: prepaid or postpaid
amount R Number The amount of electricity token you want to buy
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

Bet9ja Payment API Integration

Bet9ja Payment API Integration

This section contains your RESTful API for Bet9ja Payment API integration.

 

Authentication

The ePINs API uses API Key for Authentication.

Please see the following sample API key for authentication

Apikey = kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

API Key: Your Gateway API Key

Please create your API key here Create API Key

 

VALIDATE Bet9ja ACCOUNT NUMBER

You can validate Bet9ja Account number with the following endpoint:

Endpoint URL: {{baseurl}}/bet-verify

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
customerId R Number The Bet9ja customer number to make the subscription on

 

EXPECTED RESPONSE

{"code":119,
"description":{"Customer":"PAUL BECKY",
"Due_Date":"2019-07-23T00:00:00",
"Status":"Open"
	}
}

 

Recharge Bet9ja Account

This endpoint allows you to recharge Bet9ja account using it’s Customer ID.

Endpoint URL: {{baseurl}}/bet9ja

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
customerId R Number The Bet9ja customer Number to make the payment on
reference R String The reference number generated during bet9ja account validation
amount R Number The amount to credit on bet9ja account
customerName R String Customer Name generated during Bet9ja account validation
request_id R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

SME Data Topup API Integration

Purchase SME Data

SME Data services can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/data

Request Method: POST

Network: as specified in the parameters below;

Network

Service variation
MTN
01

Airtel

04

9Mobile

03

Glo

02

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified in the service variation above.
MobileNumber R Number The phone number to receive the SME Data
DataPlan R Number The SME Data plan Variation code.
Network Plan plancode Amount
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

CG LITE Data Topup API Integration

Purchase CGLITE Data

CG LITE Data services can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/data

Request Method: POST

Network: as specified in the parameters below;

Network

Service variation
MTN
01

Airtel

04

9Mobile

03

Glo

02

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified in the service variation above.
MobileNumber R Number The phone number to receive the Data
DataPlan R Number The CG LITE Data plan Variation code.
Network Plan plancode Amount
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE


    {"code":101,
    "description": {"Status":"successful",
    "ProductName":"MTN 1GB (CG_LITE)","Network":null,
    "TransactionRef":"3807689167291450",
    "Date":"2023-06-28 12:32:PM"}}

GIFTING Data API Integration

Purchase GIFTING Data

GIFTING Data services can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/data

Request Method: POST

Network: as specified in the parameters below;

Network

Service variation
MTN
01

Airtel

04

9Mobile

03

Glo

02

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified in the service variation above.
MobileNumber R Number The phone number to receive the GIFTING Data
DataPlan R Number The Gifting Data Variation code. These includes;
Network Plan plancode Amount
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

WAEC Result Checker API Integration

Purchase WAEC RESULT CHECKER PIN

WAEC Result checker PIN can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/waec

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng. Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified. These includes, waec
vcode R String The code of the variation. That is waecdirect
amount R Number The amount of the variation (as specified in the VARIATIONS endpoint )
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,"description":{"Content":"Serial No:WRN800312772, pin: 249714527294",
"product_name":"WAEC Result Checker PIN","TransactionDate":"2021-11-01 02:51:PM"}}

NECO Result Checker API Integration

Purchase NECO RESULT CHECKER PIN

NECO result Checker PIN can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/neco

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified. These includes, neco
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

 

EXPECTED RESPONSE

{"code":101,"description":{"Status":"TRANSACTION SUCCESSFUL","PIN":"35609198364227070191",
"TransactionRef":"45060440786","product_name":"NECO Result Checker",
"Date":"2021-11-01 02:51:PM"}}

Spectranet PIN Purchase API Integration

Purchase Spectranet PIN

Spectranet PIN services can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/spectranet

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng. Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified. These includes, spectranet
pinNo R Number The number of Spectranet PINs to purchase
amount R Number The amount of the variation (as specified in the VARIATIONS endpoint )
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

Universal Motor Insurance API Integration

Purchase Universal Motor Insurance

Universal Motor Insurance can be purchased with the endpoint below:

Endpoint URL: {{baseurl}}/ui-insurance

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified. These includes, ui-insure
accountno R String The plate Number of the vehicle you wish to make the insurance payment on. Example: KUJ480BH
vcode R String The code of the variation. That includes Commercial, Private, Tricycles
amount R Number The amount of the variation (as specified in the VARIATIONS endpoint )
Phone R Number The phone number of the customer or recipient of this service
insuredName R String Name of the owner of the insured vehicle
engineNo R String Engine Number of the insured vehicle
chasisNo R String Chasis Number of the insured vehicle
plateNo R String Same as the accountno above
plateNo R String Same as the accountno above
vehicleMake R String Make of the insured vehicle
vehicleColor R String Color of the insured vehicle
vehicleModel R String Model of the insured vehicle
yearofMake R String The year the insured vehicle was made.
contactAddress R String Contact Address of the vehicle owner
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","Download Certificate":"https://3rdparty.universalinsuranceonline.com/PrintCertificate.aspx?Data=UPMSB001190319136038",
"transaction_date":"2020-04-17 07:04:19"
}}

Wallet Balance API

Wallet Balance API

This section contains your RESTful API to get wallet balance.

 

Authentication

The ePINs API uses API Key for Authentication.

Please see the following sample API key for authentication

Apikey = kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

API Key: Your Gateway API Key

Please create your API key here Create API Key

 

 

GET WALLET BALANCE

This endpoint allows you to get epins.com.ng wallet balance .

Endpoint URL: {{baseurl}}/balance

Service: as specified in the fields below;

 

PARAMETER Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at aidpay.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

 

 

EXPECTED RESPONSE


{"code":101,

"description":{"BALANCE":"45000.00",
	}

}