Airtime Recharge (E-pins)

📘

This service is only available in Nigeria

E pins (Voucher service)

E-pins also known as voucher service is an airtime recharge service that enables merchants resell airtime to their customers in the form of a 16-20 digit code. Merchants make profit on a transaction basis and by integrating this endpoint, merchants will be able to create and redeem vouchers on any network across Nigeria.

Process flow

Step 1: Make a call to Create Voucher (E pins). This generates a set of random numbers to be used to recharge.
Step 2: Make a call to Redeem Voucher (E pins). The generated numbers in step 1 above, the phone number to be recharged and the payment code of the provider of the voucher are required for this call. The voucher can only be redeemed before the expiryDate defined during the creation of the voucher .
NOTE: Payment code can be gotten by making a Get Biller Payment Items call.
Step 3: If the transaction is successful, the virtual card tied to the partner is debited at redemption. However, if it fails, there will be no debit to the virtual card.

The diagram below breaks the process flow down:

📘

Endpoint

Create Voucher - https://qa.interswitchng.com/quicktellerservice/api/v5/vouchers/generateVoucher

📘

Endpoint

Redeem Voucher - https://qa.interswitchng.com/quicktellerservice/api/v5/vouchers/redeemVoucher

Headers

Authentication Bearer {{token}}
Content-Type : Appication/Json
TerminalID [yourTerminalID]

{{token}} is generated using guide Generate Access Token

Create Voucher Request - Parameters

Redeem Voucher Request - Parameters

Sample Requests

curl https://qa.interswitchng.com/quicktellerservice/api/v5/vouchers/generateVoucher \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json" \
-H "TerminalID: <your_terminal_id>" \
-D '{
    "customerId": "234131670272",
    "amount": "100",
    "type": "GIFT",
    "expiryDate": "2023-06-22"
    "codeConfig": {
    "prefix": "1",
    "suffix":"2",
    "length":5,
    "allowedChar":"12890",
    "pattern":""
    
    }
   
}'
-X POST

curl https://qa.interswitchng.com/quicktellerservice/api/v5/vouchers/redeemVoucher \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json" \
-H "TerminalID: <your_terminal_id>" \
-D '{
    "customerId": "234131670272",
    "customerEmail" :"[email protected]",
    "customerMobile" :"2349124888776",
    "paymentCode": "52005",
    "amount": "100",
    "voucherCode":"1220002"
}'
-X POST

Response Message Field description

Sample Response

{
TransactionRef: "PBL|Web|3pbl|VOS|020523100514|Y7UYYH3QEG",
RechargePIN:"1220002"
ApprovedAmount: "100",
MiscData:"1220002",
AdditionalInfo:{
1220002:"1220002"
},
ResponseCode: "90000"
ResponseDescription: "Success",
ResponseCodeGrouping: "SUCCESSFUL",
}

{
transactionRef: "PBL|Web|3pbl|CGM|020523100532|XCMNTTMPXJ",
ApprovedAmount: "100",
AdditionalInfo:{},
responseCode: "90000"
responseDescription: "Success",
responseCodeGrouping: "SUCCESSFUL",
}

Response Codes - Create Vouchers

Response Codes - Redeem Vouchers