Skip to main content
POST
/
v1
/
refund_check
Check refund eligibility and estimated amount
curl --request POST \
  --url https://api.example.com/v1/refund_check \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "booking_ref": "JNK-A0AUR2",
  "last_name": "Carrard"
}
'
{
  "is_refundable": true,
  "is_automatable": true,
  "support_level": "full",
  "refund_amount": {
    "value": 318.4,
    "amount": 123,
    "currency": "USD",
    "decimal_places": 2
  },
  "penalty_amount": {
    "value": 318.4,
    "amount": 123,
    "currency": "USD",
    "decimal_places": 2
  },
  "total_paid": {
    "value": 318.4,
    "amount": 123,
    "currency": "USD",
    "decimal_places": 2
  },
  "expires_at": "2026-06-02T00:00:00.000Z",
  "warnings": [
    "<string>"
  ]
}
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

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:00.000Z"

​
warnings
string[]