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_automatable
boolean
Example:

true

support_level
string
Example:

"full"

refund_amount
object
penalty_amount
object
total_paid
object
expires_at
string
Example:

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

warnings
string[]