Payment Reference API
Introduction
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.
Request Headers
The request header validates the API credentials and sets the response output format.
Headers
- Authorization: Basic <<hashed key that will be provided by Urbanise>>
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
Lookup the service charge balance
HTTP Verb: POST
URL: HTTPS://www.my-community.com/api/kiosk/lookup
The kiosk lookup API has the following attributes:
Query Parameters
- "refno" - Payment reference number - in form of a string.
Response on success
Response Code: 200
{
"propname": "name of property",
"unit": "unit number",
"iref": "internal reference number of property",
"ilot": 6,
"amount": "598.52"
}
Response on failure
Response Code: 400
- When invalid unit number, message returned with 400 response code
{
"message": "Invalid reference number!"
}
- When missing fileds or invalid request call, message returned with 400 response code
{
"message": "Missing required field!"
}
To make a payment
HTTP Verb: POST
URL: HTTPS://www.my-community.com/api/kiosk/makepayment
Query Parameters
- "iref" - Property internal reference number - in form of a string.
- "ilot" - Lot number - in form of a string.
- "payamount" - Amount paid - in form of number.
Note - iref, ilot related information will be returned by lookup API
Response on success
Response Code: 200
{
"success": 1,
"message": "Success"
}
Response on failure
Response Code: 400
- When invalid iref number, message returned with 400 response code
{
"message": "Invalid iref Number!"
}
- When invalid ilot supplied, message returned with 400 response code
{
"message": "Invalid ilot number!"
}
- When payment amount is zero, message returned with 400 response code
{
"message": "Payment amount must be greater than zero!"
}
- When payment processing failed, failure reason returned with 400 response code
{
"message": "Failed "
}