Setup Guide

Checkout Champ Integration

Checkout Champ integrates directly with the Medpaid Plugin API — no plugin to install. You configure the connection via API calls and embed a cart push in your CC funnel pages.

Before you start: You need an active Medpaid merchant account and a Checkout Champ account. Contact support@medpaid.com to get your OnboardingKey and ExternalKey credentials.

Prerequisites

You need an active Checkout Champ account and Medpaid merchant credentials (OnboardingKey and ExternalKey). Contact support@medpaid.com to get credentials if you do not have them yet.

Configure your platform

Call configure-platform once during setup with your CC store domain, redirect URLs, and plugin key. This links your CC store to your Medpaid account.

json

POST https://api.medpaid.com/plugin/clients/checkout-champ/configure-platform

{
  "ExternalKey": "ek_your_key",
  "OnboardingKey": "ok_your_key",
  "StoreDomain": "yourstore.com",
  "CartCallbackUri": "https://yourstore.com/medpaid/callback",
  "OrderConfirmationRedirectUri": "https://yourstore.com/order-confirmation",
  "PluginApiUri": "https://yourstore.com/api/medpaid",
  "PluginKey": "pk_your_plugin_key"
}

// Response:
true

Verify your configuration

Call check-platform to confirm every required field is set. Do not go live until IsOk is true.

json

POST https://api.medpaid.com/plugin/clients/checkout-champ/check-platform

{
  "ExternalKey": "ek_your_key",
  "OnboardingKey": "ok_your_key"
}

// Expected response:
{
  "IsOk": true,
  "HasStoreDomain": true,
  "HasPluginKey": true,
  "HasCartCallbackUri": true,
  "HasOrderConfirmationRedirectUri": true,
  "HasPluginApiUri": true,
  "Errors": []
}

Push the cart from your CC page

On your Checkout Champ order page, add a script that pushes the cart when the customer selects Medpaid HSA/FSA as their payment method. Redirect the customer to the returned CartReference URL.

javascript

// CC order page — push cart on Medpaid selection
async function initMedpaidCheckout(order) {
  const res = await fetch(
    'https://api.medpaid.com/plugin/cart/checkout-champ/push',
    {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({
        Action: 'checkout',
        Source: 'checkout-champ',
        PlatformId: 'your-platform-id',
        OnboardingKey: 'ok_your_key',
        ExternalKey: 'ek_your_key',
        OrderData: {
          OrderId: order.id,
          OrderDate: order.date,
          Email: order.customer.email,
          CurrencyCode: 'USD',
          LineItems: order.items.map(item => ({
            ProductId: item.medpaidProductId,
            Quantity: item.qty,
            Subtotal: item.subtotal,
            Total: item.total,
          })),
          Total: order.total,
        },
        PaymentSuccessRedirect: 'https://yourstore.com/order-confirmation',
        PaymentFailureRedirect: 'https://yourstore.com/checkout',
        IsSubscription: false,
      }),
    }
  );
  const { CartReference } = await res.json();
  window.location.href =
    `https://portal.medpaid.com/checkout/${CartReference}`;
}

Sync your products

Import your CC product catalog into Medpaid so eligibility review can run. Call this once during setup and whenever your catalog changes.

json

POST https://api.medpaid.com/plugin/onboarding/checkout-champ/import-products

{
  "OnboardingKey": "ok_your_key",
  "ExternalKey": "ek_your_key",
  "Products": [
    {
      "ExternalId": "cc-product-456",
      "Title": "Cold Plunge Tub",
      "Vendor": "Your Brand",
      "ProductUrl": "https://yourstore.com/products/cold-plunge",
      "ImageUrl": "https://yourstore.com/images/cold-plunge.jpg"
    }
  ]
}

// Response:
{ "Imported": 8, "Skipped": 0 }

Test and go live

Place a test order through CC with a Medpaid test HSA card. Confirm the cart push fires, the shopper is redirected through the assessment flow, and the order appears in your Medpaid dashboard. Then enable for all customers.

Using Checkout Champ for post-purchase reimbursement?

The Medpaid Reimburse solution adds HSA/FSA reimbursement to your CC order confirmation page without changing your checkout flow.

View Medpaid Reimburse → Email support

What's next

API Reference Cart push (Checkout Champ) → Solution Medpaid Reimburse →