---
title: "List all payee bank accounts"
method: GET
path: "/open-api/v3/payees"
tags: ["Payouts"]
---

# List all payee bank accounts

`GET /open-api/v3/payees`

Retrieves a paginated list of all payee bank accounts under the current user.

## Query parameters

- `accountId` string, required — The UUID of the account.
- `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.
- `currency` 'CNH' | 'USD' | 'HKD' | 'GBP' | 'EUR' | 'AUD' | 'AED' | 'ILS' | 'CAD' | 'SGD' | 'MYR' | 'JPY' | 'IDR' — Currency code.
- `userName` string — Recipient's username, automatically generated by concatenating first name and last name. Example: JohnSmith

## Response `200`

OK

- PayeePageRespDTO
  - `code` string — Error code
  - `message` string — Error message
  - `data` PayeePageResponse, required — data
    - `total` integer, required — total number
    - `list` PayoutPayee[], required — data list
      - `id` string, required — Unique ID generated for the entity.
      - `firstName` string — Recipient's first name. When paymentType is COMPANY, return empty
      - `lastName` string, required — Recipient's last name.
      - `userName` string, required — Recipient's username, automatically generated by concatenating first name and last name. Example: JohnSmith
      - `accountId` string, required — The UUID of the account.
      - `paymentType` 'COMPANY' | 'INDIVIDUAL' — Payment to company or individual bank account.
      - `currency` string, required — Currency code.
      - `accountNumber` string, required — Account number
      - `bankName` string — Bank name
      - `routingCodeList` RoutingCodeDTO[], required — Routing code
        - `routingCodeType` 'ROUTING_NUMBER' | 'ACH_CODE' | 'BSB_CODE' | 'SORT_CODE' | 'IBAN' | 'BANK_CODE' | 'BRANCH_CODE' | 'PHONE_NUMBER' | 'SWIFT_CODE', required — Routing code
        - `routingCodeValue` string, required — Routing code value
      - `bankAddress` PaymentPayeeAddressDTO, required — Bank address
        - `country` string, required — Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
        - `city` string — City. English letters only.
        - `state` string — State / County / Province / Region. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision. English letters only.
        - `postalCode` string — Postal / ZIP code of the address.
        - `addressLine1` string — Line one of the street address.
        - `addressLine2` string — Line two of the street address.
      - `payeeAddress` Address — Mailing or billing address
        - `addressLine1` string, required — Primary address line (Street address / PO Box / Company name). English letters only, numbers and common symbols allowed.
        - `addressLine2` string — Secondary address line (Apartment / Suite / Unit / Building). English letters only, numbers and common symbols allowed.
        - `city` string, required — City. English letters and spaces only.
        - `state` string, required — **State / County / Province / Region**: Required for all countries. - For the US and Canada: must provide the subdivision using the two-letter code (e.g., WA for Washington State). - For other countries without a state/province, repeat the country name. - Allowed characters: English letters, numbers, and common symbols.
        - `country` string, required — Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
        - `postalCode` string, required — Postal / ZIP code of the address.
      - `comments` string — Remark
      - `status` string — Possible status values: PENDING: Processing REQUEST: Requires additional information REVIEWING: Under review PASSED: Approved CANCELED: Canceled BLACK_LISTED: Blocked NA: Not applicable ACTIVE: Active DELETED: Deleted INACTIVE: Disabled TO_BE_MODIFIED: Requires modification

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