Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openxswitch.com/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks for Wallet-as-a-Service deposit flow notifies you about incoming deposits and their status.
  • Parent Method: deposit
  • Sub-Methods:
    • pending: Triggered when a deposit is initiated and is awaiting blockchain confirmation.
    • updated: Triggered when the deposit progresses through intermediate confirmations(0,2…).
    • success: Triggered when the deposit is fully confirmed and credited to the wallet

​
Example Payload for Deposit:

{
  "requestId": "04afc1dd8ffae1f6f8c66f96eed0f5",
  "method": "deposit.pending",
  "params": {
    "id": "6817e9bb466d64e005d79d3c",
    "clientTxId": "0545fdb8-2f99-4de7-a114-8643cc3e41dc",
    "destination": "internal_transfer",
    "workspaceId": "67e723ed4b44a4f73dd2e8a2",
    "coin": "USDT",
    "amount": 9,
    "status": "pending",
    "fromWalletId": "6812c4977de20fb535e5bdee",
    "toWalletId": "6812b103908d2d0d49c7ff79",
    "tagMemo": null,
    "updatedAt": "2025-05-04T22:27:06.583Z",
    "createdAt": "2025-05-04T22:27:06.583Z",
    "wallet": {
      "id": "681510b8de0c43fbc4b40c06",
      "clientUserId": "681510b8de0c43fbc4b40c06",
      "email": "email@openxswitch.com",
      "name": "openxswitch-subwallet",
      "asset": {
        "coin": "USDT",
        "balance": 9,
        "frozen": 0,
        "updatedAt": "2025-05-02T18:36:39.814Z",
      },
      "isSubWallet": true,
    }
  }
}

​
Reference

FieldDescriptionType
requestIdUnique ID for the request, used for trackingstring
methodEvent type identifier (e.g., deposit.pending)string
params.idUnique ID of the deposit transactionstring
params.clientTxIdExternal/client-assigned transaction IDstring
params.destinationDestination type (e.g., internal_transfer, on_chain)string
params.workspaceIdID of the associated workspace or organizationstring
params.coinCryptocurrency involved (e.g. USDT)string
params.chainBlockchain protocol used (e.g. TRC20)string
params.amountDeposit amountnumber
params.networkBlockchain network name (e.g. TRON)string
params.hashBlockchain transaction hashstring
params.statusCurrent status (pending, success, etc.)string
params.confirmationNumber of confirmations receivednumber
params.fromAddressBlockchain address sending the depositstring
params.fromWalletIdID of the wallet the funds are coming fromstring
params.toWalletIdID of the wallet receiving the fundsstring
params.tagMemoOptional tag or memo for deposits (used for some chains like XRP, XLM)string | null
params.updatedAtLast updated timestamp of the transactionstring (ISO 8601)
params.createdAtTimestamp when the transaction was createdstring (ISO 8601)
params.wallet.idID of the receiving walletstring
params.wallet.clientUserIdID of the user/client associated with the walletstring
params.wallet.emailEmail associated with the user/walletstring
params.wallet.nameName or label of the walletstring
params.wallet.asset.coinCoin held in the wallet (e.g., USDT)string
params.wallet.asset.balanceAvailable balance in the walletnumber
params.wallet.asset.frozenFrozen balance (e.g., pending withdrawals, locked funds)number
params.wallet.asset.updatedAtLast balance update timestampstring (ISO 8601)
params.wallet.isSubWalletIndicates whether the wallet is a sub-walletboolean