Topup
POST/topup
Request for airtime topup to a mobile number. Bearer authentication required.
Request
- application/json
Body
request payload
mobile phonerequired
end user mobile to send topup to in full msisdn format
country stringrequired
ISO 3166-1 A-2 country code from country lookup
network stringrequired
network code from network lookup of mobile network
amount numberrequired
topup request amount
currency stringrequired
ISO 4217 currency code from currency lookup
notes string
notes for the topup request.
trackid uuid
request tracking id
additionalProperties
Responses
- 201
- 400
- 401
- 409
request successful
- application/json
- Schema
- Example (from schema)
Schema
success booleanrequired
response status
code int32required
response code
message stringrequired
response message
data
object
response data
txid integer
transaction record id.
reference stringrequired
reference no
status string
request status
error integer
processing errors
property name* any
response data
trackid uuidrequired
response tracking id
stamp int32required
response timestamp
{
"success": true,
"code": 0,
"message": "OK",
"data": {
"txid": 0,
"reference": "string",
"status": "string",
"error": 0
},
"trackid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"stamp": "2016-08-29T09:12:33.001Z"
}
invalid input, object invalid
Access token is missing or invalid
request failed
Loading...