---
title: "Get Payee by Id"
method: GET
path: "/v3/payees/{payeeId}"
tags: ["Payees"]
deprecated: true
---

# Get Payee by Id

`GET /v3/payees/{payeeId}`

> **Deprecated.**

Use v4 instead

Get Payee by Id

## Path parameters

- `payeeId` string, uuid, required

## Query parameters

- `sensitive` boolean

## Response `200`

Success response, request completed okay

- PayeeDetailResponseV3
  - `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
  - `watchlistOverrideExpiresAtTimestamp` string, date-time, nullable
  - `watchlistOverrideComment` string
  - `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
  - `address` PayeeAddressV3
    - `line1` string, required
    - `line2` string, nullable
    - `line3` string, nullable
    - `line4` string, nullable
    - `city` string, required
    - `countyOrProvince` string, nullable
    - `zipOrPostcode` string, nullable
    - `country` string, required — 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.
  - `individual` IndividualV3
    - `name` IndividualV3Name, required
      - `title` string
      - `firstName` string, required
      - `otherNames` string
      - `lastName` string, required
    - `nationalIdentification` string — If not authorized to view, value will be masked. Example: XXXXX1234
    - `dateOfBirth` string, required — If not authorized to view, value will be masked. Example: - XXXX-XX-XX
  - `company` CompanyV3, nullable
    - `name` string, required
    - `taxId` string, nullable — Company Tax Id must be between 6 and 30 characters long
    - `operatingName` string, nullable
  - `cellphoneNumber` string
  - `watchlistStatusUpdatedTimestamp` string, date_time, nullable
  - `gracePeriodEndDate` string, date, nullable
  - `enhancedKycCompleted` boolean
  - `kycCompletedTimestamp` string, date_time, nullable
  - `pausePayment` boolean
  - `pausePaymentTimestamp` string, date_time, nullable
  - `marketingOptInDecision` boolean
  - `marketingOptInTimestamp` string, date_time, nullable
  - `acceptTermsAndConditionsTimestamp` string, date-time, nullable — The timestamp when the payee last accepted T&Cs
  - `challenge` ChallengeV3
    - `value` string, required
    - `description` string, required

## Other responses

- `404` — Payee Not found

## Changes

- **2022-06-27** `1e7a1734a45c` — 14 info
  - removed the `ACCEPTED` enum value from the `payorRefs/items/invitationStatus` response property for the response status `200`
  - removed the `CREATED` enum value from the `onboardedStatus` response property for the response status `200`
  - removed the `Company` enum value from the `payeeType` response property for the response status `200`
  - removed the `DECLINED` enum value from the `payorRefs/items/invitationStatus` response property for the response status `200`
  - …10 more
- **2022-04-07** `da77064fe233` — 2 info
  - the `address/country` response's property pattern `^[A-Z]{2}$` was added for the status `200`
  - the `country` response's property pattern `^[A-Z]{2}$` was added for the status `200`
- **2020-09-25** `dd71433847a6` — 13 info
  - added the optional property `payorRefs/items/payableIssues` to the response with the `200` status
  - added the optional property `payorRefs/items/payableStatus` to the response with the `200` status
  - removed the `AR` enum value from the `language` response property for the response status `200`
  - removed the `EN` enum value from the `language` response property for the response status `200`
  - …9 more
- **2020-08-13** `75bb7af5ae63` — 1 info
  - endpoint deprecated
- **2020-06-24** `aded220b0d7b` — 1 info
  - added the optional property `challenge` to the response with the `200` status

[Full history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/payees/:payeeId/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/25a3d8f6e24a?raw)