Get Shop Pay Truemed Session

{
  "auth_holds": [
    {
      "created_at": "2024-01-15T09:30:00Z"
    }
  ],
  "captures": [
    {
      "amount_cents": 1,
      "capture_id": "string",
      "capture_info": {
        "capture_time": "2024-01-15T09:30:00Z",
        "card_holder_name": "string",
        "last4": "string",
        "merchant_descriptor": "string",
        "network": "amex",
        "postal_code": "string",
        "network_transaction_id": "string"
      },
      "capture_time": "2024-01-15T09:30:00Z",
      "idempotency_key": "string"
    }
  ],
  "cart_info": {
    "eligible_amount_cents": 1,
    "ineligible_amount_cents": 1,
    "preapproved_amount_cents": 1
  },
  "created_at": "2024-01-15T09:30:00Z",
  "customer_email": "string",
  "customer_name": "string",
  "is_testing": true,
  "order_items": [
    {
      "item_id": "string",
      "name": "string",
      "preapproved_amount_cents": 1,
      "price": 1,
      "quantity": 1,
      "sku": "string",
      "amount_details": {
        "additional_charges_details": [
          {
            "amount_cents": 1,
            "display_level": "order",
            "name": "string"
          }
        ],
        "discounts_details": [
          {
            "amount_cents": 1,
            "display_level": "order",
            "name": "string"
          }
        ]
      },
      "eligible_amount_cents": 1,
      "ineligible_amount_cents": 1
    }
  ],
  "qualification_info": {
    "qualification_status": "pending_user_intake"
  },
  "refunds": [
    {
      "amount_cents": 1,
      "created_at": "2024-01-15T09:30:00Z",
      "refund_id": "string",
      "idempotency_key": "string"
    }
  ],
  "truemed_session_id": "string",
  "user_id": "string",
  "metadata": "string"
}

Retrieve the full state of one Truemed session: its qualification status, order items, and every capture and auth hold recorded against it. This is the lookup you reconcile against after a truemed_session.pending_authorization or truemed_session.truemed_review_complete webhook fires. The webhooks signal every qualification transition you need to act on, so you don’t need to poll this endpoint.

Retrieve the full state of one Truemed session: its qualification status, order items, and every capture and auth hold recorded against it. This is the lookup you reconcile against after a `truemed_session.pending_authorization` or `truemed_session.truemed_review_complete` webhook fires. The webhooks signal every qualification transition you need to act on, so you don't need to poll this endpoint.

Authentication

x-truemed-api-keystring

Platform API key for platform server-to-server authentication

Path parameters

truemed_session_idstringRequired

The Shop Pay 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

Reported captures recorded against this session, oldest first.

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 durable 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

$	curl https://dev-api.truemed.com/api/v2/shop_pay/truemed_sessions/truemed_session_id \
>	-H "x-truemed-api-key: <apiKey>"