> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PaymentTransaction

> One HSA/FSA order on the payments ledger: what was charged, the fees taken, any refund, and the payout that settled it.

**Required scopes:** [`payments_read`](/docs/api-reference/v3/reference/scopes#scope-payments_read)

<ResponseField name="cartType" type={<a href="/docs/api-reference/v3/reference/payments/payment-transaction-cart-type">PaymentTransactionCartType!</a>} required>
  Whether the cart was HSA/FSA eligible, regular, or split.
</ResponseField>

<ResponseField name="checkoutId" type="String">
  Public checkout id for the session that took this payment.
</ResponseField>

<ResponseField name="customerName" type="String">
  Customer name on the order, when the checkout collected one.
</ResponseField>

<ResponseField name="gross" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
  Amount charged for the order, before fees and refunds.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="lmnFee" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
  Letter-of-medical-necessity fee taken from this order.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="merchantReference" type="String">
  The merchant's own reference for the order, when the checkout recorded one. Use this, with `orderReference`, to match a row to an order in your system.
</ResponseField>

<ResponseField name="netToMerchant" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
  Amount kept by the merchant after fees and refunds.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="orderReference" type="String!" required>
  Provider order reference for this charge.
</ResponseField>

<ResponseField name="orderedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
  When the order was placed, as a UTC instant.
</ResponseField>

<ResponseField name="paymentMethods" type={<a href="/docs/api-reference/v3/reference/payments/payment-method">[PaymentMethod!]!</a>} required>
  Cards charged for this order, one per payment leg. A split payment lists more than one.

  <Expandable title="fields" lazyRender>
    <ResponseField name="brand" type="String">
      Display label for the card brand, for example "Visa". Not a processor code.
    </ResponseField>

    <ResponseField name="lastFour" type="String">
      Last four digits of the card, when the method display includes them.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="payout" type={<a href="/docs/api-reference/v3/reference/payments/payment-transaction-payout">PaymentTransactionPayout</a>}>
  Payout that settled this order's capture. Null until the payout is known.

  <Expandable title="fields" lazyRender>
    <ResponseField name="date" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
      Banking value date of the payout (YYYY-MM-DD), or null while that date is not known.
    </ResponseField>

    <ResponseField name="id" type="ID!" required>
      Opaque id of the payout. Pass it to `payoutBreakdown` for the per-order lines.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="platformFee" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
  Redo's platform commission on the order (excludes the LMN fee). Card-processing costs are not charged to the merchant.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="refunded" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
  Amount refunded to the customer. Zero when nothing was refunded.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="status" type={<a href="/docs/api-reference/v3/reference/payments/payment-transaction-status">PaymentTransactionStatus!</a>} required>
  Refund status of the payment.
</ResponseField>

<ResponseField name="totalFees" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
  Platform fee plus LMN fee.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.