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

# Get Payor

`GET /v1/payors/{payorId}`

> **Deprecated.**

Get a Single Payor by Id.

deprecated since v2.10 - Use /v2/payors

## Path parameters

- `payorId` string, uuid, required

## Response `200`

Get Payor Details

- PayorV1
  - `payorId` string, uuid
  - `payorName` string, required — The name of the payor.
  - `address` PayorAddress
    - `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.
  - `fundingAccountRoutingNumber` string — The funding account routing number to be used for the payor.
  - `fundingAccountAccountNumber` string — The funding account number to be used for the payor.
  - `fundingAccountAccountName` string — The funding account name to be used 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.
  - `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
  - `maxMasterPayorAdmins` integer
  - `transmissionTypes` TransmissionTypes
    - `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

## Other responses

- `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-12-12** `3cf504795910` — 1 info
  - api operation id `getPayorById` removed and replaced with `getPayorByIdV1`
- **2022-06-27** `1e7a1734a45c` — 5 info
  - 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`
  - removed the `PASSED_KYC` enum value from the `kycState` response property for the response status `200`
  - …1 more
- **2020-09-25** `dd71433847a6` — 1 breaking, 12 info
  - 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 `403` status
  - added the optional property `errors/items/errorCode` to the response with the `404` status
  - added the optional property `errors/items/errorData` to the response with the `403` status
  - …9 more
- **2020-06-24** `aded220b0d7b` — 1 info
  - added the optional property `transmissionTypes` to the response with the `200` status
- …earlier changes not shown

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