Get Payee Addresses Paginated

Retrieve a paginated list of payee addresses 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/payee-addresses?payeeId={payeeId}&pageSize={pageSize} \
  -H "Authorization: Bearer eyJhb..." \

Query Parameters

Name	Type	Required	Description
payeeId	string	Yes	Filter payee addresses by payee ID Example: `123e4567-e89b-12d3-a456-426614174000`
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: `2023-01-01T00:00:00Z`
to	string	No	End date for filtering historical trades (ISO 8601 format). Maximum range: 30 days from start date. Example: `2023-01-31T23:59:59Z`
paginationToken	string	No	Token for fetching the next page of results Example: `{"Id":{"S":"id-001"}}`

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Success Response Schema

Paginated list of payee addresses.

Field	Type	Description
`payload`	array
`payload[].id`	string	Unique identifier for the payee address
`payload[].payeeId`	string	Payee identifier this address belongs to
`payload[].name`	string	Name associated with the address
`payload[].asset`	string	Asset code (e.g., BTC, ETH, USD)
`payload[].address`	string	The payment or blockchain address
`payload[].addressParams`	object	Additional address parameters
`payload[].network`	string	Network name (e.g., Bitcoin, Ethereum)
`payload[].status`	number	Address status `0`→ CREATED `1`→ PENDING `2`→ REFUSED
`payload[].comment`	string \| null	Admin comment or note
`payload[].auditBy`	string \| null	Username of auditor
`payload[].auditDate`	string \| null	ISO 8601 audit timestamp
`payload[].deleted`	boolean	Whether the address is deleted
`payload[].createdAt`	string	ISO 8601 creation timestamp
`paginationToken`	string	Token for fetching next page

Responses

Paginated list of payee addresses.

200 application/json

{
  "payload": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "payeeId": "987e6543-e21b-12d3-a456-426614174000",
      "name": "John Doe",
      "asset": "BTC",
      "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "addressParams": {},
      "network": "Bitcoin",
      "status": 0,
      "comment": null,
      "auditBy": null,
      "auditDate": null,
      "deleted": false,
      "createdAt": "2023-01-15T12:00:00Z"
    }
  ],
  "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

payeeId

Required

Filter payee addresses by payee ID

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/payee-addresses