---
title: "Get the list of payouts"
method: GET
path: "/api/payout"
tags: ["Payouts"]
---

# Get the list of payouts

`GET /api/payout`

Retrieves a paginated list of payouts for the authenticated merchant. When `X-On-Behalf-Of` is set, returns the payouts of the targeted sub-merchant instead. Supports filtering by status.

## Query parameters

- `status` Object
- `page` number
- `limit` number

## Response `200`

- object
  - `data` DashboardWithdrawalDto[]
    - `id` string, nullable, required
    - `object` string, nullable, required
    - `amountInCents` number, nullable, required
    - `currency` string, nullable, required
    - `status` string, nullable, required
    - `createdAt` string, date-time, nullable, required
    - `updatedAt` string, date-time, nullable, required
    - `payment` WithdrawalPaymentDto, required
      - `sourceAmount` number, nullable, required
      - `sourceCurrency` string, nullable, required
      - `sourceSubtotalAmount` number, required
      - `finalAmount` number, nullable, required
      - `finalCurrency` string, nullable, required
      - `exchangeRate` number, nullable, required
      - `rail` string, nullable, required
      - `txHash` string, nullable
    - `requiresManualConfirmation` boolean, nullable
    - `account` WithdrawalAccountDto
      - `id` string, nullable, required
      - `object` string, nullable, required
      - `iban` string, nullable
      - `bic` string, nullable
      - `accountNumber` string, nullable
      - `accountOwnerName` string, nullable
      - `country` string, nullable
      - `network` string, nullable
      - `label` string, nullable
      - `address` string, nullable
      - `isArchived` boolean, nullable
      - `createdAt` string, date-time, nullable
      - `updatedAt` string, date-time, nullable
    - `timeline` Timeline[], nullable
      - `status` string, required — The status of the timeline
      - `date` string, date-time, required — The date of the timeline
      - `amountInCents` number — Refund amount in HT cents for refund-related timeline entries (PARTIAL_REFUNDED, FULLY_REFUNDED, REFUND_PENDING, REFUND_FAILED). Omitted for non-refund lifecycle events.
    - `yield` object
      - `rewards` string, required
    - `quadernoInvoiceId` string, nullable
    - `hasApprovedByCurrentMember` boolean, nullable
    - `approvalsCollected` number, nullable
    - `requiredApprovals` number, nullable
  - `meta` object
    - `total` number
    - `lastPage` number
    - `currentPage` number
    - `perPage` number
    - `prev` number
    - `next` number

## Other responses

- `401` — Unauthorized - Invalid API key

---

[API](https://skmtc.dev/inflowpay/apis/inflow-api.md) · [All operations](https://skmtc.dev/inflowpay/apis/inflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inflowpay/inflow-api/revisions/3012dd3dd14a/schema)
