Add Refund To Booking
Last updated
Last updated
POST
[PlatformAddress]/api/1.0/venue?action=addRefundToBooking
Add a refund to a booking using this api.
Name | Type | Description |
---|---|---|
All invoices of the booking will be checked for the refunded amount and if the amount is refundable then only the refund amount will be added to invoice.
Add refund to booking
Property | Description | Required |
---|---|---|
Property | Description |
---|---|
Property | Description |
---|---|
Code | Description |
---|---|
venueId
integer
The unique id of the venue to which the booking belongs
bookingId
integer
The unique id of the booking to which the refund will be added
refund
object
The payment details to add to the booking
refundDate
The date & time of the refund
timestamp in UTC
amount
The refund amount
number
notes
Additional notes about the refund
string
success
Whether or not the refund was added to the booking
refundDetails
A collection of invoiceId and refundId values
invoiceId
The unique id of the invoice
refundId
The id of the invoice refund
Specific Code: 24149
The refund details are invalid
Specific Code: 24145
The booking does not have an amount that can be refunded
Specific Code: 24146
Cannot refund more than the total amount payable on a booking
Specific Code: 24147
The refund amount must be greater than zero
Specific Code: 24148
The full refund amount could not be applied to the booking