---
title: "Get Payor"
method: GET
path: "/v2/payors/{payorId}"
tags: ["Payors"]
---

# Get Payor

`GET /v2/payors/{payorId}`

Get a Single Payor by Id.

## Path parameters

- `payorId` string, uuid, required

## Response `200`

Get Payor Details

- PayorV2
  - `payorId` string, uuid, required
  - `payorName` string, required — The name of the payor.
  - `address` PayorAddressV2
    - `line1` string, required
    - `line2` string, nullable
    - `line3` string, nullable
    - `line4` string, nullable
    - `city` string, required
    - `countyOrProvince` string, nullable
    - `zipOrPostcode` string, nullable
    - `country` string, required
  - `primaryContactName` string — Name of primary contact for the payor.
  - `primaryContactPhone` string — Primary contact phone number for the payor.
  - `primaryContactEmail` string, email — Primary contact email for the payor.
  - `kycState` 'FAILED_KYC' | 'PASSED_KYC' | 'REQUIRES_KYC' — The kyc state of the payor.
  - `manualLockout` boolean — Whether or not the payor has been manually locked by the backoffice.
  - `payeeGracePeriodProcessingEnabled` boolean — Whether grace period processing is enabled.
  - `payeeGracePeriodDays` integer — The grace period for paying payees in days.
  - `collectiveAlias` string — How the payor has chosen to refer to payees.
  - `supportContact` string — The payor’s support contact email address.
  - `dbaName` string — The payor’s 'Doing Business As' name.
  - `allowsLanguageChoice` boolean — Whether or not the payor allows language choice in the UI.
  - `reminderEmailsOptOut` boolean — Whether or not the payor has opted-out of reminder emails being sent.
  - `language` 'EN' | 'FR' — The payor’s language preference. Must be one of [EN, FR].
  - `includesReports` boolean
  - `wuCustomerId` string
  - `maxMasterPayorAdmins` integer
  - `paymentRails` 'WU' | 'BOFA'

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `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` — Payor Id Not Found

## Changes

- **2020-01-28** `1b2abf26b5d6` — 4 breaking, 3 warning
  - the response's body type changed from `object` to no type for status `400`
  - the response's body type changed from `object` to no type for status `403`
  - the `errors/items/` response's property type changed from `object` to no type for status `400`
  - the `errors/items/` response's property type changed from `object` to no type for status `403`
  - …3 more
- **2019-12-11** `a0b19fa311c0` — 6 info
  - added the media type `application/json` for the response with the status `404`
  - added the non-success response with the status `400`
  - added the non-success response with the status `403`
  - added the optional property `paymentRails` to the response with the `200` status
  - …2 more
- **2019-10-17** `f27462c28e5f` — 1 info
  - added the optional property `maxMasterPayorAdmins` to the response with the `200` status
- **2019-07-15** `ced8e167a97c` — 7 breaking, 15 warning, 8 info
  - removed the media type `application/json` for the response with the status `404`
  - the response property `address/countyOrProvince` became nullable for the status `200`
  - the response property `address/line2` became nullable for the status `200`
  - the response property `address/line3` became nullable for the status `200`
  - …26 more

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v2/payors/:payorId/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)