v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payees

Get Payee by Id

Use v4 instead

Get Payee by Id

get/v3/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

onboardedStatusstring

Onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED

watchlistStatusstring

Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED

watchlistOverrideExpiresAtTimestampstring date-time nullable

watchlistOverrideCommentstring

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.

createdstring date-time

countrystring

Valid ISO 3166 2 character country code. See the <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" a>ISO specification</a> for details.

displayNamestring

payeeTypestring

Type of Payee. One of the following values: Individual, Company

disabledboolean

disabledCommentstring

disabledUpdatedTimestampstring date-time

cellphoneNumberstring

watchlistStatusUpdatedTimestampstring date_time nullable

gracePeriodEndDatestring date nullable

enhancedKycCompletedboolean

kycCompletedTimestampstring date_time nullable

pausePaymentboolean

pausePaymentTimestampstring date_time nullable

marketingOptInDecisionboolean

marketingOptInTimestampstring date_time nullable

acceptTermsAndConditionsTimestampstring date-time nullable

The timestamp when the payee last accepted T&Cs

Example response

{
  "payorRefs": [
    {
      "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
      "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
      "payableStatus": true,
      "invitationStatus": "invitationStatus",
      "payableIssues": [
        {
          "code": "3",
          "message": "payee-disabled"
        },
        {
          "code": "3",
          "message": "payee-disabled"
        }
      ],
      "remoteId": "uniqueIdForRemoteEntity",
      "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
    },
    {
      "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
      "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
      "payableStatus": true,
      "invitationStatus": "invitationStatus",
      "payableIssues": [
        {
          "code": "3",
          "message": "payee-disabled"
        },
        {
          "code": "3",
          "message": "payee-disabled"
        }
      ],
      "remoteId": "uniqueIdForRemoteEntity",
      "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
    }
  ],
  "watchlistOverrideComment": "watchlist override comment",
  "country": "US",
  "cellphoneNumber": "1234567890",
  "watchlistStatus": "watchlistStatus",
  "displayName": "Bob",
  "payeeType": "payeeType",
  "kycCompletedTimestamp": "2019-01-20T09:00:00+00:00",
  "marketingOptInTimestamp": "2019-01-20T09:00:00+00:00",
  "language": "en-US",
  "watchlistOverrideExpiresAtTimestamp": "2019-01-20T09:00:00Z",
  "disabled": true,
  "company": {
    "taxId": "123123123",
    "name": "ABC Group Plc",
    "operatingName": "ABC Co"
  },
  "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
  "pausePaymentTimestamp": "2019-01-20T09:00:00+00:00",
  "email": "bob@example.com",
  "acceptTermsAndConditionsTimestamp": "2019-01-20T09:00:00Z",
  "disabledUpdatedTimestamp": "2019-01-20T09:00:00Z",
  "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"
  },
  "created": "2019-01-20T09:00:00Z",
  "enhancedKycCompleted": true,
  "pausePayment": true,
  "gracePeriodEndDate": "2019-01-20T00:00:00.000+0000",
  "marketingOptInDecision": true,
  "onboardedStatus": "onboardedStatus",
  "watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00",
  "disabledComment": "reason for disabled",
  "challenge": {
    "description": "challenge description",
    "value": "challenge test"
  }
}