Payment Sessions

Payments Overview

Overview of the End-to-End “Pay with HSA / FSA” Flow

Integration with Truemed’s payment flow requires:

  • Calling the create_payment_session endpoint
  • Redirecting the user to Truemed’s payment flow (returned in the redirect_url)
    • User completes a health survey to determine eligibility to use HSA/FSA funds
    • If eligible, Truemed collects HSA/FSA card details and processes the payment
  • Providing Truemed with Success & Failure Redirect URLs to redirect the user to in either case
  • Implementing a callback so Truemed can inform the partner about the status of the payment
    • The status will change to processing while under review.
      • User-facing messaging should indicate that the order has successfully been placed.
      • Truemed will invoke the partner’s webhook once the payment has undergone a review
        • Upon receiving a status of captured, the order should be fulfilled.
        • Upon receiving a status of rejected, the order should be canceled and the user notified.

Important URLs

EnvironmentBase API URL
Staginghttps://dev-api.truemed.com/payments/v1/
Productionhttps://api.truemed.com/payments/v1/

Successful Payment Flow

Failed Payment Flow

Upon failure, the user can go back to the partner’s provided failure_url: