---
title: "List payout batches for a merchant"
method: GET
path: "/api/v1/admin/merchants/{merchantId}/payouts"
tags: ["Payout", "Admin"]
---

# List payout batches for a merchant

`GET /api/v1/admin/merchants/{merchantId}/payouts`

List payout batches for a merchant

## Path parameters

- `merchantId` string, uuid, required — The unique identifier of the merchant

## Query parameters

- `status` union — Status of the payout batch
  - 'pending'
  - 'processing'
  - 'completed'
  - 'failed'

## Response `200`

Success

- PayoutBatchListResponse — Response containing a list of payout batches
  - `success` boolean, required — Indicates if the request was successful
  - `data` object[], required
    - `id` string, uuid, required — Unique identifier for the payout batch
    - `payment_reference` string, required — Short payment reference code for the payout batch
    - `merchant_id` string, uuid, required — Merchant ID for this payout batch
    - `source_account_id` string, uuid — ID of the receiving bank account used as the source for this payout
    - `status` union, required — Status of the payout batch
      - 'pending'
      - 'processing'
      - 'completed'
      - 'failed'
    - `currency` string, required — Currency of the payout
    - `gross_amount` string, required — Total transaction amount before fees, in the payout currency
    - `fees_total` string, required — Total fees deducted, in the payout currency
    - `net_amount` string, required — Net amount after fees (gross_amount - fees_total), in the payout currency
    - `transaction_count` number, required — Number of transactions included in this payout
    - `payout_amount` string — Amount transferred to the settlement account
    - `retained_amount` string — Amount retained for the refund account
    - `retention_rate` string — Retention rate applied (e.g. 0.1000 for 10%)
    - `retention_reference` string — Payment reference for the retention transfer
    - `retention_tm_transaction_id` string — TransferMate transaction ID for the retention transfer
    - `tm_transaction_id` string — TransferMate transaction ID for the payout
    - `error_message` string — Error message if the payout failed
    - `executed_at` string, date-time — When the payout was executed
    - `created_at` string, date-time, required — When the payout batch was created
    - `updated_at` string, date-time, required — When the payout batch was last updated

## Other responses

- `401` — Unauthorized

---

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