> ## 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.

# payoutBreakdown

> Per-order lines and fees for one payout. Null when payments are not enabled for this store, or when the payout id is unknown.

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

## Arguments

<ResponseField name="payoutId" type="ID!" required>
  Opaque payout id, from `payouts` or from `paymentTransactions` → `payout.id`.
</ResponseField>

## Returns

<ResponseField name="payoutBreakdown" type={<a href="/docs/api-reference/v3/reference/payments/payout-breakdown">PayoutBreakdown</a>}>
  One payout plus every order line that makes it up, and how many provider transactions sit behind those lines.

  <Expandable title="fields" lazyRender>
    <ResponseField name="lines" type={<a href="/docs/api-reference/v3/reference/payments/payout-line">[PayoutLine!]!</a>} required>
      Every order line in this payout, in provider order. The list is the whole payout, not a page.

      <Expandable title="fields" lazyRender>
        <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
          Net contribution of this line to the payout. Negative when the line is only a refund.

          <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="customerName" type="String">
          Customer name on the order, when it was collected.
        </ResponseField>

        <ResponseField name="merchantReference" type="String">
          The merchant's own reference for the order, when one was recorded.
        </ResponseField>

        <ResponseField name="orderGross" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
          Gross amount of the whole order, before fees. This is the order's figure, not this payout's share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.

          <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="orderLmnFee" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
          Letter-of-medical-necessity fee on the whole order. This is the order's figure, not this payout's share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.

          <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="orderPlatformFee" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
          Redo's platform commission on the whole order (excludes the LMN fee). Card-processing costs are not charged to the merchant. This is the order's figure, not this payout's share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.

          <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">
          Order reference, or null when the line could not be matched to an order.
        </ResponseField>

        <ResponseField name="orderTotalFees" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
          Platform fee plus LMN fee for the whole order. This is the order's figure, not this payout's share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.

          <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="types" type={<a href="/docs/api-reference/v3/reference/payments/payout-line-type">[PayoutLineType!]!</a>} required>
          How this line contributed. A line that both captured and refunded lists both.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="payout" type={<a href="/docs/api-reference/v3/reference/payments/payout">Payout!</a>} required>
      The payout these lines settle.

      <Expandable title="fields" lazyRender>
        <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/money">Money!</a>} required>
          Amount of the payout. Positive for both deposits and reversals.

          <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="confirmedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime</a>}>
          When the payout report confirmed this payout, as a UTC instant. Null until the report lands.
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime</a>}>
          When the payout was created, as a UTC instant.
        </ResponseField>

        <ResponseField name="date" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
          Banking value date of the payout (YYYY-MM-DD): the date the deposit is valued, not the order date.
        </ResponseField>

        <ResponseField name="estimatedArrivalDate" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
          Estimated calendar date the funds arrive at the bank.
        </ResponseField>

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

        <ResponseField name="status" type={<a href="/docs/api-reference/v3/reference/payments/payout-status">PayoutStatus!</a>} required>
          Settlement status of the payout.
        </ResponseField>

        <ResponseField name="type" type={<a href="/docs/api-reference/v3/reference/payments/payout-type">PayoutType!</a>} required>
          Whether this row is a deposit or a reversal.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="transactionCount" type="Int!" required>
      Number of provider transaction rows combined into `lines`.
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

```graphql theme={null}
query {
  payoutBreakdown(payoutId: "...") {
    transactionCount
  }
}
```


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