v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payors

Get Payor

Get a Single Payor by Id.

get/v2/payors/{payorId}

Path parameters

payorIdstring uuid required

The account owner Payor ID

Response

Get Payor Details

payorIdstring uuid required

The Payor Id

payorNamestring required

The name of the payor

payorXidstring

A unique identifier that an external system uses to reference the payor in their system

providerstring

The source of the payorXid, default is null which means Velo

primaryContactNamestring

Name of primary contact for the payor.

primaryContactPhonestring

Primary contact phone number for the payor.

primaryContactEmailstring email

Primary contact email for the payor.

kycStatestring

The kyc state of the payor. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC

manualLockoutboolean

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

openBankingEnabledboolean

Is Open Banking supported for this payor

payeeGracePeriodProcessingEnabledboolean

Whether grace period processing is enabled.

payeeGracePeriodDaysinteger

The grace period for paying payees in days before the payee must be onboarded.

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.

languagestring

The payor’s language preference. Must be one of [EN, FR]

includesReportsboolean

For internal use only (will be removed in a later version)

wuCustomerIdstring

For internal use only (will be removed in a later version)

maxMasterPayorAdminsinteger

The maximum number of payor users with the master admin role

paymentRailsstring

For internal use only (will be removed in a later version)

remoteSystemIdsstring[]

For internal use only (will be removed in a later version)

usdTxnValueReportingThresholdinteger

USD in minor units. For internal use only (will be removed in a later version)

managingPayeesboolean

Does this payor manage their own payees (payees are not invited but managed by the payor)

createdAtstring date-time

The date of creation of the payor

Example response

{
  "primaryContactName": "Joe Buck",
  "payeeGracePeriodProcessingEnabled": true,
  "supportContact": "support@example.com",
  "payorXid": "ABC_201234",
  "includesReports": true,
  "managingPayees": true,
  "allowsLanguageChoice": true,
  "language": "EN",
  "createdAt": "2021-12-08T14:41:02.354982Z",
  "provider": "provider",
  "maxMasterPayorAdmins": 5,
  "manualLockout": true,
  "paymentRails": "paymentRails",
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "primaryContactEmail": "joe.buck@example.com",
  "usdTxnValueReportingThreshold": 1000000,
  "payorName": "Example Corp",
  "address": {
    "country": "US",
    "countyOrProvince": "FL",
    "line4": "line4",
    "city": "Key West",
    "line3": "line3",
    "line2": "line2",
    "line1": "500 Duval St",
    "zipOrPostcode": "33945"
  },
  "openBankingEnabled": true,
  "dbaName": "Some Biz",
  "primaryContactPhone": "123-123-1234",
  "payeeGracePeriodDays": 0,
  "reminderEmailsOptOut": true,
  "collectiveAlias": "Vendors",
  "kycState": "PASSED_KYC",
  "wuCustomerId": "wuCustomerId",
  "remoteSystemIds": [
    "REMOTE_SYSTEM_ID",
    "REMOTE_SYSTEM_ID"
  ]
}