---
title: "List All Payouts"
method: POST
path: "/list"
---

# List All Payouts

`POST /list`

## Request

- Base URL: `https://api.tap.company/v2/payouts`
- URL: `https://api.tap.company/v2/payouts/list`
- Auth: API key in header `Authorization`

This endpoint returns a list of all previous payouts, with the most recent payouts appearing first.

## Request body

- object
  - `period` object: Required date range for the payouts list
    - `date` object: Required date range for the payout list
      - `from` string: From date, Measured in Unix Epoch Timestamp (milliseconds)
      - `to` string: To date (charge created date), Measured in Unix Epoch Timestamp (milliseconds)
  - `merchants` string[]: List of merchant IDs for which the payouts are being queried
  - `payouts` object: Filter criteria for the payouts
    - `payout_id` string[]: The specific payout ID you want to retrieve
  - `order_by` string: Applying the sorting based on
  - `limit` integer: The maximum number of payouts to return in a single call. Default: 25; Maximum: 50.

## Response `200`

200

- object
  - `object` string
  - `live_mode` boolean
  - `api_version` string
  - `count` integer
  - `has_more` boolean
  - `payouts` object[]
    - `id` string
    - `status` string
    - `date` integer
    - `amount` integer
    - `currency` string
    - `merchant_id` string
    - `wallet` object
      - `id` string
      - `legacy_id` string
      - `country` string
      - `bank` object
        - `id` string
        - `country` string
        - `name` string
        - `swift` string
        - `beneficiary` object
          - `name` string
          - `iban` string
    - `settlements_available` boolean
    - `bank_reference` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/tap/apis/payout.md) - [All operations](https://skmtc.dev/tap/apis/payout/llms.txt) - [OpenAPI document](https://skmtc.dev/tap/apis/payout/revisions/0bdf23a0003a?raw)