Skip to content
Booking Engine API Docs

/v1/holds/{reservationId}/confirm

POST
/v1/holds/{reservationId}/confirm
curl --request POST \
  --url http://localhost:8787/v1/holds/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "guestVerificationToken": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
reservationId
required
string format: uuid

Request Body

Section titled “Request Body”
Media typeapplication/json
object
guestVerificationToken
required
string
>= 1 characters
Examplegenerated
{
  "guestVerificationToken": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The reservation, now confirmed (idempotent — re-confirming an already-confirmed hold returns the same result).

Media typeapplication/json
object
createdAt
required
string
currency
required
string
>= 3 characters <= 3 characters
endsAt
required
string
holdExpiresAt
required
string | null
id
required
string format: uuid
ratePlanId
required
string | null format: uuid
resourceId
required
string format: uuid
startsAt
required
string
state
required
string
Allowed values: pending held confirmed cancelled checked_in checked_out no_show expired
totalMinorUnits
required
string
/^\d+$/
Example
{
  "state": "pending"
}

400

Section titled “400”

Invalid/expired guest-verification token, or one scoped to a different reservation.

Media typeapplication/problem+json
object
code
required
string
Allowed values: hold_not_found invalid_guest_token wrong_reservation not_confirmable payment_required
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "hold_not_found"
}

404

Section titled “404”

No such hold for this tenant.

Media typeapplication/problem+json
object
code
required
string
Allowed values: hold_not_found invalid_guest_token wrong_reservation not_confirmable payment_required
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "hold_not_found"
}

409

Section titled “409”

The hold is not in a state that can be confirmed (e.g. already cancelled/expired), or payment is required first.

Media typeapplication/problem+json
object
code
required
string
Allowed values: hold_not_found invalid_guest_token wrong_reservation not_confirmable payment_required
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "hold_not_found"
}