Get Transaction Ledger

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

Auth:Bearer <api_key>

Tags:Banking

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/transactions/{transactionId} \
  -H "Authorization: Bearer eyJhb..." \

Path Parameters

Name	Type	Required	Description
transactionId	string	Yes	The unique identifier of the transaction to retrieve

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Success Response Schema

Transaction retrieved successfully

Field	Type	Description
`id`	string	Unique identifier for the transaction
`refId`	string	Reference ID for the transaction
`userId`	string	User identifier who owns the transaction
`type`	string	Type of transaction Allowed values: `DEPOSIT` `WITHDRAWAL` `TRADE_FEE`
`status`	string	Current status of the transaction Allowed values: `CREATED` `CONFIRMING` `CONFIRMED`
`description`	string	Description of the transaction
`asset`	string	Asset code (e.g., USD, EUR)
`amount`	number	Transaction amount
`debtor`	object	Debtor account details (banking or crypto)
`creditor`	object	Creditor account details (banking or crypto)
`timestamp`	string	ISO 8601 timestamp of the transaction

Banking Account Object

Banking account details for fiat transactions (debtor/creditor)

Field	Type	Description
`bankName`	string	Name of the bank
`bankAddressCountry`	string	Country of the bank
`accountHolderName`	string	Name of the account holder
`country`	string	Country of the account holder
`accountNumber`	string	Account number
`routingCodes`	object	Bank routing codes
`iban`	string	IBAN of the account
`bic`	string	BIC/SWIFT code of the bank

Crypto Account Object

Cryptocurrency account details for crypto transactions (debtor/creditor)

Field	Type	Description
`address`	string	Cryptocurrency address
`addressParams`	object	Additional address parameters (e.g., tag)
`txHash`	string \| null	Transaction hash for blockchain transactions
`network`	string	Blockchain network (e.g., Bitcoin, Ethereum, Lightning)

Responses

Transaction retrieved successfully

200 application/json

[
  {
    "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"
  },
  {
    "id": "d45e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
    "refId": "e56f9a0b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
    "userId": "f67a0b1c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
    "type": "WITHDRAWAL",
    "status": "CONFIRMING",
    "description": "Bitcoin Withdrawal",
    "asset": "BTC",
    "amount": 0.05,
    "debtor": {
      "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "addressParams": {},
      "txHash": "3a5e7b9d4c8f2a1e6b3d9c5e8f2a4b7d9c1e6a3f5b8d2c4e9a7f1b6d3c8e5a2",
      "network": "Bitcoin"
    },
    "creditor": {
      "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "addressParams": {},
      "txHash": null,
      "network": "Bitcoin"
    },
    "timestamp": "2025-08-26T14:32:18.123Z"
  }
]

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Path Parameters

transactionId

Required

The unique identifier of the transaction to retrieve

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/transactions/{transactionId}