Skip to main content

CancelResponse

Result of the cancellation.

statusstringrequired

cancelled (final), cancellation_pending (accepted, not final yet: poll booking-details), failed or unknown (no answer in time: check booking-details).

Example: cancelled
cancelledboolean

true only when the cancellation is final.

Default value: false
Example: true
refund_amountnumber | nullnullable

Refund, when known. Informational: the API does not move money.

Example: 2509.96
currencystring | nullnullable

Currency of refund_amount: the booking's currency.

Example: INR
refund_sourcestring | nullnullable

supplier (reported by the provider) or policy_estimate (computed from the free-cancellation deadline).

Example: supplier
refund_estimatedboolean

true when refund_source is policy_estimate.

Default value: false
Example: false
cancelled_atstring | nullnullable

Cancellation time, ISO 8601 UTC. Final cancellations only.

Example: 2026-10-23T06:33:47+00:00
cancelled_at_sourcestring | nullnullable

supplier (provider's time) or tp_cancel (when TransferPlatform received the provider's acceptance).

Example: tp_cancel
error object

Set when status is failed or unknown.

anyOf

Why a recheck, book, booking-details or cancel did not succeed.

codestringrequired

recheck_failed, recheck_error, unavailable, currency_unavailable, book_failed, book_error, book_outcome_unknown, booking_details_failed, booking_details_error, cancel_failed, cancel_error or cancel_outcome_unknown. New codes may be added.

Example: book_outcome_unknown
messagestringrequired

Explanation, often with the provider's reason. Do not parse.

Example: The booking outcome could not be confirmed with the provider. Do not book again: retry the same request (same internal_reference) later, or contact support w...
providerstring | nullnullable

Provider.

Example: provider_a
CancelResponse
{
  "status": "cancelled",
  "cancelled": true,
  "refund_amount": 2509.96,
  "currency": "INR",
  "refund_source": "supplier",
  "refund_estimated": false,
  "cancelled_at": "2026-10-23T06:33:47+00:00",
  "cancelled_at_source": "tp_cancel",
  "error": {
    "code": "cancel_failed",
    "message": "Cancel failed: the pickup time has passed",
    "provider": "provider_a"
  }
}