---
title: "List Payees"
method: GET
path: "/v3/payees"
tags: ["Payees"]
deprecated: true
---

# List Payees

`GET /v3/payees`

> **Deprecated.**

Use v4 instead

Get a paginated response listing the payees for a payor.

## Query parameters

- `payorId` string, uuid, required
- `watchlistStatus` string — Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED
- `disabled` boolean
- `onboardedStatus` string — Payee onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED
- `email` string, email
- `displayName` string
- `remoteId` string
- `payeeType` string — Type of Payee. One of the following values: Individual, Company
- `payeeCountry` string
- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

Details of Payee

- PagedPayeeResponseV3 — List Payees Response Object
  - `summary` PagedPayeeResponseV3Summary
    - `totalPayeesCount` integer
    - `totalInvitedCount` integer
    - `totalRegisteredCount` integer
    - `totalOnboardedCount` integer
    - `totalWatchlistFailedCount` integer
  - `page` PagedPayeeResponseV3Page
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedPayeeResponseV3Links[]
    - `rel` string
    - `href` string
  - `content` GetPayeeListResponseV3[]
    - `payeeId` string, uuid
    - `payorRefs` PayeePayorRefV3[], nullable
      - `payorId` string, uuid
      - `remoteId` string
      - `invitationStatus` string
      - `invitationStatusTimestamp` string, date-time, nullable — The timestamp when the invitation status is updated
      - `paymentChannelId` string, uuid
      - `payableStatus` boolean — Indicates if the payee is payable for this payor
      - `payableIssues` PayableIssueV3[] — Indicates any conditions which prevent the payee from being payable for this payor
        - `code` string, required
        - `message` string, required
    - `email` string, email, nullable
    - `onboardedStatus` string — Onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED
    - `watchlistStatus` string — Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED
    - `watchlistStatusUpdatedTimestamp` string, date_time, nullable
    - `watchlistOverrideComment` string, nullable
    - `language` string — An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.
    - `created` string, date-time
    - `country` string — Valid ISO 3166 2 character country code. See the <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" a>ISO specification</a> for details.
    - `displayName` string
    - `payeeType` string — Type of Payee. One of the following values: Individual, Company
    - `disabled` boolean
    - `disabledComment` string
    - `disabledUpdatedTimestamp` string, date-time
    - `individual` GetPayeeListResponseIndividualV3
      - `name` NameV3
        - `title` string
        - `firstName` string
        - `otherNames` string
        - `lastName` string
    - `company` GetPayeeListResponseCompanyV3
      - `name` string
      - `operatingName` string, nullable

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `401` — Invalid access token. May be expired or invalid
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404` — The resource was not found or is no longer available

---

[API](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/05c3f09fc50a/schema)