deposit

​

Subscription Request

​

Stream Response

​

Subscription Example

{
  "method": "subscribe",
  "topics": [
    "deposit"
  ],
  "ticket": "97794B95-AFE7-454F-81B0-9109112548C2"
}

​

Stream Response Example - Cryptocurrency Deposit

{
  "id": 10,
  "topic": "deposit",
  "timestamp": 1673271591764,
  "body": {
    "id": "08799ECC-F6B1-498E-B89C-2A05E6A181B9",
    "user_id": "5B6A43AE-8012-402D-966F-87CF64689535",
    "amount": 1,
    "currency_code": "ETH",
    "status": "confirmed",
    "is_internal": false,
    "hash": "0x79704c92b31061b8f51e26486d6454aff3e3c58aa0d51f0f803d6fd063be8100",
    "address": "3PQhyXH1EZs1bZ23ZafqQDyeViqxn5KdXN",
    "network": "ethereum",
    "create_date": "2023-01-09T13:39:24.057Z",
    "update_date": "2023-01-09T13:39:25.001Z",
    "confirmation_date": "2023-01-09T13:39:25.001Z"
  }
}

​

Stream Response Example - Fiat Deposit

{
  "id": 11,
  "topic": "deposit",
  "timestamp": 1673271591764,
  "body": {
    "id": "08799ECC-F6B1-498E-B89C-2A05E6A181B9",
    "user_id": "5B6A43AE-8012-402D-966F-87CF64689535",
    "amount": 1000,
    "currency_code": "BRL",
    "status": "confirmed",
    "is_internal": true,
    "hash": null,
    "address": null,
    "network": null,
    "create_date": "2023-01-09T13:39:24.057Z",
    "update_date": "2023-01-09T13:39:25.001Z",
    "confirmation_date": "2023-01-09T13:39:25.001Z"
  }
}

​

Deposit Status Lifecycle

pending → confirmed
    ↓
  failed

• pending: Deposit received but not yet confirmed
• confirmed: Deposit finalized and added to your balance
• failed: Deposit failed and was not credited

​

Deposit Types

​

External Deposits

• From external blockchain addresses
• Include transaction hash
• May take time to confirm (network dependent)
• Bitcoin: ~10 minutes (6 confirmations)
• Ethereum: ~2 minutes (12 confirmations)

​

Internal Transfers

• Between BitcoinTrade accounts
• No blockchain involved
• Confirm immediately
• Marked with is_internal: true

​

Key Fields

​

Blockchain Networks

​

Timing by Currency

​

Usage Notes

• Authentication Required: Requires valid ticket from WebSocket authentication
• Real-time Updates: Receive notification when deposit is received
• Multiple Notifications: Receive updates as status changes (pending → confirmed)
• Complete Info: All deposit details provided
• Address Stored: Can view which address was used

​

Pending vs Confirmed

• Pending: Received but not yet verified on blockchain
• Confirmed: Fully confirmed and added to balance
• Recommended: Wait for confirmed status before trading

​

Use Cases

• Balance Updates: Get notified when deposits arrive
• Fund Tracking: Monitor incoming funds
• Deposit Confirmation: Confirm deposit success
• Accounting: Record deposits for bookkeeping
• Alert System: Notify users of large deposits
• Fund Reconciliation: Reconcile with bank records