VEvelopaymentsapi
Payees

Get Payee by Id

Changed on

Get Payee by Id

get/v4/payees/{payeeId}

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

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

Payee 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
displayNamestring
payeeTypestring

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

disabledboolean
disabledCommentstring
disabledUpdatedTimestampstring date-time
cellphoneNumberstring
managedByPayorIdstring uuid

The id of the payor if the payee is managed

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",
  "paymentChannels": [
    {
      "disabledReason": "User request",
      "disabledReasonCode": "VR100",
      "countryCode": "US",
      "name": "Bank of America USD",
      "currency": "USD",
      "enabled": false,
      "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
      "last4Digits": "1234"
    },
    {
      "disabledReason": "User request",
      "disabledReasonCode": "VR100",
      "countryCode": "US",
      "name": "Bank of America USD",
      "currency": "USD",
      "enabled": false,
      "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
      "last4Digits": "1234"
    }
  ],
  "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",
  "managedByPayorId": "a2967711-df07-41e5-b5ea-0f563088911c",
  "marketingOptInDecision": true,
  "onboardedStatus": "onboardedStatus",
  "watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00",
  "disabledComment": "reason for disabled",
  "challenge": {
    "description": "challenge description",
    "value": "11984567"
  }
}

Changes

  • 05c3f09fc50aRevision changes
    • breaking

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

    • breaking

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

  • b924ba134e09Revision changes
    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status