Jump to Content

Crypto Deposit Address

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

Events

Event Name	Status	Description
`deposit_instruction.ready`	READY	Deposit wallet address provisioned and ready for use
`deposit_instruction.failed`	FAILED	Deposit wallet address provisioning failed

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	Account ID of the customer
`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

deposit_instruction.failed

Triggered when a deposit wallet address fails to provision on the blockchain.

Payload

{
  "event_name": "deposit_instruction.failed",
  "resource": {
    "type": "deposit_instructions",
    "id": "019d525c-b1d0-7940-8868-387b46ddd924",
    "idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
  },
  "data": {
    "status": "FAILED",
    "customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
    "account_id": "BZ-ABCD-1234",
    "deposit_instruction_id": "019d525c-b1d0-7940-8868-387b46ddd924",
    "network": "SOLANA",
    "address": "",
    "created_at": "2024-01-22T12:00:00.000Z",
    "modified_at": "2024-01-22T12:01:00.000Z"
  }
}

Fields

Field	Type	Description
`status`	string	Always `FAILED` for this event
`customer_id`	string	The customer ID who owns this deposit instruction
`account_id`	string	Account ID of the customer
`deposit_instruction_id`	string	Unique identifier for the deposit instruction (wallet)
`network`	string	Blockchain network (e.g. `EVM`, `POLYGON`, `SOLANA`, `TRON`)
`address`	string	Empty string when provisioning failed before address generation
`created_at`	string	ISO 8601 timestamp when the instruction was created
`modified_at`	string	ISO 8601 timestamp when the provisioning failed

Common Failure Reasons

Deposit instruction provisioning may fail due to:

Wallet provider (Palisade) service unavailable
Blockchain network congestion or timeout
Vault configuration error
Quorum policy not met for wallet creation