---
title: "Payouts"
method: GET
path: "/v1/payouts"
tags: ["Payouts"]
---

# Payouts

`GET /v1/payouts`

Retrieve a list of Payouts with optional filtering and pagination.

## Query parameters

- `after` string
- `limit` string, integer
- `payoutId` string, uuid
- `beneficiaryId` string, uuid
- `beneficiaryCurrency` string
- `sourceCurrency` string
- `status` 'PENDING_AUTHORIZATION' | 'PROCESSING' | 'COMPLETED' | 'FAILED'
- `requestedAt` string, date-time

## Response `200`

Successful response

- object
  - `after` string, nullable — The token of the last item in the response
  - `totalCount` string, integer — The total number of items in the entire filtered data set
  - `items` PayoutsAuthorize[]
    - `payoutId` string, uuid, required
    - `beneficiaryAddressId` string, uuid, required
    - `beneficiaryId` string, uuid
    - `sourceAccountId` string, uuid, required
    - `sourceQuantity` string, number, required
    - `beneficiaryQuantity` string, number, required
    - `payoutFeeQuantity` string, number, required
    - `netBeneficiaryQuantity` string, number, required
    - `sourceCurrency` string, required
    - `feeCurrency` string, required
    - `beneficiaryCurrency` string, required
    - `memo` string, nullable, required
    - `feePaidBy` 'MERCHANT', required
    - `status` 'PENDING_AUTHORIZATION' | 'PROCESSING' | 'COMPLETED' | 'FAILED', required
    - `payoutFeeRate` string, number, required
    - `clientReference` string, nullable — An optional freeform text field that clients can use to add additional notes or references to their order for internal tracking purposes.
    - `conversionRate` string, number, required
    - `paymentReason` string, required
    - `requestedAt` string, date-time, required
    - `expiresAt` string, date-time, required
    - `authorizedAt` string, date-time

## Other responses

- `400` — Validation Error
- `401` — Unauthorized
- `403` — Insufficient Privileges
- `4XX` — Client error
- `5XX` — Server error

---

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