Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.decodahealth.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks through creating a charge with items (products, services, discounts) via the API and collecting payment through the embedded payment component. Use this when your integration needs to show an itemized receipt before the patient pays.

​
Overview

  1. Create a charge with line items and discounts using the Create Charge or Convert Cart to Charge API.
  2. Build the embed URL with the charge ID.
  3. Patient pays in the embed — the form displays the full charge breakdown (items, discounts, total).

​
Step 1: Create a charge with items

You can create a charge in two ways:

​
Option A: Convert a cart to a charge

If you have a cart with items already added:
  1. Create a cart for the patient.
  2. Add items (products, services, packages) to the cart.
  3. Convert the cart to a charge.
The response includes the charge ID (id).

​
Option B: Create a charge directly

Use Create Charge with a ChargeDetail body that includes:
  • patient_id
  • items — array of line items with name, quantity, price, and optional discounts
  • total_outstanding — sum of item totals minus discounts
Example request body (simplified): 
{
  "patient_id": "pat_xxx",
  "total_outstanding": 8500,
  "items": [
    {
      "name": "Consultation",
      "quantity": 1,
      "price": 10000,
      "discounts": [{ "amount": 1500, "order": 0, "quantity": 1 }]
    }
  ]
}
The response returns the charge with its id (e.g. chg_xxx).

​
Step 2: Build the embed URL

Construct the embed URL with the charge ID: 
https://app.decodahealth.com/{tenant}/embed/pay/{patientId}?charge_id={chargeId}
Replace:
  • {tenant} — your organization’s subdomain
  • {patientId} — the patient’s ID (must match the charge’s patient)
  • {chargeId} — the charge ID from step 1

​
Optional URL parameters

ParameterDescription
allowedMethodsComma-separated payment methods. Use CARD to disable ACH, or CARD,APPLE_PAY for card and Apple Pay only.
themelight or dark
showSummarytrue (default) or false to hide the payment summary
Example — card only, dark theme: 
?charge_id=chg_xxx&allowedMethods=CARD&theme=dark

​
Step 3: Load the embed

Embed the URL in an iframe on your site: 
<iframe
  src="https://app.decodahealth.com/your-tenant/embed/pay/pat_xxx?charge_id=chg_xxx&allowedMethods=CARD"
  width="100%"
  height="500"
  allow="payment"
  style="border: none; border-radius: 8px;"
></iframe>
Listen for payment events via postMessage: 
window.addEventListener('message', function(event) {
  if (event.data.type === 'payment_success') {
    console.log('Payment successful:', event.data.payinId);
  } else if (event.data.type === 'payment_failure') {
    console.log('Payment failed:', event.data.error);
  } else if (event.data.type === 'payment_loaded') {
    console.log('Payment form loaded');
  }
});

​
API flow

When the embed loads, it calls the Create Embed Payment Config endpoint with charge_id. The endpoint:
  1. Loads the charge from the database (with items and discounts).
  2. Creates a Rainforest payin config for that charge.
  3. Returns the session key and payin config ID.
The embed uses these to initialize the payment form. When the patient pays, the payment is applied to the existing charge — no duplicate charge is created.

​
Disabling payment methods

To restrict which payment methods appear in the embed, add allowedMethods to the URL:
  • allowedMethods=CARD — card only (no ACH, no Apple Pay)
  • allowedMethods=CARD,APPLE_PAY — card and Apple Pay (no ACH)
  • allowedMethods=CARD,ACH — card and ACH (no Apple Pay)
The default is CARD,ACH,APPLE_PAY when not specified.