Confirm Reservation

Confirm a pending reservation by providing guest details and payment information. This endpoint finalizes the booking process, transforming a temporary hold into a confirmed reservation.

post

/reservations/{bookingReferenceId}/confirmation

Path parameters

bookingReferenceIdstringrequired

The unique identifier of the pending reservation to be confirmed

Header parameters

x-sm-api-idstringrequired

The api id for channel

x-sm-api-keystringrequired

The api key for channel

Body

cardNumberintegerrequired

The full number of the credit card or virtual credit card

cardholderNamestringrequired

The name of the cardholder as it appears on the card

cardExpirystringrequired

The expiry date of the card in MM/YYYY format

Pattern: ^\d{2}\/\d{4}$

cardCvvstringrequired

The Card Verification Value (CVV) of the credit card

Pattern: ^\d{3,4}$

vccActivationDateTimestring · date-time

VCC activation date/time. Expressed in ISO 8601 extended format. Date Format - YYYY-MM-DDThh:mm:ss<.sss>(+|-)hh:mm where <.sss> is optional and can be 1 to 3 digits.

Example: 2020-07-04T12:09:56.450-07:00

vccDeactivationDateTimestring · date-time

VCC deactivation date/time. Expressed in ISO 8601 extended format. Date Format - YYYY-MM-DDThh:mm:ss<.sss>(+|-)hh:mm where <.sss> is optional and can be 1 to 3 digits.

Example: 2020-07-04T12:09:56.450-07:00

vccCurrencystring

The currency of the Virtual Credit Card (if applicable)

vccBalancenumber

The balance available on the Virtual Credit Card (if applicable)

guestTitlestringrequired

The title of the primary guest (e.g., Mr., Mrs., Ms., Dr.)

guestFirstNamestringrequired

The first name of the primary guest

guestLastNamestringrequired

The last name of the primary guest

guestEmailstringrequired

The email address of the primary guest

guestPhoneNumberstringrequired

The phone number of the primary guest

guestAddressstring | nullable

The street address of the primary guest (optional)

guestCitystring | nullable

The city of residence for the primary guest (optional)

guestStatestring | nullable

The state or region of residence for the primary guest (optional)

guestPostcodestring | nullable

The postal or zip code of the primary guest (optional)

guestCountrystring | nullable

The country of residence for the primary guest (optional)

guestRemarksstring | nullable

Any additional remarks or special requests from the primary guest (optional)

paymentMethodstring · enumrequired

The method of payment for the reservation

Options: CreditCard, VirtualCreditCard

cardTypestring · enumrequired

The type of credit card (AX=American Express, DN=Diners, DS=Discover, JC=JCB, MC=Mastercard, CU=China UnionPay, VI=Visa)

Options: AX, DN, DS, JC, MC, CU, VI

roomsobject[]required

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/reservations/{bookingReferenceId}/confirmation' \
  --header 'x-sm-api-id: text' \
  --header 'x-sm-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "cardNumber": 1,
    "cardholderName": "text",
    "cardExpiry": "text",
    "cardCvv": "text",
    "vccActivationDateTime": "2020-07-04T12:09:56.450-07:00",
    "vccDeactivationDateTime": "2020-07-04T12:09:56.450-07:00",
    "vccCurrency": "text",
    "vccBalance": 1,
    "guestTitle": "text",
    "guestFirstName": "text",
    "guestLastName": "text",
    "guestEmail": "text",
    "guestPhoneNumber": "text",
    "guestAddress": "text",
    "guestCity": "text",
    "guestState": "text",
    "guestPostcode": "text",
    "guestCountry": "text",
    "guestRemarks": "text",
    "paymentMethod": "CreditCard",
    "cardType": "AX",
    "rooms": [
      {
        "roomUuid": "text",
        "guestTitle": "text",
        "guestFirstName": "text",
        "guestLastName": "text",
        "guestRemarks": "text"
      }
    ]
  }'

200

400

401

404

500

200

No body

Successful response. The reservation has been confirmed successfully.