---
title: "List all payouts"
method: GET
path: "/payment/{connection_id}/payout"
tags: ["payment", "payout"]
---

# List all payouts

`GET /payment/{connection_id}/payout`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/payment/{connection_id}/payout`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `limit` number
- `offset` number
- `updated_gte` string, date-time
- `sort` 'name' | 'updated_at' | 'created_at'
- `order` 'asc' | 'desc'
- `query` string
- `fields` string[]
- `raw` string

## Response `200`

Successful

- PaymentPayout[]
  - `id` string
  - `created_at` string: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `total_amount` number
  - `currency` string
  - `notes` string
  - `status` 'SUCCEEDED' | 'PENDING' | 'FAILED' | 'CANCELED'
  - `arrival_at` string, date-time: Date the funds land in the destination account (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `fee_amount` number: Processor fee deducted from the payout
  - `net_amount` number: total_amount minus fee_amount
  - `account_id` string: ref -> AccountingAccount; the destination account (reference to AccountingAccount)
  - `lineitems` PaymentPayoutLineitem[]: The transactions included in this payout
    - `object_type` 'PAYMENT' | 'REFUND' | 'FEE' | 'ADJUSTMENT' | 'TRANSFER' | 'OTHER': What this payout line settles
    - `object_id` string: id of the settled object -- a PaymentPayment or PaymentRefund for PAYMENT / REFUND lines
    - `amount` number: Gross amount of this line
    - `currency` string: ISO 4217 currency code of the line amount
    - `fee_amount` number: Processor fee attributed to this line
    - `net_amount` number: amount minus fee_amount
  - `metadata` PaymentMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)