---
title: "List Payouts"
method: GET
path: "/payouts"
tags: ["Payouts"]
---

# List Payouts

`GET /payouts`

## Request

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

## 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 payouts

- object
  - `id` number: the object id
  - `type` string: the object type, or array of objects
  - `data` Payout[]: the list of objects
    - `id` string: unique payout id
    - `account_id` string, uuid: id of the account associated with the payout
    - `amount` number: 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 payout is delivered
    - `description` string, nullable
    - `deposits_at` string, date-time: in UTC, the estimated date and time of the payout deposit (or in rare cases, withdrawal)
    - `fees_total` number: sum of fees in the payout, in cents
    - `refunds_count` number: number of refunds in the payout
    - `refunds_total` number: sum of refunds in the payout, in cents
    - `payments_count` number: number of payments in the payout
    - `payments_total` number: sum of payments in the payout, in cents
    - `payout_type` 'ach cc': type of payment method used for the payments in the payout (funds from different types of payment methods settle at different intervals; in order to pay out your funds ASAP, we batch separate payouts for each payment method type)
    - `other_total` number: sum of other less common transactions in the payout, in cents
    - `platform_fees_total` number, nullable: gross fees your platform charged its sub accounts in a proceeds payout, in cents, null for sub account payouts
    - `justifi_fees_total` number, nullable: processing fees JustiFi charged your platform in a proceeds payout, in cents, always positive, null for sub account payouts
    - `interchange_network_fees` number, nullable: interchange and card network fees passed through to your platform in a proceeds payout, in cents, usually negative, null for sub account payouts
    - `status` 'paid failed forwarded scheduled in_transit canceled': status of the payout
    - `settlement_priority` 'standard expedited': settlement priority of the payout, either standard or expedited.
    - `metadata` object: any useful information you'd like to store alongside this 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)
