---
title: "Get Earnings Stream Payouts"
method: GET
path: "/end_users/{end_user_id}/earnings_stream/payouts"
tags: ["Earnings Stream"]
---

# Get Earnings Stream Payouts

`GET /end_users/{end_user_id}/earnings_stream/payouts`

## Request

- Base URL: `https://api.getpinwheel.com/v1`
- URL: `https://api.getpinwheel.com/v1/end_users/{end_user_id}/earnings_stream/payouts`
- Auth: API key in header `X-API-SECRET`
- TypeScript: <https://skmtc.dev/getpinwheel/apis/pinwheel/docs/end_users/:end_user_id/earnings_stream/payouts/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `end_user_id` string, required: User ID provided by you, to associate Pinwheel users with your user model.

## Query parameters

- `cursor` string: Cursor for the page you want to retrieve.
- `limit` integer: 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

## Response `200`

OK

- object
  - `meta` FreshnessPaginationListMeta, required
    - `refreshed_at` string, date-time: ISO 8601 timestamp of the most recent refresh of this data.
    - `updated_at` string, date-time: ISO 8601 timestamp of the last update to this object.
    - `count` integer: Number of objects returned.
    - `next_cursor` string: Pointer to the next page of results.
  - `data` EarningsStreamPayoutObjResponseV20230418[], required
    - `status` 'estimated' | 'processed', required: Status of the payout, either `estimated` or `processed`. `estimated` represents income that has been earned but not finalized in the payroll system. `processed` represents income that has a finalized paystub issued in the payroll system.
    - `pay_date` string, date, required: Date that the payout will arrive in a user's account. This date includes a buffer for ACH settlement time. For estimated payouts, this is projected from historical pay dates and may differ by a few days from actual settlement. For processed payouts, this is taken directly from the paystub.
    - `net_pay` NetPayObjResponse
      - `amount` integer, required: Amount of net pay, denominated in the smallest unit for the currency, e.g. for USD, 10000 represents $100 since the smallest unit is cents. See ISO 4217.
      - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMW', required: Three-letter ISO 4217 currency code, uppercase. For example, the code for US dollars is USD.
    - `earnings` unknown[], required: List of objects representing income earned on a given day. All earnings roll up into specific payouts.
      - unknown

---

[API](https://skmtc.dev/getpinwheel/apis/pinwheel.md) - [All operations](https://skmtc.dev/getpinwheel/apis/pinwheel/llms.txt) - [OpenAPI document](https://skmtc.dev/getpinwheel/apis/pinwheel/revisions/4543563d0f72?raw)