Skip to main content
POST
Check how a hotel cancellation ended
Report where one cancellation has got to, named by the operation handle a commit (or POST /v1/hotel_cancel) returned. Read-only. state is the platform view, keep polling while it is in_progress or attention_required, both of which mean the operation is still alive. provider is what the supplier says about the booking and money is where the refund itself has got to; the two move independently, so a booking can read cancelled while the money is still in flight. Do not tell a customer they have been refunded until money.vehicle_state says paid. Same auth modes as hotel_cancel_preview.

Authorizations

X-API-Key
string
header
required

Body

application/json
operation
string
required

The "svc_…" handle from a commit, or from POST /v1/hotel_cancel.

Example:

"svc_01J7ZR5Q2KME8V4T"

provider_reference
string

The supplier's own booking reference. OWNER mode: beyond the API authentication every call needs, this one requires a credential that OWNS the booking — a tenant-bound key reaches its whole tenant, any other credential must belong to the booking's own user. Mutually exclusive with booking_ref + last_name; sending both is rejected with 422. An unknown reference, another tenant's booking and another user's booking are all answered identically, so this field cannot be used to discover which supplier references exist.

Example:

"NUITEE-88231"

booking_ref
string

The Jinko reference. GUEST mode: pair it with last_name and the pair identifies the booking on its own — API authentication is still required, as on every call here, but the credential does not have to own the booking. Mutually exclusive with provider_reference; one without the other is rejected with 422.

Example:

"JNK-H1ZK90"

last_name
string

The lead traveller's surname. Required with booking_ref, and only with it.

Example:

"Carrard"

intent
object

Response

Where the cancellation has got to

operation
string
Example:

"svc_01J7ZR5Q2KME8V4T"

state
enum<string>

Where the cancellation has got to. in_progress — running; keep polling. attention_required — stalled on something a person at Jinko has to resolve (reason names it); keep polling, and do not report it to the customer as a failure, because the booking may already be cancelled at the supplier. succeeded and failed are terminal: the supplier outcome and the money are both settled and nothing further will change.

Available options:
in_progress,
attention_required,
succeeded,
failed
reason
string

Why the operation is stalled. Present with state: attention_required; the value names what Jinko has to resolve, and needs nothing from the caller.

Example:

"settlement_review"

provider
object

The supplier's record. It can say cancelled while the money is still moving — that is the normal middle of a cancellation, not a discrepancy.

money
object

The refund and where it has got to. Read vehicle_state before telling a customer they have been refunded.