Create Truemed Session Refund

curl -X POST https://dev-api.truemed.com/api/v2/truemed_sessions/truemed_session_id/refunds/create \
     -H "x-truemed-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "idempotency_key": "refund-shop-pay-1001",
  "item_details": [
    {
      "item_id": "line_item_1",
      "quantity": 1,
      "total": 11850,
      "amount_details": {
        "additional_charges_details": [
          {
            "amount_cents": 850,
            "display_level": "tax",
            "name": "Tax"
          }
        ],
        "discounts_details": [
          {
            "amount_cents": 1000,
            "display_level": "line_item",
            "name": "WELCOME10"
          }
        ]
      }
    }
  ]
}'

Record a refund you already issued on your own payment rail. Itemize the refunded lines with the item_details array — the refunded amount is derived from their totals, so there is no separate amount field — and Truemed updates the session history and adjusts the fee basis to match the reduced charge.

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.

Request

Request body for CreateTruemedSessionRefundRequest

idempotency_keystringRequired1-200 characters

A unique key making this request safely retryable.

item_detailslist of objectsRequired

Itemized attribution for the refund. Each entry refunds part of a line item, up to its refundable quantity and total from the session detail. The refunded amount is derived from these line totals, not a separate amount field.

Response

Successful response

refund_idstring

Truemed’s stable ID for this refund (mrt_refund_<id>).

refunded_amount_centsinteger

Cumulative refunded amount on this session, in cents, including this refund.

truemed_session_idstring

The session the refund was recorded against.

Errors

400

Bad Request Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

501

Not Implemented Error

1	{
2	"refund_id": "mrt_refund_4101",
3	"refunded_amount_cents": 11850,
4	"truemed_session_id": "ts_01JZ7D4M3A8B9C0D1E2F3G4H5J"
5	}