Sign in
Payees

Get Payee by Id

Get Payee by Id

Please use V3 instead.

get/v1/payees/{payeeId}

Path parameters

payeeIdstring uuid required
Example:2aa5d7e0-2ecb-403f-8494-1865ed0454e9

The UUID of the payee.

Query parameters

sensitiveboolean

Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.

Response

Success response, request completed okay

payeeIdstring uuid
emailstring email nullable
countrystring
displayNamestring
languagestring

An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.

acceptTermsAndConditionsTimestampstring date-time nullable

The timestamp when the payee last accepted T&Cs

cellphoneNumberstring
payeeType'Individual' | 'Company'
createdstring date-time
gracePeriodEndDatestring date nullable
lastOfacCheckTimestampstring date_time nullable
ofacStatus'PENDING' | 'PASSED' | 'FAILED'
onboardedStatus'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'

Example response

{
  "payorRefs": [
    {
      "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
      "invitationStatus": "ACCEPTED",
      "remoteId": "uniqueIdForRemoteEntity"
    },
    {
      "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
      "invitationStatus": "ACCEPTED",
      "remoteId": "uniqueIdForRemoteEntity"
    }
  ],
  "country": "US",
  "cellphoneNumber": "1234567890",
  "address": {
    "country": "US",
    "countyOrProvince": "FL",
    "line4": "line4",
    "city": "Key West",
    "line3": "line3",
    "line2": "line2",
    "line1": "500 Duval St",
    "zipOrPostcode": "33945"
  },
  "individual": {
    "name": {
      "firstName": "Bob",
      "lastName": "Smith",
      "otherNames": "A",
      "title": "Mr"
    },
    "nationalIdentification": "AB123456C",
    "dateOfBirth": "1985-01-01"
  },
  "displayName": "Bob",
  "created": "2019-01-20T09:00:00Z",
  "lastOfacCheckTimestamp": "2019-01-20T09:00:00+00:00",
  "language": "en-US",
  "gracePeriodEndDate": "2019-01-20T00:00:00.000+0000",
  "paymentChannel": {
    "paymentChannelName": "My payment channel",
    "routingNumber": "XXXXX6789",
    "accountName": "My account",
    "countryCode": "UK",
    "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
    "currency": "USD",
    "accountNumber": "XXXXXX5678"
  },
  "marketingOptIns": [
    {
      "optedIn": true,
      "timestamp": "2019-01-20T09:00:00Z"
    },
    {
      "optedIn": true,
      "timestamp": "2019-01-20T09:00:00Z"
    }
  ],
  "challenge": {
    "description": "challenge description",
    "value": "challenge test"
  },
  "company": {
    "taxId": "123",
    "name": "ABC Ltd",
    "operatingName": "ABC"
  },
  "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
  "email": "bob@example.com",
  "acceptTermsAndConditionsTimestamp": "2019-01-20T09:00:00Z"
}

Changes