API Reference Airtime Vend Request

Airtime Vend Request

POST

Service to perform airtime top-up for a customer’s phone number directly through the merchant’s account.

Service Information

baseUrl/api/v1/mvend
POST
application/json
Parameter Name Type M/O Description
loginId Numeric M Requery id provided during integration
key String M Merchants (public) key
requestId String M Unique transaction Id for the request. Maxlength (36characters)
amount Numeric M Amount with which to top-up amount customers phone Maximum 100000
recipient Numeric M Customers phone number to top-up
date String M Date-time at which the request was sent .
checksum Numeric M Checksum computed for the request. See "Security: Checksum" section for hash computation steps 

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{random12digit}}",
    "serviceId": "A04E",
    "amount": 100,
    "recipient": "08134045387",
    "date": "{{$isoTimestamp}}",
    "checksum": "{{checkSum}}"
}
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
mReference String M Unique transaction id supplied by the integrator for the request
tranxReference Numeric M Creditswitch’s unique id generated for the transaction
recipient String M Customers number on the network to which top-up was sent
amount Numeric M Amount credited the customer
confirmCode Numeric M Confirmation code returned by the network. Sent only for successful transactions
Network String M The actual network fulfilled by the Telco
tranxDate Numeric M Date at which transaction was carried out 
{
    "statusCode": "00",
    "statusDescription": "Successful",
    "mReference": "ija8d9bc8jbb",
    "tranxReference": "2106301908091658890",
    "recipient": "08134045387",
    "amount": 100,
    "confirmCode": "2021063019080126701629681",
    "network": "MTN",
    "tranxDate": "30-06-2021 7:08 pm"
}