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 internal transfers notify you about fund movements between wallets or sub-wallets within the OpenXSwitch system.
  • Parent Method: internal_transfer
  • Sub-Methods:
    • initiated: Triggered when a internal transfer request is initiated but not yet processed.
    • completed: Triggered when the internal transfer is successfully processed.

​
Example Payload for Transfer:

{
  "requestId": "f71516a1a53acbc5a999ef9b6edda4",
  "method": "internal_transfer.initiated",
  "params": {
    "id": "68180c09b19304fc881991c2",
    "clientTxId": "57337eed-eef3-4123-9e83-83107c4dafa3",
    "coin": "USDT",
    "amount": 9,
    "status": "pending",
    "networkFee": 0,
    "fromWalletId": "6812b103908d2d0d49c7ff79",
    "toWalletId": "6812c4977de20fb535e5bdee",
    "workspaceId": "656abf1e4b5f5e0012345678",
    "createdAt": "2025-05-05T00:53:29.206Z",
    "updatedAt": "2025-05-05T00:53:29.206Z",
    "wallet": {
      "id": "6812b103908d2d0d49c7ff79",
      "clientUserId": null,
      "email": "email@openxswitch.com",
      "name": "openxswitch-subwallet",
      "asset": {
        "coin": "USDT",
        "balance": 9,
        "frozen": 0,
        "updatedAt": "2025-05-04T23:58:20.494Z"
      },
      "isSubWallet": false
    }
  }
}

​
Reference

FieldDescriptionType
requestIdUnique identifier for the eventstring
methodEvent type, always internal_transfer.initiatedstring
params.idInternal transfer IDstring
params.clientTxIdOptional client-assigned transaction IDstring
params.coinCryptocurrency used (e.g. USDT)string
params.amountAmount transferrednumber
params.statusCurrent status of the transfer (e.g. pending)string
params.networkFeeFee applied to the transfernumber
params.fromWalletIdSender’s wallet IDstring
params.toWalletIdRecipient’s wallet IDstring
params.workspaceIdID of the associated workspace or organizationstring
params.createdAtTimestamp when the transfer was createdstring (ISO 8601)
params.wallet.idSender wallet ID (same as fromWalletId)string
params.wallet.clientUserIdOptional user ID of the senderstring or null
params.wallet.emailEmail associated with the sender walletstring
params.wallet.nameWallet name or labelstring
params.wallet.asset.coinCoin type stored in the walletstring
params.wallet.asset.balanceWallet’s current balancenumber
params.wallet.asset.frozenAmount frozen in the walletnumber
params.wallet.asset.updatedAtLast update time for wallet asset infostring (ISO 8601)
params.wallet.isSubWalletIndicates if the wallet is a sub-walletboolean