List Payees
Use v4 instead
Get a paginated response listing the payees for a payor.
Query parameters
The account owner Payor ID
Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED
The watchlistStatus of the payees.
Payee disabled
Payee onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED
The onboarded status of the payees.
Email address
The display name of the payees.
The remote id of the payees.
Type of Payee. One of the following values: Individual, Company
The onboarded status of the payees.
The country of the payee - 2 letter ISO 3166-1 country code (upper case)
Page number. Default is 1.
Page size. Default is 25. Max allowable is 100.
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,
"totalWatchlistFailedCount": 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",
"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": "Example reason for the watchlist status being overridden",
"country": "US",
"watchlistStatus": "watchlistStatus",
"disabledUpdatedTimestamp": "2019-01-20T09:00:00Z",
"individual": {
"name": {
"firstName": "Bob",
"lastName": "Smith",
"otherNames": "H",
"title": "Mr"
}
},
"created": "2019-01-20T09:00:00Z",
"displayName": "ABC",
"payeeType": "payeeType",
"language": "en-US",
"onboardedStatus": "onboardedStatus",
"watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00",
"disabledComment": "reason for disabled",
"disabled": true,
"company": {
"name": "ABC Group Plc",
"operatingName": "ABC Co"
},
"payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
"email": "bob@example.com"
},
{
"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": "Example reason for the watchlist status being overridden",
"country": "US",
"watchlistStatus": "watchlistStatus",
"disabledUpdatedTimestamp": "2019-01-20T09:00:00Z",
"individual": {
"name": {
"firstName": "Bob",
"lastName": "Smith",
"otherNames": "H",
"title": "Mr"
}
},
"created": "2019-01-20T09:00:00Z",
"displayName": "ABC",
"payeeType": "payeeType",
"language": "en-US",
"onboardedStatus": "onboardedStatus",
"watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00",
"disabledComment": "reason for disabled",
"disabled": true,
"company": {
"name": "ABC Group Plc",
"operatingName": "ABC Co"
},
"payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
"email": "bob@example.com"
}
]
}