BYbyaccrue
YieldPayouts

Get Float Revenue Payout

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.

get/api/v1/yield-payouts/:yieldPayoutId

Request

Path parameters

yieldPayoutIdstring uuid required

ID of the payout to fetch.

Example:123e4567-e89b-12d3-a456-426614174000

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",
      "spreadBasisPoints": 200,
      "breakdown": [
        {
          "counterpartyId": "123e4567-e89b-12d3-a456-426614174000",
          "dayCount": 30,
          "averageDailyBalance": "10000000",
          "amount": 20548
        }
      ],
      "rateSegments": [
        {
          "from": "2026-09-01",
          "to": "2026-09-30",
          "referenceRateBasisPoints": 450,
          "effectiveRateBasisPoints": 250,
          "dayCount": 30
        }
      ]
    }
  }
}

Changes

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