Export Payees

Exports every payee that matches a filter to a CSV or Excel file and returns a temporary link to it.

Use it for reports and reconciliation, when you need all matching payees at once instead of page by page.

Any payout role can call it.

The body takes the same filter and sort as Search Payees, on the same fields. It does not take page or pageSize: the
file holds every match. The file has these columns: Email, First Name, Last Name, Payee Setup Status, Business Name, Payable,
Reference ID, Type, Tax Jurisdictions, Payee ID.

The fileUrl link expires 60 seconds after the response. Download the file straight away; call Export Payees again for a new
link.

Errors

  • 400 INVALID_FILE_TYPE: fileType is not csv or xlsx.
  • 400 VALIDATION_ERROR: the body has a field that is not searchable, or a field other than filter and sort.
  • 400 INVALID_REQUEST: the search could not run with this filter.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to csv

File format: csv or xlsx (Excel). Defaults to csv.

Allowed:
Body Params

Filter and sort for Export Payees. Pagination does not apply: the file holds every matching payee.

object

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

sort
array of objects

Row order in the file, applied in the order listed.

sort
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