CancelReservation

CancelReservation

The CancelReservation API is used to cancel a hotel reservation that was previously made using the CreateReservation API. It requires the original ReservationId and ConfirmationNumber received at the time of booking.


Endpoint

POST [SD-Domain]/api/SmartDistribution/CancelReservation

Replace [SD-Domain] with the actual Smart Distribution API domain. All endpoints must be called over HTTPS.


Headers

Header Name
Type
Required
Description

ApiKey

string

Yes

API key shared by RateGain

ApiSecret

string

Yes

API secret shared by RateGain

Content-Type

string

Yes

Must be set to application/json


Request Payload

{

"confirmationId": "RES78910",

"reservationid": "24ef232fes234wee42"

}


Request Fields Description

Field
Type
Required
Description

confirmationId

string

Yes

Confirmation code returned in CreateReservation

reservationid

string

Yes

Internal system ID returned in CreateReservation


Success Response Sample

{

"status": true,

"body": {

"reservation": {

"cancellationNumber": "HF4FUXJO2U633N",

"confirmationNumber": "6BZSQASDWECYON",

"inDate": "2025-06-09",

"outDate": "2025-06-11",

"propertyCode": "29412",

"guest": {

"firstName": "John",

"lastName": "Doe"

}

}

}

}


Response Fields Description

Field
Type
Description

status

boolean

Indicates if the cancellation was successful

cancellationNumber

string

Unique cancellation reference number

confirmationNumber

string

Original booking confirmation number

inDate

string

Check-in date (YYYY-MM-DD)

outDate

string

Check-out date (YYYY-MM-DD)

propertyCode

string

Code of the hotel property

guest

object

Guest details including first and last name


Notes

  • Dates must be in ISO format: YYYY-MM-DD

  • Always validate API responses and handle status flags properly

  • Responses may vary depending on availability, credentials, or booking status

  • For support or credentials, please contact the RateGain Integration Team

Last updated