Hercle
WebSocket

Get Payee Addresses Paginated

Returns an array of addresses associated with a specific payee.

Auth:API Key
Tags:
Banking
Payees
Addresses
Command Name
GetPayeeAddressesPaginated

Command Arguments

ClientId
Required
Type:
string
Description:

Custom client ID for tracking (max 36 characters)

Example: "my-client-123"
PayeeId
Required
Type:
string
Description:

Payee ID

Example: "payeeId-001"
From
Required
Type:
string | null
Description:

Start date in ISO format (e.g., 2025-01-01T00:00:00Z). Can be null to omit start date filtering.

Example: "2025-01-01T00:00:00Z"
To
Required
Type:
string | null
Description:

End date in ISO format (e.g., 2025-12-31T23:59:59Z). Can be null to omit end date filtering.

Example: "2025-12-31T23:59:59Z"
Page
Required
Type:
number
Description:

Page number for pagination (0-based)

0
PageSize
Required
Type:
number
Description:

Number of results per page (must be between 5 and 50)

Example: 20

Command Invocation

Command Arguments Example:
[
  "my-client-123",
  "payeeId-001",
  "2025-01-01T00:00:00Z",
  "2025-12-31T23:59:59Z",
  0,
  20
]
Invocation Example:
connection.invoke('GetPayeeAddressesPaginated', 'my-client-123', 'payeeId-001', '2025-01-01T00:00:00Z', '2025-12-31T23:59:59Z', 0, 20)

Response Event

Event Name
executionEvents
Subject
banking.payee.addresses.snapshot
FieldTypeDescription
idstringAddress ID
payeeIdstringID of the associated payee
namestringDescriptive name for the address
assetstringAsset type for the address (e.g., BTC, ETH)
addressstringThe actual blockchain or payment address
addressParamsobjectAdditional parameters for the address (network specific)
networkstringNetwork for the address (e.g., Bitcoin, Ethereum)
statusnumber
Address status
0→ CREATED
1→ PENDING
2→ REFUSED
commentstringOptional comment or description
auditBystringID of the user who audited the address
auditDatestringTimestamp of the last audit
deletedbooleanIndicates if the address has been deleted
createdAtstringTimestamp of address creation

Example Response

{
  "data": [
    {
      "id": "id-001",
      "payeeId": "payeeId-001",
      "name": "USDC Wallet",
      "asset": "USDC",
      "address": "address_001",
      "addressParams": {
        "tag": "stable"
      },
      "network": "Ethereum",
      "status": 2,
      "comment": "USDC receiving wallet",
      "auditBy": "System",
      "auditDate": "2025-09-11T17:50:59.000Z",
      "deleted": false,
      "createdAt": "2025-09-11T17:50:59.000Z"
    },
    {
      "id": "id-002",
      "payeeId": "payeeId-001",
      "name": "BTC Main Wallet",
      "asset": "BTC",
      "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "addressParams": {},
      "network": "Bitcoin",
      "status": 2,
      "comment": "Primary BTC address",
      "auditBy": "admin@example.com",
      "auditDate": "2025-09-12T10:30:00.000Z",
      "deleted": false,
      "createdAt": "2025-09-12T10:30:00.000Z"
    }
  ]
}

Code Examples

const signalR = require('@microsoft/signalr');

const apiKey = 'YOUR_API_KEY_HERE';
const connection = new signalR.HubConnectionBuilder()
  .withUrl('https://publicapi.sandbox.hercle.financial/ExecutionLiveServer/v1', {
    accessTokenFactory: () => apiKey,
  })
  .build();

connection.start()
  .then(() => {
    console.log('Connected to WebSocket');
    
    // Invoke command
    connection.invoke('GetPayeeAddressesPaginated', "my-client-123", "payeeId-001", "2025-01-01T00:00:00Z", "2025-12-31T23:59:59Z", 0, 20)
      .then(() => {
        console.log('Command sent successfully');
      })
      .catch(err => {
        console.error('Command failed:', err);
      });
  })
  .catch(err => {
    console.error('Connection failed:', err);
  });

// Listen for events
connection.on('executionEvents', (data) => {
  console.log('Received event:', data);
});

SignalR API Tester

Test this command in the sandbox environment

Disconnected

Your API key is only used locally and never stored

Event Log

No events yet. Connect and invoke a command to see events.