Crypto Deposit Address

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 Name	Status	Description
`deposit_instruction.ready`	READY	Deposit 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": "019d525b-557a-78d7-a9ea-34bc28592ef2",
    "idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
  },
  "data": {
    "status": "READY",
    "customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
    "account_id": "BZ-ABCD-1234",
    "deposit_instruction_id": "019d525b-557a-78d7-a9ea-34bc28592ef2",
    "network": "EVM",
    "address": "0xa9b35d967cd6EE46832aBEE2b9c072CEdA5E54CC",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T12:05:00.000Z"
  }
}

Fields

Field	Type	Description
`status`	string	Always `READY` for this event
`customer_id`	string	The customer ID who owns this deposit instruction
`account_id`	string \| null	Account ID of the customer, or `null` when unavailable
`deposit_instruction_id`	string	Unique identifier for the deposit instruction (wallet)
`network`	string	Blockchain network (e.g. `EVM`, `POLYGON`, `SOLANA`, `TRON`)
`address`	string	On-chain deposit address
`created_at`	string	ISO 8601 timestamp when the instruction was created
`modified_at`	string	ISO 8601 timestamp when the address became ready