Sign in
Payees

List Payees

Get a paginated response listing the payees for a payor.

get/v4/payees

Query parameters

payorIdstring uuid required

The account owner Payor ID

watchlistStatusstring

Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED

The watchlistStatus of the payees.

disabledboolean

Payee disabled

onboardedStatusstring

Payee onboarded status. One of the following values: 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.

payeeTypestring

Type of Payee. One of the following values: 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)

ofacStatusstring

OFAC status. One of the following values: PENDING, PASSED, FAILED

The ofacStatus of the payees.

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,
    "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",
      "managedByPayorId": "a2967711-df07-41e5-b5ea-0f563088911c",
      "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",
      "managedByPayorId": "a2967711-df07-41e5-b5ea-0f563088911c",
      "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"
    }
  ]
}

Changes

Changed in 6 of the 50 revisions of this API.1954

  • b924ba134e091See the full diff
    • ○

      added the optional property content/items/managedByPayorId to the response with the 200 status

      response-optional-property-added

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

  • 1e7a1734a45c1414See the full diff
    • ▲

      removed the enum value CREATED from the query request parameter onboardedStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value Company from the query request parameter payeeType

      request-parameter-enum-value-removed

    • ▲

      removed the enum value FAILED from the query request parameter ofacStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value FAILED from the query request parameter watchlistStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value INVITED from the query request parameter onboardedStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value Individual from the query request parameter payeeType

      request-parameter-enum-value-removed

    • ▲

      removed the enum value NONE from the query request parameter watchlistStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value ONBOARDED from the query request parameter onboardedStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value PASSED from the query request parameter ofacStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value PASSED from the query request parameter watchlistStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value PENDING from the query request parameter ofacStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value PENDING from the query request parameter watchlistStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value REGISTERED from the query request parameter onboardedStatus

      request-parameter-enum-value-removed

    • ▲

      removed the enum value REVIEW from the query request parameter watchlistStatus

      request-parameter-enum-value-removed

    • ○

      removed the ACCEPTED enum value from the content/items/payorRefs/items/invitationStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CREATED enum value from the content/items/onboardedStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Company enum value from the content/items/payeeType response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DECLINED enum value from the content/items/payorRefs/items/invitationStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FAILED enum value from the content/items/watchlistStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the INVITED enum value from the content/items/onboardedStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Individual enum value from the content/items/payeeType response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the NONE enum value from the content/items/watchlistStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ONBOARDED enum value from the content/items/onboardedStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PASSED enum value from the content/items/watchlistStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING enum value from the content/items/payorRefs/items/invitationStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING enum value from the content/items/watchlistStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the REGISTERED enum value from the content/items/onboardedStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the REVIEW enum value from the content/items/watchlistStatus response property for the response status 200

      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

  • da77064fe2331See the full diff
    • ○

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

      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

  • dd71433847a6437See the full diff
    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 401

      response-property-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 403

      response-property-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 404

      response-property-type-changed

    • ○

      added the optional property content/items/payorRefs/items/payableIssues to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property content/items/payorRefs/items/payableStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorCode to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorCode to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorCode to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorCode to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorData to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorData to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorData to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property errors/items/errorData to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property errors/items/localisationDetails to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/localisationDetails to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/localisationDetails to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property errors/items/localisationDetails to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property httpStatusCode to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property httpStatusCode to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property httpStatusCode to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property httpStatusCode to the response with the 404 status

      response-optional-property-added

    • ○

      response property errors/items/locationType deprecated

      response-property-deprecated

    • ○

      response property errors/items/locationType deprecated

      response-property-deprecated

    • ○

      response property errors/items/locationType deprecated

      response-property-deprecated

    • ○

      response property errors/items/locationType deprecated

      response-property-deprecated

    • ○

      response property errors/items/reasonCode deprecated

      response-property-deprecated

    • ○

      response property errors/items/reasonCode deprecated

      response-property-deprecated

    • ○

      response property errors/items/reasonCode deprecated

      response-property-deprecated

    • ○

      response property errors/items/reasonCode deprecated

      response-property-deprecated

    • ○

      removed the AR enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the EN enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ES enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FR enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the HE enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the HI enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the JA enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PT enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the RU enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UR enum value from the content/items/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ZH enum value from the content/items/language response property for the response status 200

      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 added

      endpoint-added

  • ced8e167a97c1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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