# Lists all payees.

Lists all payees with optional pagination and sorting.

Endpoint: POST /v1/payees/list
Security: Bearer

## Request fields (application/json):

  - `pageNumber` (integer)

  - `pageSize` (integer)

  - `route` (string,null)

  - `sortProperty` (string,null)

  - `isDescending` (boolean)

  - `merchantId` (integer,null)

  - `searchText` (string,null)

## Response 200 fields (text/plain):

  - `id` (integer)
    Example: 174

  - `payeeType` (string,null)
    Example: "INDIVIDUAL|BUSINESS|BRAID"

  - `name` (string,null)

  - `email` (string,null)

  - `phoneNumber` (string,null)

  - `taxId` (string,null)

  - `businessName` (string,null)
    Example: "ABC Private ltd"

  - `businessType` (string,null)

  - `nationality` (string,null)
    Example: "USA"

  - `idType` (string,null)
    Example: "SSN"

  - `currency` (string,null)
    Example: "USD"

  - `address` (object)

  - `address.addressLine` (string,null)

  - `address.state` (string,null)

  - `address.city` (string,null)

  - `address.country` (string,null)

  - `address.postalCode` (string,null)

  - `dateOfBirth` (string,null)

  - `isActive` (boolean)


## Response 500 fields