Sign in
Payors

Get Payor

Get a Single Payor by Id.

get/v1/payors/{payorId}

Path parameters

payorIdstring uuid required

The account owner Payor ID

Response

Get Payor Details

payorIdstring uuid
payorNamestring required

The name of the payor.

primaryContactNamestring

Name of primary contact for the payor.

primaryContactPhonestring

Primary contact phone number for the payor.

primaryContactEmailstring email

Primary contact email for the payor.

fundingAccountRoutingNumberstring

The funding account routing number to be used for the payor.

fundingAccountAccountNumberstring

The funding account number to be used for the payor.

fundingAccountAccountNamestring

The funding account name to be used for the payor.

kycState'FAILED_KYC' | 'PASSED_KYC' | 'REQUIRES_KYC'

The kyc state of the payor.

manualLockoutboolean

Whether or not the payor has been manually locked by the backoffice.

payeeGracePeriodProcessingEnabledboolean

Whether grace period processing is enabled.

payeeGracePeriodDaysinteger

The grace period for paying payees in days.

collectiveAliasstring

How the payor has chosen to refer to payees.

supportContactstring

The payor’s support contact email address.

dbaNamestring

The payor’s 'Doing Business As' name.

allowsLanguageChoiceboolean

Whether or not the payor allows language choice in the UI.

reminderEmailsOptOutboolean

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].

includesReportsboolean
maxMasterPayorAdminsinteger

Example response

{
  "primaryContactName": "Joe Buck",
  "payeeGracePeriodProcessingEnabled": true,
  "supportContact": "support@example.com",
  "address": {
    "country": "US",
    "countyOrProvince": "FL",
    "line4": "line4",
    "city": "Key West",
    "line3": "line3",
    "line2": "line2",
    "line1": "500 Duval St",
    "zipOrPostcode": "33945"
  },
  "fundingAccountAccountName": "Example Corp BOA",
  "includesReports": true,
  "allowsLanguageChoice": true,
  "language": "EN",
  "fundingAccountAccountNumber": "1234567890123",
  "dbaName": "Some Biz",
  "primaryContactPhone": "123-123-1234",
  "payeeGracePeriodDays": 0,
  "fundingAccountRoutingNumber": "123456789",
  "reminderEmailsOptOut": true,
  "maxMasterPayorAdmins": 6,
  "manualLockout": true,
  "collectiveAlias": "Payee",
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "kycState": "PASSED_KYC",
  "primaryContactEmail": "joe.buck@example.com",
  "payorName": "Example, Corp"
}

Changes