WebSocket

Get Transaction Ledger

Retrieves detailed information about a specific transaction, including ledger entries.

Auth:API Key

Tags:

Banking

Ledger

Command Name

GetTransactionLedger

Command Arguments

Field	Type	Required	Description
`ClientId`	string	Required	Custom client ID for tracking (max 36 characters) Example: `"my-client-123"`
`TransactionId`	string	Required	Transaction ID Example: `"a12f5e4d-3c6e-4b2a-9f4d-8e2b1c3d4e5f"`

ClientId

Required

Type:

string

Description:

Custom client ID for tracking (max 36 characters)

Example: "my-client-123"

TransactionId

Required

Type:

string

Description:

Transaction ID

Example: "a12f5e4d-3c6e-4b2a-9f4d-8e2b1c3d4e5f"

Command Invocation

Command Arguments Example:

[
  "my-client-123",
  "a12f5e4d-3c6e-4b2a-9f4d-8e2b1c3d4e5f"
]

Invocation Example:

connection.invoke('GetTransactionLedger', 'my-client-123', 'a12f5e4d-3c6e-4b2a-9f4d-8e2b1c3d4e5f')

Response Event

Event Name

executionEvents

Subject

ledger.transaction.details

Transaction ledger details response

Field	Type	Description
`id`	string	Transaction ID
`refId`	string	Reference ID associated with the transaction
`userId`	string	User ID associated with the transaction
`type`	string	Transaction type `DEPOSIT`→ Deposit transaction `WITHDRAWAL`→ Withdrawal transaction `TRADE_FEE`→ Trade fee transaction
`status`	string	Transaction status `CREATED`→ Transaction created `CONFIRMING`→ Transaction being confirmed `CONFIRMED`→ Transaction confirmed
`description`	string	Description of the transaction
`asset`	string	Asset involved in the transaction (e.g., EUR, BTC)
`amount`	number	Amount involved in the transaction
`debtor`	object	Details of the debtor (sender) - see Debtor Object below
`creditor`	object	Details of the creditor (receiver) - see Creditor Object below
`timestamp`	string	Timestamp of the transaction creation

Example Response

{
  "data": {
    "id": "a12f5e4d-3c6e-4b2a-9f4d-8e2b1c3d4e5f",
    "refId": "b34d6e7f-8a9b-4c0d-9e1f-2a3b4c5d6e7f",
    "userId": "c56e7f8a-9b0c-4d1e-2f3a-4b5c6d7e8f9a",
    "type": "DEPOSIT",
    "status": "CREATED",
    "description": "Deposit",
    "asset": "EUR",
    "amount": 1000,
    "debtor": {
      "bankName": "ABC Bank",
      "bankAddressCountry": "",
      "accountHolderName": "John Smith",
      "country": "IT",
      "accountNumber": "",
      "routingCodes": {},
      "iban": "IT123A456B789C012D345E678F90",
      "bic": "AABCDEFFXXX"
    },
    "creditor": {
      "bankName": "ACME Bank",
      "bankAddressCountry": "",
      "accountHolderName": "Acme Corporation",
      "country": "DE",
      "accountNumber": "",
      "routingCodes": {},
      "iban": "DE123A456B789C012D345E678F90",
      "bic": "AABCDEFFXXX"
    },
    "timestamp": "2025-08-26T12:56:36.065Z"
  }
}

Transaction Ledger Object Structure

Debtor Object (Fiat)

The debtor object contains information about the sender for fiat transactions.

Field	Type	Description
`bankName`	string	Name of the debtor's bank
`bankAddressCountry`	string	Country of the bank's address
`accountHolderName`	string	Name of the account holder
`country`	string	Country code of the account
`accountNumber`	string	Bank account number
`routingCodes`	object	Routing codes for the bank
`iban`	string	International Bank Account Number
`bic`	string	Bank Identifier Code (SWIFT code)

Debtor Object (Crypto)

For cryptocurrency transactions, the debtor object contains blockchain-specific information.

Field	Type	Description
`address`	string	Debtor's blockchain address
`asset`	string	Asset being sent by the debtor
`network`	string	Network of the debtor's address (e.g., Bitcoin, Ethereum)

Creditor Object (Fiat)

The creditor object contains information about the receiver for fiat transactions.

Field	Type	Description
`bankName`	string	Name of the creditor's bank
`bankAddressCountry`	string	Country of the bank's address
`accountHolderName`	string	Name of the account holder
`country`	string	Country code of the account
`accountNumber`	string	Bank account number
`routingCodes`	object	Routing codes for the bank
`iban`	string	International Bank Account Number
`bic`	string	Bank Identifier Code (SWIFT code)

Creditor Object (Crypto)

For cryptocurrency transactions, the creditor object contains blockchain-specific information.

Field	Type	Description
`address`	string	Creditor's blockchain address
`asset`	string	Asset being received by the creditor
`network`	string	Network of the creditor's address (e.g., Bitcoin, Ethereum)

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('GetTransactionLedger', "my-client-123", "a12f5e4d-3c6e-4b2a-9f4d-8e2b1c3d4e5f")
      .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.