Skip to main content
POST
/
v1
/
refund_status
Check the status of a refund
curl --request POST \
  --url https://api.example.com/v1/refund_status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "booking_ref": "JNK-A0AUR2",
  "last_name": "Carrard"
}
'
{
  "refund_status": "refunded",
  "provider_status": "COMPLETED",
  "refund_amount": {
    "value": 318.4,
    "amount": 123,
    "currency": "USD",
    "decimal_places": 2
  },
  "refund_reference": "rfnd_3c91f0a2",
  "warnings": [
    "<string>"
  ]
}
Poll for terminal state of a previously committed refund.

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
​
refund_reference
string

Response

Check the status of a refund

​
refund_status
string
Example:

"refunded"

​
provider_status
string
Example:

"COMPLETED"

​
refund_amount
object
​
refund_reference
string
Example:

"rfnd_3c91f0a2"

​
warnings
string[]