This API allows you to void/delete the posted charges on a folio in context to charge post API. When you have asked the restaurant manager to post charge to room, but then you decide to pay straight away, so for deleting those charges from folio, you can make use of this API. The API can return data in XML formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| auth * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| oprn * | VARCHAR(150) | Use Keyword “voidcharge” | |
| requestid * | INT(11) | Need to send request id | 172 |
Request
<?xml version="1.0" standalone="yes"?> <request> <auth>xxxxxxxxxxxxxxxxxxxxxxxx</auth> <oprn>voidcharge</oprn> <requestid>2804</requestid> </request>
Response
| Name | Data Type | Description | Example |
| status | String | Status value will be provided Values: ok, error | ok |
| msg | String | Message result will be provided Values: voided,already voided | voided |
Success
<?xml version='1.0' standalone='yes'?> <response> <status>ok</status> <msg>voided</msg> </response>
Error
<?xml version='1.0' standalone='yes'?> <response> <status>error</status> <msg>Invalid Authentication</msg> </response>
Error Codes
| Errors | Description |
| Hotel Code In-Active | The Property has been deactivated |
| API Authkey is deactivated | The Authcode/Key has been deactivated |
| Invalid Authentication | Invalid data |
| Bad Request | Invalid Request Parameter |
| Invalid API Request. Don’t have this API access | Invalid Request Method |
| Invalid request id | Provided Request Id is invalid |
| Invalid Operation | – |