GuidesAPI ReferenceChangelog
API Reference

Digital Wallets

Webhook events for crypto deposit instruction (wallet address) provisioning status changes.

Events

Only deposit_instruction.ready provisioning notifications are currently published. The API does not currently publish deposit_instruction.failed. Retrieve the deposit instruction to check its PENDING or READY status.

Event NameStatusDescription
deposit_instruction.readyREADYDeposit wallet address provisioned and ready for use

deposit_instruction.ready

Triggered when a deposit wallet address has been successfully provisioned on the blockchain and is ready to receive deposits.

Payload

{
  "event_name": "deposit_instruction.ready",
  "resource": {
    "type": "deposit_instructions",
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
  },
  "data": {
    "status": "READY",
    "customer_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "account_id": "BZ-ABCD-1234",
    "deposit_instruction_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "network": "EVM",
    "address": "0x1234567890abcdef1234567890abcdef12345678",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T12:05:00.000Z"
  }
}

Fields

FieldTypeDescription
statusstringAlways READY for this event
customer_idstringThe customer ID who owns this deposit instruction
account_idstring | nullAccount ID of the customer, or null when unavailable
deposit_instruction_idstringUnique identifier for the deposit instruction (wallet)
networkstringBlockchain network (e.g. EVM, POLYGON, SOLANA, TRON)
addressstringOn-chain deposit address
created_atstringISO 8601 timestamp when the instruction was created
modified_atstringISO 8601 timestamp when the address became ready