---
title: "Get Float Revenue Payout"
method: GET
path: "/api/v1/yield-payouts/:yieldPayoutId"
tags: ["YieldPayouts"]
---

# Get Float Revenue Payout

`GET /api/v1/yield-payouts/:yieldPayoutId`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/yield-payouts/:yieldPayoutId`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/yield-payouts/:yieldPayoutId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get one float revenue payout, including the per-account breakdown of how it was earned and the rates that applied.

An unknown id, an id belonging to another merchant, and a payout that has not been paid yet all return `404 YieldPayoutNotFound` — the three are deliberately indistinguishable.

## Path parameters

- `yieldPayoutId` string, uuid, required: ID of the payout to fetch.

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

OK

- GetYieldPayoutResponse
  - `data` object, required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'YieldPayout', required
    - `attributes` object, required
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
      - `amount` integer, required: Float revenue earned over the period, in cents. This is your own revenue, not the gross interest Accrue received from the bank.
      - `currency` string, required: ISO 4217 currency code.
      - `periodStart` string, required: First day the payout covers, as `YYYY-MM-DD`. Inclusive.
      - `periodEnd` string, required: Last day the payout covers, as `YYYY-MM-DD`. Inclusive.
      - `paidAt` string, required: When the payout was paid, as an ISO 8601 datetime.
      - `spreadBasisPoints` integer, required: The contractual spread deducted from the reference rate, in basis points.
      - `breakdown` YieldPayoutBreakdownLine[], required: What each of your counterparties earned over the period. Amounts sum exactly to the payout's `amount` — use that as your reconciliation check. A period in which no counterparty held a balance returns an empty array and an `amount` of zero.
        - `counterpartyId` string, uuid, required: The counterparty that earned this amount, matching the ids returned by the counterparties API.
        - `dayCount` integer, required: Days within the period the counterparty held a balance. Lower than the period's length when it was opened partway through it — days before it existed are excluded rather than counted as a zero balance.
        - `averageDailyBalance` string, required: Average balance across `dayCount`, as an integer number of cents in a decimal string. Sent as a string because an average balance can exceed the range the integer fields use; parse it with an arbitrary-precision integer type, never as a float.
        - `amount` integer, required: What this counterparty earned, in cents. The lines sum exactly to the payout's `amount`.
      - `rateSegments` YieldPayoutRateSegment[], required: The rates that applied across the period, in order. More than one entry means the reference rate changed mid-period, in which case a breakdown line cannot be recomputed from `averageDailyBalance` alone and the line `amount` is authoritative.
        - `from` string, required: First day of the stretch this rate applied to, as `YYYY-MM-DD`. Inclusive.
        - `to` string, required: Last day of the stretch, as `YYYY-MM-DD`. Inclusive.
        - `referenceRateBasisPoints` integer, required: The Federal Funds Target Rate in force, in basis points, before the contractual spread. This is the upper limit of the FOMC's target range — for a range of 4.25-4.50%, `450` — published by FRED as `DFEDTARU`.
        - `effectiveRateBasisPoints` integer, required: The rate actually applied to balances, in basis points: the reference rate less the spread, never below zero.
        - `dayCount` integer, required: Days in the stretch.

## Other responses

- `404`: Yield payout not found

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)