Webhooks

This page describes the webhook payloads associated with the lifecycle events.

External fiat deposit

Lifecycle

flowchart TD
    A[<a href="#external_fiat_deposit_A">Pending</a>]
    B[<a href="#external_fiat_deposit_B">Completed</a>]
    
    A --> B

Payload

External fiat deposit pending

{
  "event": {
    "orgId": 22959,
    "entity": "BankTransfers",
    "eventType": "BANK_TRANSFER",
    "numRetries": 0,
    "createdAt": "2025-11-13T15:02:45.845Z",
    "updatedAt": "2025-11-13T15:02:45.845Z"
  },
  "data": {
    "from": {
      "orgUserId": "lestrade.1762852159",
      "accountId": "030b99f9-4171-4e17-847e-ca80e6830694",
      "currency": "AED",
      "amount": 1
    },
    "to": { "orgUserId": "lestrade.1762852159" },
    "transferId": "1f0231c8-96ed-49de-a0c5-e013ec554503",
    "status": "PENDING",
    "type": "DEPOSIT",
    "createdAt": "2025-11-13T15:02:45.196Z",
    "updatedAt": "2025-11-13T15:02:45.196Z"
  }
}

External fiat deposit completed

{
  "event": {
    "orgId": 22959,
    "entity": "BankTransfers",
    "eventType": "DEPOSIT_WORKFLOW",
    "numRetries": 0,
    "createdAt": "2025-11-13T15:08:49.802Z",
    "updatedAt": "2025-11-13T15:08:49.802Z"
  },
  "data": {
    "from": {
      "orgUserId": "lestrade.1762852159",
      "accountId": "030b99f9-4171-4e17-847e-ca80e6830694",
      "currency": "AED",
      "amount": 1
    },
    "to": { "orgUserId": "lestrade.1762852159" },
    "transferId": "1f0231c8-96ed-49de-a0c5-e013ec554503",
    "status": "COMPLETED",
    "type": "DEPOSIT",
    "createdAt": "2025-11-13T15:02:45.196Z",
    "updatedAt": "2025-11-13T15:08:49.562Z"
  }
}

External fiat withdrawal

Lifecycle

flowchart TD
    A[<a href="#external_fiat_withdrawal_A">Pending</a>] 

Payload

External fiat withdrawal pending

{
  "event": {
    "orgId": 22959,
    "entity": "BankTransfers",
    "eventType": "BANK_TRANSFER",
    "numRetries": 0,
    "createdAt": "2025-11-13T15:02:45.845Z",
    "updatedAt": "2025-11-13T15:02:45.845Z"
  },
  "data": {
    "from": {
      "orgUserId": "lestrade.1762852159",
      "accountId": "030b99f9-4171-4e17-847e-ca80e6830694",
      "currency": "AED",
      "amount": 1
    },
    "to": { "orgUserId": "lestrade.1762852159" },
    "transferId": "1f0231c8-96ed-49de-a0c5-e013ec554503",
    "status": "PENDING",
    "type": "DEPOSIT",
    "createdAt": "2025-11-13T15:02:45.196Z",
    "updatedAt": "2025-11-13T15:02:45.196Z"
  }
}

External crypto withdrawal

Lifecycle

flowchart TD
    A[<a href="#external_crypto_withdrawal_A">Pending</a>] 
    B[<a href="#external_crypto_withdrawal_B">Completed</a>]
    
    A --> B

Payload

External crypto withdrawal pending

{
  "event": {
    "orgId": 22959,
    "entity": "UserTxns",
    "eventType": "NOTIFICATION",
    "numRetries": 0,
    "createdAt": "2025-11-12T15:04:22.148Z",
    "updatedAt": "2025-11-12T15:04:22.148Z"
  },
  "data": {
    "from": {
      "orgUserId": "lestrade.1762852159",
      "currency": "USDT",
      "amount": 1,
      "blockchainAddress": ""
    },
    "to": {
      "counterPartyId": "dr.watson.1762854189",
      "walletId": "dcfbe88e-fdcf-4609-8bdf-01bfa21625f1",
      "blockchainAddress": "0x5A047dAc44Da3fd4dc7C038aCFD952C70D41781b"
    },
    "txHash": "",
    "chain": "ETHEREUM",
    "transferId": "5b92f509-9349-4999-ab07-e95eb3c8cb9c",
    "status": "QUEUED",
    "type": "WITHDRAWAL",
    "createdAt": "2025-11-12T15:04:11.611Z",
    "updatedAt": "2025-11-12T15:04:21.964Z"
  }
}

External crypto withdrawal completed

{
  "event": {
    "orgId": 22959,
    "entity": "UserTxns",
    "eventType": "NOTIFICATION",
    "numRetries": 0,
    "createdAt": "2025-11-12T15:06:16.880Z",
    "updatedAt": "2025-11-12T15:06:16.880Z"
  },
  "data": {
    "from": {
      "orgUserId": "lestrade.1762852159",
      "currency": "USDT",
      "amount": 1,
      "blockchainAddress": "0xc4FbE8fE2e5461b73544f9e957f21C68Dc8FAea9"
    },
    "to": {
      "counterPartyId": "dr.watson.1762854189",
      "walletId": "dcfbe88e-fdcf-4609-8bdf-01bfa21625f1",
      "blockchainAddress": "0x5A047dAc44Da3fd4dc7C038aCFD952C70D41781b"
    },
    "txHash": "0x15297e6cdcb266d7ab1032fa191c48afe853b695474783eaa00ac10342d4abf5",
    "chain": "ETHEREUM",
    "transferId": "5b92f509-9349-4999-ab07-e95eb3c8cb9c",
    "status": "COMPLETED",
    "type": "WITHDRAWAL",
    "createdAt": "2025-11-12T15:04:11.611Z",
    "updatedAt": "2025-11-12T15:06:16.717Z"
  }
}