Get Payees Paginated

Retrieve a paginated list of payees optionally filtered by date range. Maximum date range is 30 days.

Auth:Bearer <api_key>

Tags:Banking

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/payees?pageSize={pageSize} \
  -H "Authorization: Bearer eyJhb..." \

Query Parameters

Name	Type	Required	Description
pageSize	number	Yes	Number of items per page (min: 5, max: 50) Example: `5`
from	string	No	Start date for filtering historical trades (ISO 8601 format). Maximum range: 30 days from end date. Example: `2025-01-01T00:00:00Z`
to	string	No	End date for filtering historical trades (ISO 8601 format). Maximum range: 30 days from start date. Example: `2025-12-31T23:59:59Z`
paginationToken	string	No	Token for fetching the next page of results

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Success Response Schema

Paginated list of payees.

Field	Type	Description
`payload`	array
`payload[].id`	string	Unique identifier for the payee
`payload[].userId`	string	User identifier who owns the payee
`payload[].endUserId`	string	End user ID if applicable
`payload[].type`	number	Payee type `0`→ Individual `1`→ Company
`payload[].name`	string	First name of the payee
`payload[].surname`	string	Last name of the payee
`payload[].company`	string	Company name
`payload[].country`	string	Country code (ISO 3166-1 alpha-2)
`payload[].state`	string	State or province
`payload[].city`	string	City name
`payload[].address`	string	Street address
`payload[].postalCode`	string	Postal or ZIP code
`payload[].disabled`	boolean	Whether the payee is disabled
`payload[].deleted`	boolean	Whether the payee is deleted
`payload[].createdAt`	string	ISO 8601 timestamp of creation
`paginationToken`	string	Token for fetching next page

Responses

Paginated list of payees.

200 application/json

{
  "payload": [
    {
      "id": "payee-001",
      "userId": "user-123",
      "endUserId": "enduser-456",
      "type": 0,
      "name": "John",
      "surname": "Doe",
      "company": "Company Inc.",
      "country": "US",
      "state": "CA",
      "city": "San Francisco",
      "address": "123 Market St",
      "postalCode": "94103",
      "disabled": false,
      "deleted": false,
      "createdAt": "2023-01-15T12:34:56Z"
    }
  ],
  "paginationToken": "{\"Id\":{\"S\":\"id-002\"}}"
}

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Query Parameters

pageSize

Required

Number of items per page (min: 5, max: 50)

from

Start date for filtering historical trades (ISO 8601 format). Maximum range: 30 days from end date.

End date for filtering historical trades (ISO 8601 format). Maximum range: 30 days from start date.

paginationToken

Token for fetching the next page of results

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/payees