Skip to main content
POST
Preview what giving back a flight ticket would return to the customer
Quote what the customer would get back for this ticket right now: the refund, the penalty in force, and every document the operation would cover. NOTHING is sent to the airline. refund is the customer figure, what they paid less the penalty; the supplier’s own net figures are under provider_figures and are not what the customer receives. The platform decides WHICH operation this is and reports it as operation_kind: a ticket still inside its void window is void, the entire charge is reversed, penalty-free, no supplier figure is read, and provider_figures is legitimately absent, and anything else is cancel, a refund under the fare rules. You cannot ask for one; read what you are given, because the void window closes with time. commitable: false with support_level: MANUAL_REQUIRED is not a dead end: the commit takes manual_ok: true and hands the operation to a Jinko agent. The handle this returns is named quote: it is what POST /v1/flight_refund_commit consumes, and it stops binding at expires_at. Every call here needs API authentication; this is about which mode identifies the booking. Use EXACTLY ONE: provider_reference (the connector order id, the Sabre PNR or the TravelFusion reference, never the airline record locator), which additionally requires a credential that OWNS the booking, or booking_ref + last_name, which identifies it without one. Sending both is a 422.

Authorizations

X-API-Key
string
header
required

Body

application/json
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

Response

What giving the ticket back would return

quote
string

This quote ("svq_…"). Pass it to POST /v1/flight_refund_commit — it binds the commit to the figures below. Opaque; the format may evolve.

Example:

"svq_01J7ZR3M8FKX2P9C"

state
string

Lifecycle of the QUOTE, not of a refund — nothing has been refunded or voided by this call. completed means the figures are final until expires_at.

Example:

"completed"

commitable
boolean

Whether a commit against this quote would be accepted as it stands. A MANUAL_REQUIRED quote is never commitable and is still SUBMITTABLE: send the commit with manual_ok: true to hand it to a Jinko agent. Otherwise, when false, not_commitable_reason says why and committing is pointless.

Example:

true

support_level
enum<string>

How this refund would be carried out. AUTO — the platform refunds the ticket end to end under the fare rules. AUTO_VOID — the ticket is still inside the airline's void window, so the platform voids it and the ENTIRE charge is reversed, penalty-free; there is no supplier figure to report on a void. MANUAL_REQUIRED — it is possible, but a Jinko agent has to act (manual_reason says why): the commit is refused unless you send manual_ok: true, which hands it to that agent. Do not treat MANUAL_REQUIRED as a failure. Time-sensitive: a void window closes, so read the level from a live preview.

Available options:
AUTO,
AUTO_VOID,
MANUAL_REQUIRED
manual_reason
string

Why a person has to act. Present with support_level: MANUAL_REQUIRED.

Example:

"fare rules require agent review"

operation_kind
enum<string>

What this quote would do — refund the ticket under the fare rules (cancel) or void it (void). On a void the whole charge comes back, the penalty is zero and provider_figures is absent. The status read reports the operation that actually ran under this same name, so the two compare directly. The handle that binds this quote is quote; operation is the "svc_…" handle the COMMIT answers, and it never appears on a quote.

Available options:
cancel,
void
settlement_basis
string

How the refund is settled. sell_minus_penalty — what the customer paid for this ticket, less the penalty (a cancellation). original_charge — the whole charge is reversed, penalty-free (a void). It follows operation_kind, which the platform derives; the caller cannot ask for one.

Example:

"sell_minus_penalty"

expires_at
string

When this quote stops binding. Committing after it answers 409 quote_expired; take a fresh quote and show the customer the new figure before committing again.

Example:

"2026-09-03T12:15:00Z"

item
string

The booked item this quote covers ("itm_…"). A booking holding several items is quoted and refunded one item at a time; within an item, every ticket issued for it is covered together.

Example:

"itm_7f2c9a4e8b1d"

provider
string

Which supplier the operation would be sent to. Informational.

Example:

"sabre-rest"

refund
object

THE CUSTOMER FIGURE: what would go back to the payment method, on the basis named in basis — what they paid less the penalty, or the entire charge on a void. Show this one, never provider_figures. Absent is not zero: a quote whose penalty is unknown carries no refund figure at all.

penalty
object

What the customer would forfeit, in the currency they were charged. Zero on a void. Read fee_known before showing it — false means UNKNOWN, not free.

documents
object[]

Every document this operation covers, each of them active right now. Ticket subsets are not offered: the operation takes the whole item.

ancillary_recoverable
boolean

Whether the ancillaries bought with this ticket come back with it. false when any document is an EMD — the platform cannot refund or void one, so that value has to be recovered by a person, and the quote is MANUAL_REQUIRED. Tell the customer before they commit, not after.

Example:

true

provider_figures
object

The airline's own net figures, for reconciliation — never what the customer receives. refund_net is what the airline returns to Jinko, penalty_net what it withheld from Jinko and total_paid_net what it recorded as paid to it; on a ticket sold at a margin all three differ from the customer figures. Show the customer the top-level refund_amount / refund, never these. currency is the currency the airline settles in, which can differ from the currency charged. The whole object is omitted on a void (operation_kind: void): the original charge is reversed without reading any supplier figure, so there is none to report.

not_commitable_reason
string

Why commitable is false. Today: manual_required (a Jinko agent has to act — resubmit with manual_ok: true), provider_unsupported (the airline offers no refund through the API), not_cancellable (this ticket cannot be given back as it stands), penalty_exceeds_sell (the penalty is at least what the customer paid), multi_currency_basis (the booking was paid across currencies and no single refund figure exists), funds_unavailable (the original payment cannot cover the refund yet), insufficient_time_to_converge (too little time is left to finish before the flight). New reasons may be added, so treat an unrecognised value as "not right now".

Example:

"not_cancellable"