The Payment API provides the ability to notify Bookerville payments for bookings.
Invoking the Payment API
You will of course replace the "s3cr3tK3y" parameter with your own Bookerville API access token. If you don't have one, you may apply for one here:
Request API Token
Note: for testing purposes it is fine to pass your API access token using simple query string parameters in the URL as in the sample above. Once you have completed testing, it is far better to pass it as an HTTP POST (form) parameter instead, because that is more secure.
The xmlPayload Field
The Payment API requires that you POST an XML document in a separate HTTP POST (form) key-value pair, called
xmlPayload. The XML document you must submit in this field is as follows:
<bkvBookingId>: This is the Bookerville id of the booking, which was returned to your software when you created the booking with the Booking API "ADD" operation.
<datePaid>: Must use "yyyy-MM-dd HH:mm" format, please note that the capital "HH" means this must be in 24-hour clock (European/Military) format.
<refundableSecurityDepositPortion>: This field is optional. If any part of the payment being posted is a refundable security deposit, specify the actual amount that is to be applied to the refundable security deposit balance. If this field is omitted, Bookerville assumes a value of 0.00.
Ex.: your software collected a $750.00 payment from the guest, $250.00 of that is a refundable security deposit. Your software could split the two into different Payment API invocations, one that has an <amount> field of 500.00 and a <refundableSecurityDepositPortion> field of 0.00 (or simply omitted), and the other Payment API call would have an <amount> field of 0.00 and a <refundableSecurityDepositPortion> field of 250.00. Or you could send it in one API call, but set the amount field to 750.00, and set the <refundableSecurityDepositPortion> field to 250.00.
<depositVenue>: If the transaction funds are being kept by your organization (or a channel partner of yours), specify "Channel" here. If the transaction funds have been collected in the property managers's account, specify "Manager" here.
<operation>: Either "ADD" or "DELETE". If DELETE, then <bkvBookingPaymentId> is mandatory.
<bkvBookingPaymentId>: Only required for DELETE operation. This value was returned to your software during the ADD operation.