---
title: "List payouts"
method: POST
path: "/api/service/payout/list"
tags: ["Payout"]
---

# List payouts

`POST /api/service/payout/list`

List payouts for a merchant.

## Request body

- ListPayoutInputDto
  - `limit` number
  - `skip` number
  - `type` 'customer-payout' | 'beneficiary-payout'

## Response `200`

List payouts

- ListPayoutResponseDto
  - `items` object[], required
    - `id` string, required — The payout ID
    - `type` 'beneficiary' | 'customer', required — The payout type
    - `destination` object, required — The payout destination
      - `type` 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba', required
      - `iban` object
        - `accountHolderName` string, required
        - `iban` string, required
        - `bic` string
      - `aba` object
        - `accountHolderName` string, required
        - `routingNumber` string, required
        - `accountNumber` string, required
      - `sortCode` object
        - `accountHolderName` string, required
        - `sortCode` string, required
        - `accountNumber` string, required
      - `bankCode` object
        - `accountHolderName` string, required
        - `code` string, required
        - `accountNumber` string, required
      - `bban` object
        - `accountHolderName` string, required
        - `bban` string, required
        - `bic` string
      - `wallet` object
        - `address` string, required — The blockchain wallet address
        - `blockchain` 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY', required — The blockchain network
    - `status` 'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled', required — The payout status
    - `amount` number, required — The payout amount
    - `currency` 'EUR' | 'GBP' | 'USDC' | 'USD', required — The payout currency
    - `metadata` object — The payout metadata
    - `createdAt` unknown, required
    - `updatedAt` unknown, required
    - `paymentReference` string — The payout payment reference
    - `transactionId` string — The payout transaction ID
    - `failure` object — Failure details. Only available if the payout failed.
      - `code` 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown', required — Failure code. Please refer to the documentation for the list of possible values.
      - `message` string, required — Human readable description of the failure.
      - `retry` boolean, required — If true, you can safely retry.
  - `skip` number, required
  - `count` number, required
  - `hasNext` boolean, required

---

[API](https://skmtc.net/augustus/apis/ivy-api.md) · [All operations](https://skmtc.net/augustus/apis/ivy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/augustus/ivy-api/revisions/c3055fc06ca3/schema)