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

# List Payees V1

`GET /v1/payees`

> **Deprecated.**

Get a paginated response listing the payees for a payor.

Please use V3 instead.

## Query parameters

- `payorId` string, uuid, required
- `ofacStatus` 'PENDING' | 'PASSED' | 'FAILED'
- `onboardedStatus` 'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'
- `Email` string, email
- `displayName` string
- `remoteId` string
- `payeeType` 'Individual' | 'Company'
- `payeeCountry` string
- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

Details of Payee

- PagedPayeeResponse — List Payees Response Object
  - `summary` PagedPayeeResponseSummary
    - `totalPayeesCount` integer
    - `totalInvitedCount` integer
    - `totalRegisteredCount` integer
    - `totalOnboardedCount` integer
    - `totalOfacFailedCount` integer
  - `page` PagedPayeeResponsePage
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedPayeeResponseLinks[]
    - `rel` string
    - `href` string
  - `content` PayeeResponse[]
    - `payeeId` string, uuid
    - `payorRefs` PayeePayorRef[], nullable
      - `payorId` string, uuid
      - `remoteId` string
      - `invitationStatus` string
    - `email` string, email, nullable
    - `address` PayeeAddress
      - `line1` string, required
      - `line2` string, nullable
      - `line3` string, nullable
      - `line4` string, nullable
      - `city` string, required
      - `countyOrProvince` string, nullable
      - `zipOrPostcode` string, nullable
      - `country` string, required
    - `country` string
    - `displayName` string
    - `paymentChannel` PayeePaymentChannel
      - `paymentChannelName` string
      - `iban` string — Must match the regular expression ```^[A-Za-z0-9]+$```.
      - `accountNumber` string, required
      - `routingNumber` string, required
      - `countryCode` string, required — Country Code must be a valid 2 letter ISO 3166-1 country code.
      - `currency` 'USD' | 'GBP' | 'EUR', required
      - `accountName` string, required
    - `challenge` Challenge
      - `value` string, required
      - `description` string, required
    - `language` 'AR' | 'EN' | 'ES' | 'FR' | 'HE' | 'HI' | 'JA' | 'PT' | 'RU' | 'UR' | 'ZH' — Available Payee Language codes
    - `acceptTermsAndConditionsTimestamp` string, date-time, nullable — The timestamp when the payee last accepted T&Cs
    - `cellphoneNumber` string
    - `payeeType` 'Individual' | 'Company'
    - `company` CompanyResponse, nullable
      - `name` string, required
      - `operatingName` string, nullable
    - `individual` IndividualResponse
      - `name` IndividualV1Name, required
        - `title` string
        - `firstName` string, required
        - `otherNames` string
        - `lastName` string, required
    - `created` string, date-time
    - `gracePeriodEndDate` string, date, nullable
    - `lastOfacCheckTimestamp` string, date_time, nullable
    - `marketingOptIns` MarketingOptIn[]
      - `optedIn` boolean
      - `timestamp` string, date-time
    - `ofacStatus` 'PENDING' | 'PASSED' | 'FAILED'
    - `onboardedStatus` 'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'

## Other responses

- `400` — Bad Request
- `404` — Not Found

## Changes

- **2020-01-28** `1b2abf26b5d6` — 2 breaking, 4 info
  - the `content/items/paymentChannel/countryCode` response property's minLength was decreased from `9` to `2` for the response status `200`
  - removed the required property `content/items/paymentChannel/routingNo` from the response with the `200` status
  - api operation id `listPayees` removed and replaced with `listPayeesV1`
  - endpoint deprecated
  - …2 more
- **2019-12-11** `a0b19fa311c0` — 1 info
  - endpoint reactivated
- **2019-12-03** `7da78786beb4` — 1 info
  - endpoint deprecated
- **2019-10-17** `f27462c28e5f` — 1 breaking, 2 warning
  - removed the required property `content/items/individual/dateOfBirth` from the response with the `200` status
  - removed the optional property `content/items/company/taxId` from the response with the `200` status
  - removed the optional property `content/items/individual/nationalIdentification` from the response with the `200` status
- …earlier changes not shown

[Full history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v1/payees/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/1b2abf26b5d6?raw)