Skip to main content

Webhook

This section contains the webhook notification events for Bitcoin wallets.

info

Click here to learn how to verify the authenticity of webhook notifications.

Receive Tokens

This notification is sent when a receive transaction is found in the mempool, when its included in a block and when its confirmed on our platform.

  • amount: The amount of tokens transacted.
  • block_number: The number of the block containing the transaction. Empty if not in a block yet.
  • currency: The currency_id of tokens transacted.
  • event: RECEIVE
  • guid: Unique transaction ID on the platform.
  • network: The network of the wallet that triggered the event. bitcoin.
  • recipient: The address that received the tokens.
  • service_fee: The amount paid in service fees from the amount.
  • status: The status of the transaction. PENDING or SUCCESS.
  • timestamp: The unix timestamp of when the notification was emitted.
  • tx_hash: The transaction hash on the blockchain.
  • wallet: The ID of the wallet that triggered the event.

Send Tokens

This notification is sent when a send transaction is included in a block and when its confirmed on our platform.

  • amount: The amount of tokens transacted.
  • block_number: The number of the block containing the transaction.
  • comment: Optional comment only visible to wallet owner.
  • currency: The currency_id of tokens transacted.
  • event: SEND
  • guid: Unique transaction ID on the platform.
  • network: The network of the wallet that triggered the event. bitcoin.
  • network_fee: The amount paid in network fees. (Paid in BTC)
  • recipient: The address that received the tokens.
  • sender: The address that sent the tokens.
  • service_fee: The amount paid in service fees. Only collected if status is SUCCESS.
  • status: The status of the transaction. PENDING, SUCCESS or FAILED.
  • timestamp: The unix timestamp of when the notification was emitted.
  • tx_hash: The transaction hash on the blockchain.
  • wallet: The ID of the wallet that triggered the event.