GET /v3/payees

velopayments.com

Summary: List Payees
Operation ID: listPayeesV3
Auth: unknown
Description

<p>Use v4 instead</p> Get a paginated response listing the payees for a payor.

Parameters (12)

disabled (boolean, query, optional)

Payee disabled

displayName (string, query, optional)

The display name of the payees.

email (string, query, optional)

Email address

onboardedStatus (?, query, optional)

The onboarded status of the payees.

page (integer, query, optional, default: 1)

Page number. Default is 1.

pageSize (integer, query, optional, default: 25)

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

payeeCountry (string, query, optional)

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

payeeType (?, query, optional)

The onboarded status of the payees.

payorId (string, query, required)

The account owner Payor ID

remoteId (string, query, optional)

The remote id of the payees.

sort (string, query, optional, default: 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.

Constraints: {'pattern': '[a-zA-Z]+[:desc|:asc]'}

watchlistStatus (?, query, optional)

The watchlistStatus of the payees.

No probe data for this endpoint yet.