ePINs API Documentation

 

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

 

VTU Airtime API Integration

This section contains your RESTful API for Airtime VTU 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

Airtime VTU services can be purchased with the endpoint below:

Base URL: https://epins.com.ng/api/airtime

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.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"
}}

MTN Share Airtime API Integration

This section contains your RESTful API for MTN Share Airtime 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

MTN Share Airtime services can be purchased with the endpoint below:

Base URL: https://epins.com.ng/api/mshare

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
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"
}}

Universal Airtime API Integration

This section contains your RESTful API for universal airtime 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 Airtime

Airtime VTU services can be purchased with the endpoint below:

Base URL: https://epins.com.ng/api/onecard

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
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"
}}

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:

Base URL: https://epins.com.ng/api/merchant-verify

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, ikeja-electric, eko-electric, portharcourt-electric, jos-electric, kano-electric, ibadan-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.

Base URL: https://epins.com.ng/api/biller

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, ikeja-electric, eko-electric, portharcourt-electric, jos-electric, kano-electric, ibadan-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

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: https://epins.com.ng/api/variations?service=gotv
DSTV Variations: https://epins.com.ng/api/variations?service=dstv
Startime Variations: https://epins.com.ng/api/variations?service=startimes

 

VALIDATE SMARTCARD/IUC NUMBER

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

Base URL: https://epins.com.ng/api/merchant-verify

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at epins.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.

Base URL: https://epins.com.ng/api/biller

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.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"
}}

Smile 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

 

VALIDATE SMILE ACCOUNT NUMBER

You can validate Smile number with the following endpoint:

Base URL: https://epins.com.ng/api/merchant-verify

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at epins.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, smile-direct, gotv, startimes
smartNo R Number The Smile number to make the subscription on

 

EXPECTED RESPONSE

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

 

Recharge Smile Account

This endpoint allows you to recharge Smile account using smile number.

Base URL: https://epins.com.ng/api/smile

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. Example, Smile-direct
accountno R Number The Smile account number to make the subscription on
vcode R String This is the variation code from account validation.
amount R Number The amount 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"
}}

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:

Base URL: https://epins.com.ng/api/bet-verify

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at epins.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.

Base URL: https://epins.com.ng/api/bet9ja

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at epins.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"
}}

Purchase SME Data

SME Data services can be purchased with the endpoint below:

Base URL: https://epins.com.ng/api/sme-data

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 app.epins.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. These includes;
= 1000 (1GB)
= 2000 (2GB)
= 5000 (5GB)

 

 

EXPECTED RESPONSE

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

Purchase MTN Corporate Data

MTN Corporate Data services can be purchased with the endpoint below:

Base URL: https://epins.com.ng/api/corporate

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Network as specified. These should be, 01
MobileNumber R Number The phone number to receive the Corporate Data
DataPlan R Number The Corporate Data plan Variation code. These includes;
= 1000 (1GB)
= 2000 (2GB)
= 3000 (3GB)
= 5000 (5GB)
= 10000 (10GB)
= 15000 (15GB)
= 20000 (20GB)

 

 

EXPECTED RESPONSE

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

Purchase WAEC RESULT CHECKER PIN

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

Base URL: https://epins.com.ng/api/waec

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.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":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

Purchase NECO RESULT CHECKER PIN

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

Base URL: https://epins.com.ng/api/neco

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.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":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

Purchase Spectranet PIN

Spectranet PIN services can be purchased with the endpoint below:

Base URL: https://epins.com.ng/api/spectranet

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.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"
}}

Purchase Universal Motor Insurance

Universal Motor Insurance can be purchased with the endpoint below:

Base URL: https://epins.com.ng/api/ui-insurance

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at app.epins.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

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 .

Base URL: https://epins.com.ng/api/balance

Service: as specified in the fields below;

 

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

 

 

EXPECTED RESPONSE


{"code":101,

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

}