Sign in
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"
  }
}

Changes

Changed in 11 of the 50 revisions of this API.1041

  • 05c3f09fc50a2See the full diff
    • ▲

      the / response property's minLength was decreased from 6 to 4 for the response status

      response-property-min-length-decreased

    • ▲

      the / response property's minLength was decreased from 6 to 4 for the response status

      response-property-min-length-decreased

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b924ba134e091See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1e7a1734a45c14See the full diff
    • ○

      removed the ACCEPTED enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CREATED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Company enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the DECLINED enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the FAILED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVITED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Individual enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NONE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ONBOARDED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PASSED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PENDING enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PENDING enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the REGISTERED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the REVIEW enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • da77064fe2332See the full diff
    • ○

      the / response's property pattern ^[A-Z]{2}$ was added for the status

      response-property-pattern-added

    • ○

      the response's property pattern ^[A-Z]{2}$ was added for the status

      response-property-pattern-added

    This revision also has 76 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dd71433847a613See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      removed the AR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the EN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ES enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the FR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HI enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the JA enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PT enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the RU enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ZH enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 75bb7af5ae631See the full diff
    • ○

      endpoint deprecated

      endpoint-deprecated

  • aded220b0d7b1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7c8cfeb5995245See the full diff
    • ▲

      the / response property's maxLength was increased from 2 to 50 for the response status

      response-property-max-length-increased

    • ▲

      the response property's maxLength was unset from 2 for the response status

      response-property-max-length-unset

    • ▲

      the response property's minLength was decreased from 2 to 0 for the response status

      response-property-min-length-decreased

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ○

      the response property / became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the / response's property pattern ^[A-Z]{2}$ was removed for the status

      response-property-pattern-removed

    • ○

      the response's property pattern ^[A-Z]{2}$ was removed for the status

      response-property-pattern-removed

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 68f50053dc4042See the full diff
    • ▲

      the response property / became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ○

      the / response's property pattern ^[A-Z]{2}$ was added for the status

      response-property-pattern-added

    • ○

      the response's property pattern ^[A-Z]{2}$ was added for the status

      response-property-pattern-added

    This revision also has 47 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1b2abf26b5d61See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog