BookRequest
BookRequest confirms a booking for a previously quoted option.
input object
Booking inputs detailing travellers and payment.
Aggregator option identifier returned by the search flow.
ISO 639-1 language code used for provider communications.
Client reference to correlate the booking in external systems.
Expected price variation applied after the quote stage.
paymentCard object
Payment information when the provider requires card details.
Card type as recognised by providers.
Possible values: [AX, BC, CA, CB, CU, DC, DS, E, EC, ER, EU, JC, L, N, O, OP, R, S, T, TO, TP, VI, XS]
holder object
Card holder information.
Holder given name.
Holder family name.
Courtesy title for the holder.
Possible values: [MR, MRS, MISS, MS, NOT_SPECIFIED]
contactInfo object
Contact details for the holder.
Primary email address that providers can use for notifications.
phone object
Traveller phone information for confirmations or alerts.
International country dialling prefix without the plus sign.
Subscriber number excluding the country code.
Street address of the contact person.
City associated with the contact address.
Country ISO code associated with the contact address.
Postal or ZIP code associated with the contact address.
Card number with no separators.
Card verification code.
expire object
Card expiry details.
Expiry month expressed from 1 to 12.
Expiry year expressed with four digits.
Indicates whether the card is virtual.
virtualCreditCard object
Additional details for virtual credit cards.
Activation timestamp for the virtual card.
Deactivation timestamp for the virtual card.
Current available balance.
ISO 4217 currency code for the balance.
threeDomainSecurity object
3DS authentication data captured during payment.
3DS version used during authentication.
Directory server transaction identifier.
Transaction identifier (XID).
Electronic commerce indicator.
Cardholder authentication verification value.
Raw payer response returned by the authentication system.
Parsed status for the payer response.
Possible values: [AUTHENTICATION_SUCCESS, AUTHENTICATION_FAILED, AUTHENTICATION_INCOMPLETE, TRANSACTION_ATTEMPT_SUCCESS_A, TRANSACTION_ATTEMPT_SUCCESS_B, AUTHENTICATION_REJECTED]
Enrolment status of the card in 3DS.
Possible values: [CARD_ENROLLED, CARD_NOT_ENROLLED, CANT_AUTHENTICATE]
Merchant name presented during authentication.
Signature validation result.
Possible values: [SIGNATURE_VALIDATED, SIGNATURE_NOT_VALIDATED]
remarks object[]
Remarks transmitted to the provider without transformation.
Type identifier that categorises the value.
Associated value.
holder object
Booking holder information.
Holder given name.
Holder family name.
Courtesy title for the holder.
Possible values: [MR, MRS, MISS, MS, NOT_SPECIFIED]
contactInfo object
Contact details for the holder.
Primary email address that providers can use for notifications.
phone object
Traveller phone information for confirmations or alerts.
International country dialling prefix without the plus sign.
Subscriber number excluding the country code.
Street address of the contact person.
City associated with the contact address.
Country ISO code associated with the contact address.
Postal or ZIP code associated with the contact address.
rooms object[]
Rooms and associated travellers to confirm.
Reference to the occupancy from the original search request.
paxes object[]
Travellers assigned to this room.
Traveller given name.
Traveller family name.
Traveller age at check-in.
Courtesy title for the traveller.
Possible values: [MR, MRS, MISS, MS, NOT_SPECIFIED]
additionalData object
Provider-specific parameters forwarded as part of the booking.
settings object
Execution settings shared across aggregator requests.
Unique identifier used to correlate downstream provider calls and responses.
Provider access identifiers that the request should target.
pos object
Point of sale information for commercial routing.
Branch or office that originated the enquiry, when available.
When true, raw provider transactions are collected for auditing.
Maximum time in milliseconds allowed for the aggregator to respond.
Enables sandbox flows where providers expose dedicated mock behaviour.
Enables diagnostic payloads that surface debug data in responses.
Token that propagates caller authentication to downstream services.
{
"input": {
"optionRefId": "string",
"language": "string",
"clientReference": "string",
"priceDelta": 0,
"paymentCard": {
"type": "AX",
"holder": {
"name": "string",
"surname": "string",
"title": "MR",
"contactInfo": {
"email": "string",
"phone": {
"countryCode": "string",
"number": "string"
},
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string"
}
},
"number": "string",
"CVC": "string",
"expire": {
"month": 0,
"year": 0
},
"isVCC": true,
"virtualCreditCard": {
"activationDate": "2024-07-29T15:51:28.071Z",
"deactivationDate": "2024-07-29T15:51:28.071Z",
"currentBalance": 0,
"currencyCode": "string"
},
"threeDomainSecurity": {
"version": "string",
"DSTransactionID": "string",
"XID": "string",
"ECI": "string",
"CAVV": "string",
"payerResponse": "string",
"payerResponseStatus": "AUTHENTICATION_SUCCESS",
"cardEnrolledStatus": "CARD_ENROLLED",
"merchantName": "string",
"signatureStatus": "SIGNATURE_VALIDATED"
}
},
"remarks": [
{
"type": "string",
"value": "string"
}
],
"holder": {
"name": "string",
"surname": "string",
"title": "MR",
"contactInfo": {
"email": "string",
"phone": {
"countryCode": "string",
"number": "string"
},
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string"
}
},
"rooms": [
{
"occupancyRefId": 0,
"paxes": [
{
"name": "string",
"surname": "string",
"age": 0,
"title": "MR"
}
]
}
],
"additionalData": {}
},
"settings": {
"requestId": "string",
"accessIds": [
"string"
],
"pos": {
"branchOffice": "string"
},
"auditTransactions": true,
"timeout": 0,
"testMode": true,
"debugData": true,
"token": "string"
}
}