Skip to main content
POST
DEPRECATED — use /v1/flight_refund_status. Check the status of a refund
Poll for terminal state of a previously committed refund.

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

Response

Check the status of a refund

refund_status
string

Where the refund has got to. Current refunds use PENDING, IN_PROGRESS, SUCCEEDED, FAILED, MANUAL_REQUIRED, UNCONFIRMED, or CANCELLED. Older refunds may report other status values, which is why this field is not published as a closed list. Treat an unrecognised value as "still running" and poll state, which is one vocabulary for both.

Example:

"SUCCEEDED"

operation
string

The refund being reported ("svc_…"), for refunds started on the servicing path. POST /v1/flight_refund_status reads the same operation and adds where the money itself has got to.

Example:

"svc_01J7ZR5Q2KME8V4T"

state
enum<string>

Where the cancellation has got to. in_progress — running; keep polling. attention_required — stalled on something a person at Jinko has to resolve (reason names it); keep polling, and do not report it to the customer as a failure, because the booking may already be cancelled at the supplier. succeeded and failed are terminal: the supplier outcome and the money are both settled and nothing further will change.

Available options:
in_progress,
attention_required,
succeeded,
failed
refund_amount
object

THE CUSTOMER FIGURE: what goes back to the payment method — the settled figure once the refund has settled, the quoted one before. Absent is not zero.

refund_reference
string
Example:

"svc_agqsfzamchoagwznss4z3gwobm5tpxx3r4n5tfrngy"

warnings
string[]