For the complete documentation index, see llms.txt. This page is also available as Markdown.

Deposits

Deposit Completed

POST

Notifies the status of an incoming deposit.

Allowed Values: COMPLETED

Body

{
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "messageType": "DEPOSIT_COMPLETED",
  "messageTime": "2023-12-14T01:24:03.102Z",
  "message": {
    "depositId": "85b49f93-6975-42f9-a88d-863da9046ce2",
    "clientId": "722cb4dd-159d-45f6-9696-ccf0277a3e76",
    "transactionType": "DEPOSIT",
    "transactionStatus": "COMPLETED",
    "accountId": "62fd7c1e-4a04-4a2e-b2ff-4daac8b4aeaf",
    "quantity": 15.38,
    "currency": "USD",
    "receivedAt": "2025-12-23T01:43:00.028Z",
    "completedAt": "2025-12-23T01:43:00.028Z",
    "memo": "XYZ10000101C",
    "clientMemo": "XYZ10000101C",
    "txHash": "0xdaf4e8e8a2932c8a6229ff78bd71b5d4a38a44fe96860b9a773b2d0898d0240e",
    "tradeBalance": 193.9825,
    "availableToWithdraw": 193.9825,
    "externalDepositId": "07c3bd7c-9813-45a6-9081-a34f57e2f107"
  }
}

Field Reference

Event: Notifies the status of an incoming deposit. For example:

  • Crypto Deposits: Transfer of native digital assets or stablecoins (e.g., sending 1 BTC, 5 ETH, or 500 USDC via their respective blockchain networks).

  • Fiat Deposits: Traditional currency fundings settled via banking rails (e.g., a $10,000 USD Fedwire transfer or an EUR SEPA transfer into the designated clearing account).

message Header

Field

Type

Description

messageId

UUID (string)

Unique identifier for this webhook message.

messageType

string

Event type identifier. Value: DEPOSIT_COMPLETED.

messageTime

ISO 8601 datetime

Timestamp when the webhook message was generated.

message

object

Payload containing deposit details (see below).

message Object

Field

Type

Description

depositId

UUID (string)

Unique identifier for the deposit transaction.

clientId

UUID (string)

Identifier of the client associated with the deposit. Here, client refers to the Tenant / Institutional Entity operating the account on the platform, rather than an end-user.Example:​Example: If an omnibus brokerage named Apex Crypto Liquidity Ltd. sets up an institutional partnership, the clientId is the unique system UUID assigned directly to Apex Crypto Liquidity Ltd.

transactionType

string

Type of transaction. Value: DEPOSIT.

transactionStatus

string (enum)

Current status of the deposit. One of PROCESSING, CONFIRMING, COMPLETED.​ Note that:

  • CONFIRMING is applicable only to Crypto deposits. This status directly reflects the blockchain network's confirmation process (waiting for the required block depth).

  • COMPLETED is applicable to both, Crypto and Fiat deposits. This status implies that the deposit has been fully settled and the funds have been credited to the customer's account.

accountId

UUID (string)

Identifier of the account credited by the deposit.

quantity

number

Amount of the deposit.

currency

string

Currency code of the deposit (e.g. USD).

receivedAt

ISO 8601 datetime

Timestamp when the deposit was first received/detected.

completedAt

ISO 8601 datetime

Timestamp when the deposit was completed.

memo

string

System-generated memo/reference tag for the deposit.​

Note: This is a system-generated internal ID or routing reference created by Aquanow. Clients use it primarily for automated reconciliation. It acts as a unique reference link to track the deposit event across webhooks, reporting APIs, and internal account ledger audits.

clientMemo

string

Client-provided memo/reference tag for the deposit.

txHash

string

On-chain transaction hash associated with the deposit. This field is populated only for crypto deposits. It will return null or be omitted for traditional fiat wire transfers.

tradeBalance

number

Account's total trade balance after the deposit.

availableToWithdraw

number

Amount available for withdrawal after the deposit.​By definition:

  • tradeBalance is the complete, nominal balance allocated to the account for active trading or market-making immediately after the deposit is credited.

  • availableToWithdraw is the actual subset of funds free to leave the platform. This amount may be lower than the tradeBalance if funds are temporarily locked due to active open orders, margin requirements, unconfirmed bank clearings, or risk holds.

externalDepositId

UUID (string)

External/third-party reference ID for the deposit.

Deposits Confirming

POST

Notifies that an incoming crypto deposit has been detected on-chain and is waiting for the required blockchain confirmations before it completes.

Allowed Values: CONFIRMING

Body

Field Reference

Event: Notifies that an incoming crypto deposit has been detected and is awaiting the required blockchain confirmations before it completes. For example:

  • Crypto Deposits: A transfer of native digital assets or stablecoins (e.g., 1 BTC, 5 ETH, or 500 USDC) that has been detected on-chain but has not yet reached sufficient network confirmations.

message Header

Field
Type
Description

messageId

UUID (string)

Unique identifier for this webhook message.

messageTime

ISO 8601 datetime

Timestamp when the webhook message was generated.

messageType

string

Event type identifier. Value: DEPOSIT_CONFIRMING.

message

object

Payload containing deposit details (see below).

message Object

Field
Type
Description

depositId

UUID (string)

Unique identifier for the deposit transaction.

transactionType

string

Type of transaction. Value: DEPOSIT.

clientId

UUID (string)

Identifier of the client associated with the deposit. Here, client refers to the tenant/institutional entity operating the account on the platform, rather than an end user. Example: if an omnibus brokerage named Apex Crypto Liquidity Ltd. sets up an institutional partnership, clientId is the unique system UUID assigned directly to Apex Crypto Liquidity Ltd.

transactionStatus

string (enum)

Current status of the deposit. Value: CONFIRMING. This status is applicable only to crypto deposits — it directly reflects the blockchain network's confirmation process (waiting for the required block depth). Fiat deposits do not pass through this webhook.

accountId

UUID (string)

Identifier of the account to be credited by the deposit.

quantity

string

Amount of the deposit.

currency

string

Currency code of the deposit (e.g. USDT).

receivedAt

ISO 8601 datetime

Timestamp when the deposit was first received/detected.

clientMemo

string | null

Client-provided memo/reference tag for the deposit, if any.

txHash

string

On-chain transaction hash associated with the deposit.

externalDepositId

UUID (string)

External/third-party reference ID for the deposit.

Last updated