Payment Integration
Description
Payment integration allows a property to manage payments on bookings that only exist within their PMS (Property Management System).
Manage Payments Button
We suggest adding a button in your PMS under the Booking Details section to open the Payments Page. You might consider labeling this button "Manage Payments."
Once a user clicks on the "Manage Payments" button, a new window should open up displaying to the user with the location set to a specially constructed URL.
Note
The URL of the window should ideally be concealed from the user. Additionally, any DOM manipulation and access to the console window should be disabled within the PMS browser window that opens the URL for managing payments. (if possible)
Screenshot
Management Overview
Users will be able to manage (view, create and cancel) all payments related to a booking on this screen. This will also show processed payments, scheduled payments and refunds (if any) also on the same screen.
Special URL Specification (Booking that does not exist on Levart)
Parameters need to be passed as regular GET request. The parameters include:
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | String | Yes | Levart will provide a secret API KEY to PMS |
| reference | String | Yes | Unique Reference that identifies a booking in PMS |
| arrival | Date | Yes | Arrival Date in format d-m-Y |
| departure | Date | Yes | Departure Date in format d-m-Y |
| status | String | Yes | Status of booking – booked or cancelled |
| String | Yes | Primary Guest’s Email Address | |
lastname | String | Yes | Primary Guest’s Lastname |
totalCost | Float | Yes | Total Cost of Booking |
firstNightCost | Float | Yes | Total cost of first payable night. If a multiple room booking, add first night cost across rooms |
Update Booking Details
To update the booking details in the Manage Payments section, please modify the GET parameters in the URL while ensuring the reference remains unchanged.
Special URL Specification (Booking that already exists on Levart and pushed to PMS)
Parameters need to be passed as base64 encoded GET request. The parameters include:
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | String | Yes | Levart will provide a secret API KEY to PMS |
| referenceNumber | String | Yes | PMS confirmation number for the booking |
Sample Screenshots
