Skip to main content
POST
Check refund eligibility and estimated amount
Run first when a user asks to cancel: shows refund amount, penalties, and whether processing is automatic.

Authorizations

X-API-Key
string
header
required

Body

application/json
booking_ref
string
required
Example:

"JNK-A0AUR2"

last_name
string
required
Example:

"Carrard"

ticket_numbers
string[]
provider
string
intent
object

Response

Check refund eligibility and estimated amount

is_refundable
boolean
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. On a void, refund_amount is legitimately absent: the caller gets total_paid back. 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 (manual_reason says why). 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.

Available options:
AUTO,
MANUAL_REQUIRED,
UNSUPPORTED
manual_reason
string

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

Example:

"fare rules require agent review"

refund_amount
object

What would be refunded. Absent is not zero — on a voidable ticket (is_voidable: true) the whole charge is reversed and no amount is quoted, and on an unsupported refund nothing is computed at all. Read is_refundable and is_voidable before showing a figure.

penalty_amount
object
total_paid
object
expires_at
string
Example:

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

warnings
string[]