BYbyaccrue
YieldPayouts

List Float Revenue Payouts

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.

get/api/v1/yield-payouts/

Request

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.

Example:2026-07-01
filter[periodTo]string

Only payouts whose period ends on or before this date, as YYYY-MM-DD. Inclusive.

Example:2026-09-30

Headers

Client-IDstring 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.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "amount": 34932,
        "currency": "USD",
        "periodStart": "2026-09-01",
        "periodEnd": "2026-09-30",
        "paidAt": "2026-10-01T14:02:11.000Z"
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.