---
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 — The Payor Id
  - `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
    - `line3` string
    - `line4` string
    - `city` string, required
    - `countyOrProvince` string
    - `zipOrPostcode` string
    - `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 before the payee must be onboarded.
  - `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 — For internal use only (will be removed in a later version)
  - `wuCustomerId` string — For internal use only (will be removed in a later version)
  - `maxMasterPayorAdmins` integer — The maximum number of payor users with the master admin role
  - `paymentRails` string — For internal use only (will be removed in a later version)
  - `remoteSystemIds` string[] — For internal use only (will be removed in a later version)
  - `usdTxnValueReportingThreshold` integer — USD in minor units. For internal use only (will be removed in a later version)
  - `managingPayees` boolean — Does this payor manage their own payees (payees are not invited but managed by the payor)
  - `createdAt` string, date-time — The date of creation of the payor

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

---

[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)