Skip to main content
POST
Check the status of an exchange
Poll for terminal state of a previously committed exchange: confirmed, partial_failure or failed. While an ADD_COLLECT exchange waits for the customer’s payment, the answer reads pending and carries checkout_url, the page to send the customer to.

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

Response

Check the status of an exchange

airline_locator
string
deprecated

Deprecated: read the item’s supplier_references on POST /v1/get_booking, which carries each airline’s record locator with the airline that issued it. Airline record locator for the current itinerary.

Example:

"ABC123"

booking_ref
string
Example:

"JNK-A0AUR2"

booking_reference
string
deprecated

Deprecated: use booking_ref instead. Same value.

Example:

"JNK-A0AUR2"

status
enum<string>

pending until the exchange is carried out — including while it waits for the customer’s payment, and while a Jinko agent has it (manual_handling).

Available options:
confirmed,
pending,
partial_failure,
failed
Example:

"confirmed"

new_ticket_numbers
string[]
Example:
confirmed_payment_outcome
string
Example:

"paid"

checkout_url
string

Present while the exchange waits for the customer to pay the difference: the same page exchange_commit returned. The exchange runs once that payment authorizes.

Example:

"https://app.gojinko.com/checkout?t=eyJyIjoiY2FydCIs…"

manual_handling
object

Present while the exchange is with a Jinko agent: it could not be completed automatically. status stays PENDING and polling does not move it; the agent does. Absent once the exchange is carried out or failed.

warnings
string[]

Notes about the booking and its documents, each said once, in words the customer can be shown. A note the supplier sends as free text without a code is left out.