---
title: "List Float Revenue Payouts"
method: GET
path: "/api/v1/yield-payouts/"
tags: ["YieldPayouts"]
---

# List Float Revenue Payouts

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

## Request

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

List float revenue payouts, most recent period first.

Only payouts that have been paid are returned — a period that has closed but not yet settled is not listed, and is not addressable by id either. Periods are contiguous and never overlap, so the most recent `periodEnd` you have reconciled is a complete watermark with no earlier gap to backfill.

## Query parameters

- `page[limit]` number: Maximum number of objects that will be returned. Can not be greater than 50.
- `page[offset]` number: Offset from the beginning of the list of objects. Can not be negative.
- `filter[periodFrom]` string: Only payouts whose period ends on or after this date, as `YYYY-MM-DD`. Inclusive. Matches against the last day of the period covered, not the date the payout was paid.
- `filter[periodTo]` string: Only payouts whose period ends on or before this date, as `YYYY-MM-DD`. Inclusive.

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

- ListYieldPayoutsResponse
  - `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.
  - `meta` object, required
    - `total` number, required
    - `limit` number, required
    - `offset` number, required

## Other responses

- `400`: Bad Request

---

[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)