CancelRequest

CancelRequest asks providers to cancel an existing booking.

input object

Cancellation criteria that identify the booking.

bookingIDbookingID (string)

Booking identifier generated by the aggregator.

clientReferenceclientReference (string)

Client reference used to correlate the booking externally.

providerReferenceproviderReference (string)

Provider booking reference if already known.

additionalData object

Provider-specific parameters required to execute the cancellation.

property name*value (string)

settings object

Execution settings shared across aggregator requests.

requestIdrequestId (string)

Unique identifier used to correlate downstream provider calls and responses.

accessIdsstring[]

Provider access identifiers that the request should target.

pos object

Point of sale information for commercial routing.

branchOfficebranchOffice (string)

Branch or office that originated the enquiry, when available.

auditTransactionsauditTransactions (boolean)

When true, raw provider transactions are collected for auditing.

timeoutinteger<int32>

Maximum time in milliseconds allowed for the aggregator to respond.

testModetestMode (boolean)

Enables sandbox flows where providers expose dedicated mock behaviour.

debugDatadebugData (boolean)

Enables diagnostic payloads that surface debug data in responses.

tokentoken (string)

Token that propagates caller authentication to downstream services.

CancelRequest

{
  "input": {
    "bookingID": "string",
    "clientReference": "string",
    "providerReference": "string",
    "additionalData": {}
  },
  "settings": {
    "requestId": "string",
    "accessIds": [
      "string"
    ],
    "pos": {
      "branchOffice": "string"
    },
    "auditTransactions": true,
    "timeout": 0,
    "testMode": true,
    "debugData": true,
    "token": "string"
  }
}