Bookings Cancel

Services \ Bookings \ Cancel

Purpose

Cancels an existing booking and send notifications about the cancellation.

NOTE: In case of an Automated Payment booking, will also refund payment.

Basic Usage:

$rezdyApi->bookings->cancel($orderNumber, $optionalSettings);

Required Parameters

• string: $orderNumber

Optional Parameters

• array: $optionalSettings

Returns

• object: Rezdy\Responses\ResponseNoData

Throws (with errors)

• object: Rezdy\Requests\EmptyRequest

Code Example

use Rezdy\RezdyAPI;

// Initialize the API
$rezdyAPI = new RezdyAPI('your api key');

// IMPORTANT! The order number must be passed as a string.
$orderNumber = '123456';

$options = [ 'sendNotifications' => false ];

// Send the request to the API
$response = $rezdyAPI->bookings->cancel($orderNumber, $options);

// View the response
echo $response;