Search Payees

Searches the payees of your payor account and returns one page of results.

Use it to list payees, to look one up by email or reference ID, or to find who is not yet payable.

Any payout role can call it.

You can filter and sort on these fields only:

  • userId: the payee ID.
  • referenceId, email.
  • displayFirstName, displayLastName, businessName.
  • type: personal or business.
  • payable: true or false.
  • currentStep: the onboarding step the payee is on.

Any other field is rejected. Pages hold 10 to 1000 payees (100 by default), and page × pageSize cannot exceed 10,000. See
Getting Started with Search for the filter syntax.

Errors

  • 400 VALIDATION_ERROR: the body is malformed, for example a field that is not searchable, a missing operator, or a
    pageSize out of range.
  • 400 INVALID_REQUEST: the search could not run with this filter, for example a value of the wrong type for the field.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
object

Conditions a record must match. Omit to return every record. Use all for AND and any for OR; groups can be nested.

sort
array of objects

Sort order, applied in the order listed.

sort
number
10 to 1000
Defaults to 100

Records per page, between 10 and 1000. Defaults to 100. page × pageSize cannot exceed 10,000; narrow the filter to reach
older records.

number
≥ 1
Defaults to 1

Page to return, starting at 1. Defaults to 1.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json