REST API Changelog

Stay up to date with the latest changes and improvements to our REST API.

05/05/2026

VirtualAccount.Registered webhook payload changed — The payload has been replaced from the InternalAddress shape to the VirtualAccount shape. The Id field is now the FiatRepublic VirtualAccountId (previously the Hercle internal GUID). BankDetails, Status, Owner, Currency, Label, CreatedAt, and UpdatedAt fields are now included. Consumers must update their webhook handlers to use the new schema.

VirtualAccount.StatusUpdated webhook event — New event fired when a virtual account status changes to CREATED, BLOCKED, CLOSED, ACTIVATION_FAILED, or UNBLOCKING. Uses the same VirtualAccount payload shape as VirtualAccount.Registered.
Virtual Account creation flow documentation — New section documenting the async VA lifecycle: CreateVirtualAccount → PENDING → VirtualAccount.Registered (ACTIVE) → VirtualAccount.StatusUpdated (other statuses)

EndUser.Updated and EndUser.StatusUpdated — Docs now reflect that both IndividualEndUser and BusinessEndUser payload shapes are possible, depending on the end user type
Banking.Withdrawal.StatusUpdated — Marked as planned; this event is not yet available
Webhook headers — Removed incorrect Authorization / API key header from documentation and code examples. Webhooks use RSA-SHA256 signature verification only.

PUT /api/v1/end-users/individuals/{id} - Update Individual End User endpoint
PUT /api/v1/end-users/businesses/{id} - Update Business End User endpoint
POST /api/v1/end-users/{endUserId}/documents - Upload End User Document endpoint with multipart/form-data support
DELETE /api/v1/end-users/relations - Delete End User Relation endpoint

Webhooks - Webhook integration is now available in production. Configure event subscriptions, receive real-time notifications, and verify payloads using RSA-SHA256 signatures

PATCH /api/v1/payees/{payeeId}/addresses/{payeeAddressId}/approve - Approve Payee Address endpoint for confirming registered payee addresses via EMAIL or API confirmation strategy

Webhooks Documentation - Comprehensive webhook integration guide now available (sandbox only), including payload structure, event types, RSA-SHA256 signature verification, and code examples for Node.js and Python

Idempotency support via Client-Id header (sandbox only) for transactional endpoints: Create Transfer, Create Withdrawal, Create Withdrawal With Address Params, Create Instant Withdrawal, Place OTC Order, Accept RFQ
GET /api/v1/transactions/{transactionId} - Get Transaction Ledger now available in Sandbox environment
GET /api/v1/end-users/individuals?pageSize={pageSize} - Get Individual End User endpoint (sandbox only)
POST /api/v1/end-users/individuals - Register Individual End User endpoint (sandbox only)

We're continuously improving our API. Future updates will be documented here, including:

Want to be notified of API changes?

This changelog will be updated as we release new features and improvements.