Telco Bill Payments (1.0.0-oas3)

Download OpenAPI specification:Download

Telco Bill Payments API

Authentication

This endpoint is used to generate token. Token expires after 1hr

Request Body schema: application/json

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"username": "ultim45",
"password": "5454"
}

Response samples

200
400
401
500

Content type

application/json

{"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJET0MuSVBPUyIsImF1ZCI6Ind3dy5leGFtcGxlLmNvbSIsImlhdCI6MTYzMTcwMzcwOCwibmJmIjoxNjMxNzAzNzE4LCJleHAiOjE2MzE3MDM3NjgsInVzZXJuYW1lIjoiamV0In0.wMkPMJ1QHUfKneZSlbGyVUIZ2yc3_z1St4DjM2-bH8c"
}

Fetch customer details

This endpoint verifies customer

query Parameters

phone	any
email	any

header Parameters

token

required

string <string>

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"customer_id": 1,
"service_id": [{"is_usage_based": "ultim45",
"id": "5454",
"service_id": "SUP-VEL-50",
"product_id": 56
}
],
"name": "Jason Green",
"email": "jason@green.com",
"phone": "263777777777"
}

Get customer packages and topup options data

query Parameters

customerid

required

any

header Parameters

token

required

string <string>

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"customerid": "123",
"subscribed_packages": [{"service_id": "SUP-VEL-70G-01",
"product": 54,
"balance": 500,
"is_usage_based": false
}
],
"available_topup_options": {"type": "topup",
"options": [{"service_id": "SUP-VEL-70G-01",
"products": [{"id": 45,
"name": "Velocity 46",
"list_price": 3000,
"is_usagebased": false
}
]
}
]
},
"available_renew_options": {"type": "renew",
"options": [{"service_id": "SUP-VEL-70G-01",
"name": "Velocity 46",
"list_price": 3000,
"id": 45
}
]
}
}

Save transaction

This endpoint will save transaction

header Parameters

token

required

string

Request Body schema: application/json

customer_id	integer
service_id	string
product_id	integer
amount	number
reference	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"customer_id": 1,
"service_id": "SUP-VEL-50",
"product_id": 54,
"amount": 123,
"reference": "1234",
"type": "renew"
}

Response samples

200
400
401
500

Content type

application/json

{"message": "Success"
}