The "Payment Reference" API is a simple call allowing you to fetch the outstanding service charge balance for a unit. This API also allows for a system to post a payment for a unit.
The request header validates the API credentials and sets the response output format.
HTTP Verb: POST
URL: HTTPS://www.my-community.com/api/kiosk/lookup
The kiosk lookup API has the following attributes:
Response Code: 200
{
"propname": "name of property",
"unit": "unit number",
"iref": "internal reference number of property",
"ilot": 6,
"amount": "598.52"
}
Response Code: 400
{
"message": "Invalid reference number!"
}
{
"message": "Missing required field!"
}
HTTP Verb: POST
URL: HTTPS://www.my-community.com/api/kiosk/makepayment
Note - iref, ilot related information will be returned by lookup API
Response Code: 200
{
"success": 1,
"message": "Success"
}
Response Code: 400
{
"message": "Invalid iref Number!"
}
{
"message": "Invalid ilot number!"
}
{
"message": "Payment amount must be greater than zero!"
}
{
"message": "Failed "
}