SiteMinder APIs
Help CentrePartner ContactsTest Extranet LoginBecome a SiteMinder Partner
  • Hub
  • Quickstart
  • Integration Process
  • CHANNELS
    • Introduction
      • SiteConnect
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Rooms and Rates
          • Availability and Restrictions
          • Rates
          • Reservations
            • Reservation XML Sample
        • Testing and Certification
        • Changelog
        • FAQ
      • Channels Plus
        • Getting Started
        • Developer Guide
          • Partner Portal
          • Deals
          • Invoicing: Gross vs. Net
        • API Reference
          • Properties
          • Property
          • Lock Reservation
          • Confirm Reservation
          • Modify Reservation
          • Cancel Reservation
        • Testing and Certification
        • Swagger
        • Changelog
        • FAQ
  • PMS / RMS
    • Introduction
      • pmsXchange
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Rooms and Rates
          • Availability and Restrictions
          • Rates
          • Reservations
            • Reservations PULL
            • Reservations Import
            • Reservations Upload
              • Reservation Types
            • Payment Transaction Record
            • Credit Card Tokenization
            • Reservations XML Samples
              • Reservations PULL Samples
              • Reservations Upload Samples
        • Testing and Certification
        • Changelog
        • FAQ
  • APPS
    • Introduction
      • SiteMinder Exchange
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Availability and Rates
            • Publishers
            • Hotels
            • RoomTypes
            • RatePlans
            • Availability
            • Rates
            • Models
            • Response Samples
              • Publishers Sample
              • Hotels Sample
              • RoomTypes Samples
              • RatePlans Samples
              • Availability Samples
              • Rates Sample
            • ARI 1-Way Guidelines
          • Reservations
            • Maximum Content Sample
            • Minimum Content Sample
        • Testing and Certification
        • Activation & Deactivation Process for Hotels
          • Activation Process for Hotels
          • Activation Form Parameterisation
          • Deactivation Process for Hotels
        • Changelog
          • Reservations API Changelog
          • ARI API Changelog
        • FAQ
  • Additional Resources
    • Reference Tables
      • Booking Agent Codes
      • Document Type Code (DOC)
      • Error Codes (ERR)
      • Error Warning Types (EWT)
      • Fee Tax Type (FTT)
      • Handling HTTP 500
      • Meal Plan Type (MPT)
      • OpenTravel Codes List
      • Payment Card Provider Codes
      • Service and Extra Charge
      • Strong Customer Authentication Codes
      • Test Credit Cards
    • Glossary
    • FAQ
Powered by GitBook
On this page

Was this helpful?

  1. CHANNELS
  2. Introduction
  3. Channels Plus
  4. API Reference

Confirm Reservation

Last updated 6 months ago

Was this helpful?

post

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.

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
paymentMethodstring · enumRequired

The method of payment for the reservation

Possible values:
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}$
cardTypestring · enumRequired

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

Possible values:
cardCvvstringRequired

The Card Verification Value (CVV) of the credit card

Pattern: ^\d{3,4}$
vccActivationDateTimestring · date-timeOptional

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-timeOptional

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
vccCurrencystringOptional

The currency of the Virtual Credit Card (if applicable)

vccBalancenumberOptional

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 | nullableOptional

The street address of the primary guest (optional)

guestCitystring | nullableOptional

The city of residence for the primary guest (optional)

guestStatestring | nullableOptional

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

guestPostcodestring | nullableOptional

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

guestCountrystring | nullableOptional

The country of residence for the primary guest (optional)

guestRemarksstring | nullableOptional

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

Responses
200
Successful response. The reservation has been confirmed successfully.
400
Invalid request
application/json
401
Unauthorized
application/json
404
The specified resource was not found
application/json
500
Unexpected error occurred
application/json
post
POST /reservations/{bookingReferenceId}/confirmation HTTP/1.1
Host: 
x-sm-api-id: text
x-sm-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 632

{
  "paymentMethod": "CreditCard",
  "cardNumber": 1,
  "cardholderName": "text",
  "cardExpiry": "text",
  "cardType": "AX",
  "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",
  "rooms": [
    {
      "roomUuid": "text",
      "guestTitle": "text",
      "guestFirstName": "text",
      "guestLastName": "text",
      "guestRemarks": "text"
    }
  ]
}

No content