---
title: "List Proceeds"
method: GET
path: "/proceeds"
tags: ["Proceeds"]
---

# List Proceeds

`GET /proceeds`

## Request

- Base URL: `https://api.justifi.ai/v1`
- URL: `https://api.justifi.ai/v1/proceeds`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/justifi/apis/justifi-api-documentation/docs/proceeds/get.ts> (a function with typed inputs; its response is checked against the schema)

List the proceeds payouts for your account. This endpoint supports [pagination](https://docs.justifi.tech/api-spec#section/Pagination).

## Query parameters

- `created_before` string, date-time
- `created_after` string, date-time
- `deposits_before` string, date-time
- `deposits_after` string, date-time

## Headers

- `Authorization` string, required

## Response `200`

Successfully list proceeds

- object
  - `id` number: the object id
  - `type` string: the object type, or array of objects
  - `data` Proceed[]: the list of objects
    - `id` string: unique proceeds payout id
    - `account_id` string, uuid: id of the account associated with the proceeds payout
    - `amount` number: proceeds payout amount in cents
    - `bank_account` PayoutBankAccount
      - `id` string, uuid: unique bank account id
      - `full_name` string: account holder's full name
      - `bank_name` string: name of bank
      - `account_number_last4` string: last 4 digits of the account number
      - `routing_number` string
      - `country` 'US' | 'CA'
      - `currency` 'usd' | 'cad'
      - `nickname` string
      - `account_type` 'checking'
    - `currency` 'usd' | 'cad'
    - `delivery_method` 'standard': how the proceeds payout is delivered
    - `description` string, nullable
    - `deposits_at` string, date-time: in UTC, the date and time of the proceeds payout deposit (or in rare cases, withdrawal)
    - `refunds_count` number: number of refunds that impacted the proceeds payout
    - `refunds_total` number: sum deducted from the proceeds payout as a result of accounts' refunds, in cents
    - `payments_count` number: number of payments that impacted the proceeds payout
    - `payments_total` number: sum added to the proceeds payout as a result of accounts' payments, in cents
    - `payout_type` 'proceeds': proceeds payouts are always of the type "proceeds" (other types apply only to sub accounts payouts)
    - `other_total` number: sum of other less common transactions that impacted the proceeds payout, in cents
    - `platform_fees_total` number, nullable: gross fees your platform charged its sub accounts in the proceeds payout, in cents, before JustiFi's processing fees, null until calculated shortly after the payout is created
    - `justifi_fees_total` number, nullable: processing fees JustiFi charged your platform in the proceeds payout, in cents, always positive, null until calculated shortly after the payout is created
    - `interchange_network_fees` number, nullable: interchange and card network fees passed through to your platform in the proceeds payout, in cents, negative when charged and positive when refunds credit interchange back, null until calculated shortly after the payout is created
    - `status` 'scheduled paid failed pending in_transit canceled': status of the proceeds payout
    - `metadata` object: any useful information you'd like to store alongside this proceeds payout
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `page_info` PageInfo
    - `end_cursor` string: the encoded id of the last record in the current list
    - `has_next` boolean: true if the collection contains records following the current list
    - `has_previous` boolean: true if the collection contains records ahead of the current list
    - `start_cursor` string: the encoded id of the first record in the current list

---

[API](https://skmtc.dev/justifi/apis/justifi-api-documentation.md) - [All operations](https://skmtc.dev/justifi/apis/justifi-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/justifi/apis/justifi-api-documentation/revisions/dd9f3fed7e46?raw)