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

# List all purposes

`GET /open-api/v3/purposes`

Retrieves a list of purposes.

## Query parameters

- `accountId` string, required — The UUID of the account.
- `payeeId` string, required — Beneficiary ID
- `balanceId` string, required — A source of funds.

## Response `200`

OK

- PaymentPurposesResVO
  - `code` string — Error code
  - `message` string — Error message
  - `data` PaymentPurpose[], required — purpose list
    - `id` string, required — id
    - `purposeDescriptionZh` string — Purpose description in Chinese
    - `purposeDescriptionEn` string, required — Purpose description in English

## 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)