Skip to main content
POST
Refund or void a flight ticket against a quote the customer accepted
Start the operation the preview described, a refund, or a void of the original charge, whichever the preview reported as operation_kind. The body is the quote handle and the acknowledged figure PLUS the same auth mode the preview took: ownership is re-checked here rather than carried by the handle, so the mode has to be sent again. acknowledged is the refund the customer was shown, copied from the preview as it arrived (value and decimal_places included): if the refund has moved since, the call is refused with 409 quote_drift, carrying a fresh requote handle and the current figure, and nothing is sent to the airline, so nobody is refunded a number they never saw. A MANUAL_REQUIRED quote needs manual_ok: true: the operation is then raised for a Jinko agent and answers attention_required with reason: manual_required, again without the airline being called. Committing one without the flag is refused 409 manual_required. That submission is also the one case where acknowledged may be left out: a MANUAL_REQUIRED quote whose penalty is unknown carries no refund to acknowledge, and there is nothing to compare against. Whenever the preview DID name a refund, send it. The other refusals are 409 quote_expired (preview again), active_operation_exists (poll the active_operation it names instead of starting a second one), not_cancellable, funds_unavailable, superseded, and, when the preview already said commitable: false and you committed anyway, that quote’s own reason answered back as the code: penalty_exceeds_sell or multi_currency_basis. Success does NOT mean the money has moved: giving the ticket back at the airline and returning the money to the customer are separate steps, so the answer is an operation handle to poll with POST /v1/flight_refund_status.

Authorizations

X-API-Key
string
header
required

Body

application/json
quote
string
required

The "svq_…" handle from a preceding POST /v1/flight_refund_preview. Binds this commit to the figures that quote reported.

Example:

"svq_01J7ZR3M8FKX2P9C"

provider_reference
string

The CONNECTOR's own order id for this flight booking — the Sabre PNR for a Sabre booking, the TravelFusion booking reference for a TravelFusion one. NOT the airline record locator, which names the carrier's own copy of the reservation and is answered 404 here, identically to an unknown booking. 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.

Example:

"QQIUIQ"

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
acknowledged
object

The refund the customer was shown — copy the preview's refund object across. REQUIRED whenever the preview carried a refund, which is every quote that names a figure. It may be omitted in exactly one case: a MANUAL_REQUIRED quote that carries no refund at all because the penalty is unknown (penalty.fee_known: false), submitted with manual_ok: true — there is no figure to acknowledge, and inventing one would have the customer agree to a number nobody computed. Omitting it anywhere else is refused by the platform, not here. When present, all three of value (minor units), currency and decimal_places are required: the platform compares this against the refund as it stands, and a figure whose scale is unstated cannot be compared. amount is not accepted in its place. Anything else on the preview's refund, such as basis, is ignored. A mismatch against the current refund is answered 409 quote_drift, carrying a fresh requote handle and the current figure, and nothing is sent to the airline.

manual_ok
boolean

Send true to submit a quote whose support_level is MANUAL_REQUIRED. The operation is then raised for a Jinko agent and answers state: attention_required with reason: manual_required — NOTHING is sent to the airline by this call, and the agent settles or fails it. Without the flag such a commit is refused 409 manual_required, so a customer is never put in an agent queue unasked. On an AUTO or AUTO_VOID quote the flag changes nothing. This is also the one submission that may carry no acknowledged figure — when the quote itself named none, because the penalty is unknown.

Example:

false

Response

The refund or void was accepted and is running

operation
string

The operation this call started ("svc_…"). Poll it with POST /v1/flight_refund_status; it is the only handle that reports how the airline call and the refund ended.

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 parked, when state is attention_required. On a commit that is manual_required: you sent manual_ok: true, a Jinko agent now has it, and nothing has been sent to the airline. Not a failure — poll the operation.

Example:

"manual_required"