TRtryvital
checkout

Get Session

Changed on

Get the checkout session snapshot.

In-flight sessions reflect live workflow state; terminal sessions are served from the persisted snapshot. A read arriving moments after session creation can 404 until the workflow's first persistence write commits.

get/checkout/v1/session/{checkout_session_id}

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/checkout/v1/session/{checkout_session_id}
  • Auth
    API key in header x-vital-api-key

Path parameters

checkout_session_idstring uuid required

Response

Successful Response

checkout_session_idstring uuid required
status'unpaid' | 'paid' | 'expired' | 'cancelled' required

ℹ️ This enum is non-exhaustive.

pay_beforestring date-time required
payment_resource_idstring nullable required

ID of the Stripe Checkout Session (cs_...) or PaymentIntent (pi_...) collecting payment. null until the payment resource is created.

order_idstring uuid nullable required
order_transaction_idstring uuid nullable required
appointment_hold_status'pending' | 'held' | 'failed' required

Public view of the checkout's PSC appointment hold. None on the snapshot means no appointment was requested. held covers both a live vendor hold and the attached appointment (appointment_id set); failed covers every way the hold ended without one (slot gone, PSC unreachable, released on expiry, cancellation, or operator request). ℹ️ This enum is non-exhaustive.

appointment_idstring uuid nullable required
payment_resource_urlstring nullable

Stripe-hosted payment page URL, for the checkout_session payment method. Returned only by the create, get and confirm endpoints while status is unpaid; always null in webhooks.

payment_resource_client_secretstring nullable

Client secret for confirming the Stripe PaymentIntent with Stripe.js, for the payment_intent payment method. Returned only by the create, get and confirm endpoints while status is unpaid; always null in webhooks.

Example response

{
  "pay_before": "2021-01-01T00:00:00Z"
}

Changes

  • 3e309c4d6b55Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 35704f3613e5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status