Sign in
Payees

List Payees V1

Get a paginated response listing the payees for a payor.

Please use V3 instead.

get/v1/payees

Query parameters

payorIdstring uuid required

The account owner Payor ID

ofacStatus'PENDING' | 'PASSED' | 'FAILED'

The ofacStatus of the payees.

onboardedStatus'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'

The onboarded status of the payees.

Emailstring email
Example:bob@example.com

Email address

displayNamestring
Example:Bob Smith

The display name of the payees.

remoteIdstring
Example:remoteId123

The remote id of the payees.

payeeType'Individual' | 'Company'

The onboarded status of the payees.

payeeCountrystring
Example:US

The country of the payee - 2 letter ISO 3166-1 country code (upper case)

pageinteger
Example:1

Page number. Default is 1.

pageSizeinteger
Example:25

Page size. Default is 25. Max allowable is 100.

sortstring
Example:displayName:asc

List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.

Response

Details of Payee

Example response

{
  "summary": {
    "totalOnboardedCount": 10,
    "totalRegisteredCount": 10,
    "totalPayeesCount": 10,
    "totalInvitedCount": 10,
    "totalOfacFailedCount": 0
  },
  "links": [
    {
      "rel": "rel",
      "href": "href"
    },
    {
      "rel": "rel",
      "href": "href"
    }
  ],
  "page": {
    "numberOfElements": 10,
    "totalPages": 10,
    "pageSize": 10,
    "page": 10,
    "totalElements": 10
  },
  "content": [
    {
      "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"
        }
      },
      "displayName": "ABC",
      "created": "2019-01-20T09:00:00Z",
      "lastOfacCheckTimestamp": "2019-01-20T09:00:00+00:00",
      "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": {
        "name": "ABC Ltd.",
        "operatingName": "ABC"
      },
      "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
      "email": "bob@example.com",
      "acceptTermsAndConditionsTimestamp": "2019-01-20T09:00:00Z"
    },
    {
      "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"
        }
      },
      "displayName": "ABC",
      "created": "2019-01-20T09:00:00Z",
      "lastOfacCheckTimestamp": "2019-01-20T09:00:00+00:00",
      "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": {
        "name": "ABC Ltd.",
        "operatingName": "ABC"
      },
      "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
      "email": "bob@example.com",
      "acceptTermsAndConditionsTimestamp": "2019-01-20T09:00:00Z"
    }
  ]
}

Changes