---
title: "List all payouts"
method: GET
path: "/open-api/v3/payments"
tags: ["Payouts"]
---

# List all payouts

`GET /open-api/v3/payments`

Retrieves a list of all payout transactions for the current user, optionally supporting pagination and filtering.

## Query parameters

- `limit` string, number — Limits the number of items to be returned.
- `page` string, number — The page to be returned, counting from 1 as the first page.
- `accountId` string, required — The UUID of the account.
- `id` string — Id
- `currency` 'CNH' | 'USD' | 'HKD' | 'GBP' | 'EUR' | 'AUD' | 'AED' | 'ILS' | 'CAD' | 'SGD' | 'MYR' | 'JPY' | 'IDR' — Currency code.
- `clientTransactionId` string — Client transaction id (Idempotent ID)

## Response `200`

OK

- PayoutPageRespDTO
  - `code` string — Error code
  - `message` string — Error message
  - `data` PayoutPageResponse, required — Data
    - `total` integer, required — total number
    - `list` Payout[], required — Data list
      - `clientTransactionId` string, required — Client transaction id
      - `businessId` string, required — Business ID: Depending on the payment type, this field returns the corresponding business ID. If the payment type is 0, this will return the global account ID. If the payment type is 1, this will return the crypto asset ID.
      - `businessTypeCode` integer, required — The businessType field is used to indicate the type of payment. The value of this field can be one of the following: 0: Represents a global account payment type. 1: Represents a crypto asset payment type.
      - `balanceId` string, required — This is the unique identifier for the wallet involved in the transaction.
      - `payeeId` string, required — This is the unique identifier for the beneficiary (recipient) of the payment.
      - `accountId` string, required — This is accountId.
      - `fromAmount` string, required — Payment amount
      - `fromCurrency` string, required — Payment currency
      - `toAmount` string, required — Amount received
      - `toCurrency` string, required — Currency of arrival
      - `status` string, required — The status of the transaction. Possible values are: PENDING: The transaction is pending. CLOSED: The transaction is completed. FAIL: The transaction has failed.
      - `message` string, required — Additional information or details about the transaction (e.g., error messages or status descriptions).
      - `refund` PayoutRefundNest — Refund info.
        - `amount` string, required — Magnitude of the amount, in units of the currency, with a .
        - `currency` string, required — Currency code for the amount.
      - `createTime` string, required — The timestamp (in milliseconds) when the transaction was created.
      - `fees` PayoutMoneyBO[], required — This field contains details about the fees associated with the transaction. Refer to the Fee Resource for more information.
        - `currency` string, required — Currency code for the amount.
        - `amount` string, required — Magnitude of the amount, in units of the currency, with a .
        - `feeType` 0, required — Specifies the handling fee charged for the transaction. 0: This field represents the handling fee charged by the platform for processing the transaction.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/interlace/apis/core-resource.md) · [All operations](https://skmtc.net/interlace/apis/core-resource/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interlace/core-resource/revisions/29c08a4da357/schema)