v5

latestOpenAPI 3.1.02026-08-044697208.6 KB
Earnings Stream

Get Earnings Stream Payouts

Get an Earnings Stream of payout objects representing discrete cash flow events. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

get/end_users/{end_user_id}/earnings_stream/payouts

Path parameters

end_user_idstring required

User ID provided by you, to associate Pinwheel users with your user model.

User ID provided by you, to associate Pinwheel users with your user model.

Query parameters

cursorstring

Cursor for the page you want to retrieve.

Cursor for the page you want to retrieve.

limitinteger

The maximum number of results to return.

The maximum number of results to return.

Headers

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

Response

OK