API ReferenceTruemed Sessions

Get Truemed Session

Retrieve the full state of one Truemed session: its qualification status, order items, and every recorded capture, refund, and auth hold. This is the canonical lookup you reconcile against after a truemed_session.updated webhook fires — webhooks signal each qualification change, so there’s no need to poll.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Path parameters

truemed_session_idstringRequired
The Truemed session ID from the URL path.

Response

Successful response
auth_holdslist of objects
Authorization holds recorded against this session, oldest first.
captureslist of objects

Merchant-reported captures recorded against this session.

cart_infoobject
Eligibility statement about the cart.
created_atdatetime
When the session was created.
customer_emailstring
The customer's email address, echoed from the create request.
customer_namestring
The customer's full name, echoed from the create request.
is_testingboolean
Whether this session was created in test mode.
order_itemslist of objects
Cart line items, echoed as a denormalized snapshot captured at session creation.
qualification_infoobject
Qualification statement about the shopper.
refundslist of objects
Refunds recorded against this session, oldest first.
truemed_session_idstring
The unique ID for this Truemed session.
user_idstring
Your stable identifier for this customer, echoed from the create request.
metadatastring or null
Opaque value echoed from session creation.

Errors

400
Bad Request Error
404
Not Found Error
405
Method Not Allowed Error
500
Internal Server Error
501
Not Implemented Error