WebSocket

Register Payee Address

Registers a new address for an existing payee.

Create a new address record for a payee with network-specific parameters.

Auth:API Key

Tags:

Banking

Payees

Addresses

Command Name

RegisterPayeeAddress

Command Arguments

Field	Type	Required	Description
`ClientId`	string	Required	Custom client ID for tracking (max 36 characters) Example: `"my-client-123"`
`PayeeId`	string	Required	Payee ID Example: `"e3ab5fc5-fed6-4648-9e69-83c3fcb9e100"`
`Name`	string	Required	Address name Example: `"USDC Wallet"`
`Asset`	string	Required	Asset name Example: `"USDC"`
`Address`	string	Required	Address string Example: `"address_001"`
`AddressParams`	object	Required	Additional address parameters (network-specific) Example: `{"tag":"stable"}`
`Network`	string	Required	Network name Example: `"Ethereum"`
`Comment`	string	Required	Optional comment or description Example: `"USDC receiving wallet"`

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: "e3ab5fc5-fed6-4648-9e69-83c3fcb9e100"

Name

Required

Type:

string

Description:

Address name

Example: "USDC Wallet"

Asset

Required

Type:

string

Description:

Asset name

Example: "USDC"

Address

Required

Type:

string

Description:

Address string

Example: "address_001"

AddressParams

Required

Type:

object

Description:

Additional address parameters (network-specific)

Example: {"tag":"stable"}

Network

Required

Type:

string

Description:

Network name

Example: "Ethereum"

Comment

Required

Type:

string

Description:

Optional comment or description

Example: "USDC receiving wallet"

Command Invocation

Command Arguments Example:

[
  "my-client-123",
  "e3ab5fc5-fed6-4648-9e69-83c3fcb9e100",
  "USDC Wallet",
  "USDC",
  "address_001",
  {
    "tag": "stable"
  },
  "Ethereum",
  "USDC receiving wallet"
]

Invocation Example:

connection.invoke('RegisterPayeeAddress', 'my-client-123', 'e3ab5fc5-fed6-4648-9e69-83c3fcb9e100', 'USDC Wallet', 'USDC', 'address_001', { tag: 'stable' }, 'Ethereum', 'USDC receiving wallet')

Response Event

Event Name

executionEvents

Subject

banking.payee.address.registered

Payee address registration response

Field	Type	Description
`httpStatusCode`	number	HTTP status code of the response
`id`	string	Unique identifier of the newly created payee address
`payeeId`	string	ID of the payee associated with the address
`name`	string	Descriptive name for the address
`asset`	string	Asset type for the address (e.g., EUR, USD)
`address`	string	The blockchain or payment address
`addressParams`	object	Additional address parameters as key-value pairs
`network`	string	Network for the address (e.g., Sepa, Swift)
`status`	number	Status code of the address (1 = active)
`comment`	string	Optional comment or description
`confirmationStrategy`	string	Confirmation strategy (e.g., EMAIL)
`confirmationToken`	string	Confirmation token (empty if not required)
`message`	string	Response message

Example Response

{
  "data": {
    "httpStatusCode": 201,
    "id": "1f6983ec-7146-4446-9f9b-b3560ce8f1e1",
    "payeeId": "e3ab5fc5-fed6-4648-9e69-83c3fcb9e100",
    "name": "EUR",
    "asset": "EUR",
    "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "addressParams": {
      "tag": "primary"
    },
    "network": "Sepa",
    "status": 1,
    "comment": "Primary",
    "confirmationStrategy": "EMAIL",
    "confirmationToken": "",
    "message": ""
  }
}

Network Types and Required Parameters

EUR Network Types

For EUR transfers, the following network types are available.

Field	Type	Description
`Sepa`	network	Single Euro Payments Area transfer

GBP Network Types

For GBP transfers, the following network types are available.

Field	Type	Description
`Faster Payments`	network	Instant transfer within the UK

USD Network Types

For USD transfers, the following network types are available.

Field	Type	Description
`INTERNATIONAL_WIRE`	network	International wire transfer
`DOMESTIC_WIRE`	network	Domestic wire transfer within the US
`ACH`	network	Standard ACH transfer
`ACH_SAME_DAY`	network	Same-day ACH transfer

Sepa - Required Address Parameters

Required parameters for Sepa network transfers.

Field	Type	Description
`bic`	string	Bank Identifier Code (SWIFT code) - Required

Faster Payments - Required Address Parameters

Required parameters for Faster Payments network transfers.

Field	Type	Description
`sortcode`	string	Sort code of the bank - Required

INTERNATIONAL_WIRE - Required Address Parameters

Required parameters for International Wire transfers.

Field	Type	Description
`accountnumber`	string	Bank account number - Required
`bic`	string	Bank Identifier Code (SWIFT code) - Required
`aba`	string	American Banking Association routing number - Required
`bankname`	string	Name of the bank - Required
`bankaddressline1`	string	First line of bank's address - Required
`bankaddresscity`	string	Bank's city - Required
`bankaddresspostalcode`	string	Bank's postal code - Required
`bankcountry`	string	Bank's country code - Required

DOMESTIC_WIRE - Required Address Parameters

Required parameters for Domestic Wire transfers.

Field	Type	Description
`accountnumber`	string	Bank account number - Required
`wire`	string	Wire routing number - Required
`bankname`	string	Name of the bank - Required

ACH / ACH_SAME_DAY - Required Address Parameters

Required parameters for ACH and ACH Same Day transfers.

Field	Type	Description
`accountnumber`	string	Bank account number - Required
`aba`	string	ACH routing number - Required
`accounttype`	string	Account type (CHECKING or SAVINGS) - Required

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('RegisterPayeeAddress', "my-client-123", "e3ab5fc5-fed6-4648-9e69-83c3fcb9e100", "USDC Wallet", "USDC", "address_001", {"tag":"stable"}, "Ethereum", "USDC receiving wallet")
      .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

Sandbox API Key

Your API key is only used locally and never stored

Event Log

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