GOgojinko
Post-booking

DEPRECATED — use /v1/flight_refund_commit. Initiate a refund for a booked flight

Call get_booking first. Use booking_ref and the selected booked_item_id for every servicing action. last_name is required for guest lookup; an owning credential may omit it. The deprecated provider, order_id, provider_reference and provider_booking_id are accepted until 2027-04-30 where the request declares them; a request that sends one is answered with Deprecation and Sunset headers. A 409 item_selection_required returns safe items to choose from.

post/v1/refund_commit

Request

  • Base URL
    https://api.gojinko.com
  • URL
    https://api.gojinko.com/v1/refund_commit
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

booking_refstring

Jinko booking reference. Call get_booking first, then select its booked_item_id for servicing.

booked_item_idstring

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.

last_namestring

Required for guest lookup. A credential that owns the booking may omit it; ownership is checked by the platform.

order_idstring

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.

providerstring

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.

Example request

{
  "booking_ref": "JNK-A0AUR2",
  "last_name": "Doe"
}

Response

Initiate a refund for a booked flight

refund_status'PENDING' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'MANUAL_REQUIRED' | 'UNCONFIRMED' | 'CANCELLED'

The refund's processing status. PENDING and IN_PROGRESS mean it is still running — poll operation. MANUAL_REQUIRED means a Jinko agent has it: raised, parked, NOT failed. UNCONFIRMED means the airline has not settled its answer yet. SUCCEEDED, FAILED and CANCELLED are terminal. state beside it reports the same operation in the platform vocabulary; either is enough to decide whether to keep polling.

operationstring

The refund this call started ("svc_…"). Refunding at the airline and returning the money to the customer's card are separate steps, so this call answering does not mean both finished — poll the handle with POST /v1/flight_refund_status until state is terminal.

state'in_progress' | 'attention_required' | 'succeeded' | 'failed'

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.

operation_kind'cancel' | 'void'

What the platform would do, or did. cancel — refund the ticket under the fare rules, less the penalty. void — the ticket is inside its void window, so it is voided and the original charge is reversed in full, penalty-free. The platform decides from the live state of the documents; the caller cannot ask for one.

refund_referencestring
warningsstring[]

Example response

{
  "refund_status": "IN_PROGRESS",
  "operation": "svc_01J7ZR5Q2KME8V4T",
  "refund_amount": {
    "value": 41250,
    "currency": "USD",
    "decimal_places": 2,
    "display": "USD 412.50"
  },
  "refund_reference": "svc_agqsfzamchoagwznss4z3gwobm5tpxx3r4n5tfrngy"
}

Changes

No recorded changes to this operation across all 1 revision of this API.