Skip to main content
POST
DEPRECATED — use /v1/flight_refund_preview. Check refund eligibility only; use flight_refund_preview for customer-facing amounts
Check eligibility only: read is_refundable, is_voidable, support_level, and the documents covered. This read-only call returns no amounts. Use flight_refund_preview to show the customer’s refund and penalties before committing.

Authorizations

X-API-Key
string
header
required

Body

application/json
booking_ref
string

Jinko booking reference. Call get_booking first, then select its booked_item_id for servicing.

Minimum string length: 1
Example:

"JNK-A0AUR2"

booked_item_id
string

The booked item, from get_booking items[].booked_item_id. Preserved across exchanges. Omit only when the booking has exactly one item of the requested domain; otherwise a 409 returns items to choose from.

Pattern: ^itm_[a-z2-7]+$(?![\s\S])
Example:

"itm_aaaaaaaaaaaaafhuxsdxpbzrbfz5hm3a"

last_name
string

Required for guest lookup. A credential that owns the booking may omit it; ownership is checked by the platform.

Minimum string length: 1
Example:

"Doe"

order_id
string
deprecated

Deprecated: name the booking with booking_ref and booked_item_id from get_booking. Names the booking instead of booking_ref, never beside it, and needs a credential that owns the booking. Accepted until 2027-04-30; a request that sends it is answered with Deprecation and Sunset headers.

Minimum string length: 1
provider
string
deprecated

Deprecated: omit it. The platform uses the supplier recorded with the booking. Accepted until 2027-04-30; a request that sends it is answered with Deprecation and Sunset headers.

intent
object

Response

Check refund eligibility only; use flight_refund_preview for customer-facing amounts

seat_refunds
object[]

Separate refunds for carrier-settled paid seats. A paid seat is refunded once the airline refunds Jinko; these amounts are not part of the quoted fare refund.

is_refundable
boolean

Whether the fare that was sold is refundable under its fare rules: the same answer the price check gave. A non-refundable ticket can still be given back in full while it is inside its void window; read is_voidable for that.

Example:

true

is_voidable
boolean

True when committing would VOID the ticket outright — the document is still inside its void window, so the original charge is reversed in full instead of a fare-rule refund being computed. This check returns eligibility only; use flight_refund_preview for customer-facing amounts. Time-sensitive — read it from a live check, never from stored booking data.

Example:

false

is_automatable
boolean
Example:

true

support_level
enum<string>

How this action can be carried out. AUTO — the platform completes it end to end through the API. MANUAL_REQUIRED — it is possible, but a Jinko agent has to act; call the API to raise it and expect a delay rather than an immediate result. UNSUPPORTED — the provider or fare does not allow it at all; nothing you send will change that. Do not treat MANUAL_REQUIRED as a failure, and do not retry UNSUPPORTED. On the refund check manual_reason says why it is not AUTO, on the exchange shop reason.

Available options:
AUTO,
MANUAL_REQUIRED,
UNSUPPORTED
manual_reason
string

Why the refund is not automatic or not available, in words the customer can be shown; never the supplier’s wording. Present whenever support_level is not AUTO. With UNSUPPORTED it is the sentence a flight_refund_preview refusal (409 not_cancellable) carries for the same booking. With MANUAL_REQUIRED, where the reason would be the supplier’s own words, it reads “This request needs manual handling by Jinko support.”

Example:

"fare rules require agent review"

reason_code
string

Why the refund is not automatic or not available, as a code to route on: NON_REFUNDABLE_FARE, EXCHANGED_TICKET, DOCUMENT_RETIRED, CARRIER_NOT_AUTHORIZED, NOT_CANCELLABLE (a refusal the supplier gave no code for). When support_level is UNSUPPORTED, it is always present and is the same code a flight_refund_preview refusal (409 not_cancellable) carries for this booking.

Example:

"NON_REFUNDABLE_FARE"

expires_at
string
Example:

"2026-06-02T00:00:00Z"

warnings
string[]

Notes about the booking and its documents, each said once, in words the customer can be shown. A note the supplier sends as free text without a code is left out.