POST api/ConfirmBooking/{token}
Post a reservation confirmation for the specified tour search
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| token |
The tour search token |
string |
Required |
Body Parameters
The reservation confirmation request input parameters
ReservationPostParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| orderKey |
Payment ID |
string |
None. |
| paymentAmount |
Payment amount in pence, e.g. £450 must be submitted as 45000 (not required for travel agent bookings) |
integer |
None. |
| paymentStatus |
Payment status, i.e. success, pending or failed (not required for travel agent bookings) |
string |
None. |
| paymentMethod |
Payment method, e.g. card [default], uk banks or direct debit bacs (not required for travel agent bookings) |
string |
None. |
| mac |
Mac GUID |
string |
None. |
| agentReference |
Travel agent reference, e.g. contact person's name (required for travel agent bookings only) |
string |
None. |
| agentContactEmail |
Travel agent contact e-mail address (required for travel agent bookings only) |
string |
None. |
| termsAgreed |
Terms agreed by customer, i.e. Y or N |
string |
None. |
| status |
Booking status instruction, i.e. CONFIRMED (confirm the booking), QUOTE (save as a quote) or OPTION (save as an option) |
string |
None. |
| allPaxCovid19Vaccinated |
Will all passengers be vaccinated against COVID-19 at the time of departure? i.e. Y or N |
string |
None. |
| specialAssistanceRequired |
Does any passenger required special assistance? i.e. Y or N |
string |
None. |
| specialMedicalRequestQuestions |
List of special medical request questions and responses |
Collection of Collection of string |
None. |
Request Formats
application/json, text/json
{
"orderKey": "sample string 1",
"paymentAmount": 1,
"paymentStatus": "sample string 2",
"paymentMethod": "sample string 3",
"mac": "sample string 4",
"agentReference": "sample string 5",
"agentContactEmail": "sample string 6",
"termsAgreed": "sample string 7",
"status": "sample string 8",
"allPaxCovid19Vaccinated": "sample string 9",
"specialAssistanceRequired": "sample string 10",
"specialMedicalRequestQuestions": [
[
"sample string 1",
"sample string 2"
],
[
"sample string 1",
"sample string 2"
]
]
}
Response Information
Resource Description
ConfirmBookingResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| token |
The tour search token |
string |
None. |
| response |
The response object |
Reservation |
None. |
| status |
The response status |
ResponseStatus |
None. |
| success |
An indication that the request was successfully completed or failed |
boolean |
None. |
| datestamp |
The date and time that the request was completed |
date |
None. |
Response Formats
application/json, text/json
{
"token": "sample string 1",
"response": {
"paymentStatus": "sample string 1",
"bookingStatus": "sample string 2",
"confirmedPassDetails": {
"leadName": "sample string 1",
"address1": "sample string 2",
"address2": "sample string 3",
"address3": "sample string 4",
"town": "sample string 5",
"county": "sample string 6",
"postCode": "sample string 7",
"country": "sample string 8",
"emailAddress": "sample string 9"
},
"reservationDetails": {
"bookingRef": "sample string 1",
"tourCode": "sample string 2",
"holidayName": "sample string 3",
"adults": 4,
"children": 5,
"infants": 6,
"departureDate": "sample string 7",
"duration": "sample string 8",
"priceBreakdown": [
{
"descr": "sample string 1",
"price": 2.1
},
{
"descr": "sample string 1",
"price": 2.1
}
],
"priceSummary": {
"totalPrice": 1.1,
"deposit": 2.1,
"amountPaid": 3.1,
"balanceDueDate": "sample string 4",
"commission": 5.1,
"vat": 6.1,
"commissionBreakDown": [
{
"componentID": 1,
"name": "sample string 2",
"componentType": "sample string 3",
"componentTypeID": "sample string 4",
"componentSourceID": "sample string 5",
"qty": 6,
"unitPrice": 7.1,
"price": 8.1,
"isCommissionable": true,
"commission": 10.1,
"policyID": 11,
"policyRuleID": 12,
"policyComponentSourceID": "sample string 13",
"policyPercentageValue": 14.1
},
{
"componentID": 1,
"name": "sample string 2",
"componentType": "sample string 3",
"componentTypeID": "sample string 4",
"componentSourceID": "sample string 5",
"qty": 6,
"unitPrice": 7.1,
"price": 8.1,
"isCommissionable": true,
"commission": 10.1,
"policyID": 11,
"policyRuleID": 12,
"policyComponentSourceID": "sample string 13",
"policyPercentageValue": 14.1
}
]
},
"paymentPlan": {
"paymentDay": 1,
"initialPayment": 2.1,
"recurringPayment": 3.1,
"numberOfPayments": 4,
"outstandingAmount": 5.1,
"period": "sample string 6",
"startDate": "sample string 7",
"endDate": "sample string 8",
"paymentDates": [
"sample string 1",
"sample string 2"
]
}
},
"emailPaymentLink": true,
"allPaxCovid19Vaccinated": "sample string 4",
"specialAssistanceRequired": "sample string 5"
},
"status": {
"code": 1,
"message": "sample string 2"
},
"success": true,
"datestamp": "2026-08-03T20:37:14.0812105+01:00"
}