---
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.
  - `payorXid` string — A unique identifier that an external system uses to reference the payor in their system
  - `provider` string — The source of the payorXid, default is null which means Velo
  - `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` string — The kyc state of the payor. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC
  - `manualLockout` boolean — Whether or not the payor has been manually locked by the backoffice.
  - `openBankingEnabled` boolean — Is Open Banking supported for this payor
  - `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` string — The payor’s language preference. Must be one of [EN, FR]
  - `includesReports` boolean
  - `wuCustomerId` string
  - `maxMasterPayorAdmins` integer
  - `paymentRails` string — The id of the payment rails
  - `transmissionTypes` TransmissionTypes2
    - `ACH` boolean, required — Whether the Payor is allowed to pay via ACH
    - `SAME_DAY_ACH` boolean, required — Whether the Payor is allowed to pay via same day ACH
    - `WIRE` boolean, required — Whether the Payor is allowed to pay via wire
  - `remoteSystemIds` string[] — The payor’s supported remote systems by id
  - `usdTxnValueReportingThreshold` integer — USD in minor units
  - `managingPayees` boolean

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

- **2022-06-27** `1e7a1734a45c` — 7 info
  - removed the `BOFA` enum value from the `paymentRails` response property for the response status `200`
  - removed the `EN` enum value from the `language` response property for the response status `200`
  - removed the `FAILED_KYC` enum value from the `kycState` response property for the response status `200`
  - removed the `FR` enum value from the `language` response property for the response status `200`
  - …3 more
- **2022-04-07** `da77064fe233` — 2 info
  - added the optional property `managingPayees` to the response with the `200` status
  - added the optional property `usdTxnValueReportingThreshold` to the response with the `200` status
- **2021-11-03** `12abf05c40fa` — 2 info
  - added the optional property `openBankingEnabled` to the response with the `200` status
  - added the optional property `provider` to the response with the `200` status
- **2021-01-14** `5e4369698639` — 1 info
  - added the optional property `remoteSystemIds` to the response with the `200` status
- **2020-09-25** `dd71433847a6` — 2 breaking, 18 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - added the optional property `errors/items/errorCode` to the response with the `400` status
  - added the optional property `errors/items/errorCode` to the response with the `403` status
  - …16 more

[Full 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/25a3d8f6e24a?raw)