Cancel Shop Pay Truemed Session
Authentication
Platform API key for platform server-to-server authentication
Platform API key for platform server-to-server authentication
Cancel a pending Truemed session. Use this when the shopper never finished the flow or you withdrew the offer. The endpoint takes no request body and is idempotent: canceling an already-canceled session is a no-op that returns the same canceled state.
You can cancel a session any time before a capture is reported: from creation, through the survey, an authorization hold, and clinical review. A canceled session reads qualification_info.qualification_status = canceled and stops accepting survey completions and holds. Its order_items keep the merchant-visible eligibility split: eligible_amount_cents is omitted until the shopper completes the survey; after that, each line reports the HSA/FSA-eligible amount (> 0 for an eligible line, 0 for a line that was ineligible or clinically rejected). Once a capture has been reported you can no longer cancel, and the call returns a 400; to return money to the shopper after capture, issue a refund instead.