1. Authentication & Security
- All API requests must include a Bearer Token in the
Authorization header.
Example Header:
Authorization: Bearer {api_key}
2. Definitions
2.1 Payment Details
Payment information sent from the POS should include:
- totalAmount → The final bill amount after tax and service charges.
- tax → The tax applied to the total bill.
- tip → Any gratuity added by the guest.
- discount → Any applied discount or promotional offers.
- paymentMethod → The method used for payment (e.g., credit card, cash, online payment).
3. Error Management & Handling
Proper error handling ensures that POS systems can recover from failures smoothly and handle edge cases effectively.
3.1 Common Error Types
- 400 Bad Request → The request is invalid or missing required parameters.