Sign in
Payees

Get Payee by Id

Get Payee by Id

Please use V3 instead.

get/v2/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
onboardedStatus'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'
ofacStatus'PENDING' | 'PASSED' | 'FAILED'
language'AR' | 'EN' | 'ES' | 'FR' | 'HE' | 'HI' | 'JA' | 'PT' | 'RU' | 'UR' | 'ZH'

Available Payee Language codes

createdstring date-time
countrystring
displayNamestring
payeeType'Individual' | 'Company'
disabledboolean
disabledCommentstring
disabledUpdatedTimestampstring date-time
cellphoneNumberstring
lastOfacCheckTimestampstring date_time nullable
ofacOverrideboolean
ofacOverrideReasonstring
ofacOverrideTimestampstring 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",
      "invitationStatus": "ACCEPTED",
      "remoteId": "uniqueIdForRemoteEntity",
      "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
    },
    {
      "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
      "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
      "invitationStatus": "ACCEPTED",
      "remoteId": "uniqueIdForRemoteEntity",
      "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
    }
  ],
  "country": "US",
  "cellphoneNumber": "1234567890",
  "displayName": "Bob",
  "ofacOverride": true,
  "ofacOverrideReason": "ofac override reason",
  "kycCompletedTimestamp": "2019-01-20T09:00:00+00:00",
  "marketingOptInTimestamp": "2019-01-20T09:00:00+00:00",
  "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",
  "lastOfacCheckTimestamp": "2019-01-20T09:00:00+00:00",
  "enhancedKycCompleted": true,
  "pausePayment": true,
  "gracePeriodEndDate": "2019-01-20T00:00:00.000+0000",
  "marketingOptInDecision": true,
  "ofacOverrideTimestamp": "2019-01-20T09:00:00+00:00",
  "disabledComment": "reason for disabled"
}

Changes