Hercle
WebSocket

Get Payees Paginated

Returns an array of the user's payees.

Retrieve a paginated list of payees with optional date filtering.

Auth:API Key
Tags:
Banking
Payees
Command Name
GetPayeesPaginated

Command Arguments

ClientId
Required
Type:
string
Description:

Custom client ID for tracking (max 36 characters)

Example: "my-client-123"
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",
  "2025-01-01T00:00:00Z",
  "2025-12-31T23:59:59Z",
  0,
  20
]
Invocation Example:
connection.invoke('GetPayeesPaginated', 'my-client-123', '2025-01-01T00:00:00Z', '2025-12-31T23:59:59Z', 0, 20)

Response Event

Event Name
executionEvents
Subject
banking.payees.snapshot
FieldTypeDescription
idstringPayee ID
userIdstringUser ID associated with the payee
typenumber
Payee type
0→ Individual
1→ Company
namestringPayee first name
surnamestringPayee last name
companystringPayee company name (if applicable)
countrystringPayee country
statestringPayee state or province
citystringPayee city
addressstringPayee address
postalCodestringPayee postal code
disabledbooleanIndicates if the payee is disabled
deletedbooleanIndicates if the payee is deleted
endUserIdstringEnd user ID associated with the payee (if applicable)
createdAtstringTimestamp of payee creation

Example Response

{
  "data": [
    {
      "id": "id-001",
      "userId": "userId-001",
      "type": 1,
      "name": "John",
      "surname": "Doe",
      "company": "Acme Corp",
      "country": "US",
      "state": "CA",
      "city": "San Francisco",
      "address": "123 Main Street",
      "postalCode": "94105",
      "disabled": false,
      "deleted": false,
      "endUserId": "",
      "createdAt": "2025-09-03T11:22:54.000Z"
    },
    {
      "id": "id-002",
      "userId": "userId-001",
      "type": 2,
      "name": "Jane",
      "surname": "Smith",
      "company": "Tech Solutions Ltd",
      "country": "GB",
      "state": "London",
      "city": "London",
      "address": "456 High Street",
      "postalCode": "SW1A 1AA",
      "disabled": false,
      "deleted": false,
      "endUserId": "",
      "createdAt": "2025-09-05T14:30:22.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('GetPayeesPaginated', "my-client-123", "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.