Skip to main content

Webhook

This section contains the webhook notification events for Ripple wallets.

info

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

Receive Tokens​

This notification is sent when a wallet receives tokens.

  • amount: The amount of tokens transacted.
  • block_number: The number of the block containing the transaction.
  • currency: The currency_id of tokens transacted.
  • destination_tag: The destination tag attached to the transaction on the blockchain.
  • event: RECEIVE
  • guid: Unique transaction ID on the platform.
  • invoice_id: The invoice ID attached to the transaction on the blockchain.
  • network: The network of the wallet that triggered the event. ripple.
  • recipient: The address that received the tokens.
  • sender: The address that sent the tokens.
  • service_fee: The amount paid in service fees from the amount.
  • 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 wallets send transaction is confirmed on the blockchain.

  • 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.
  • destination_tag: The destination tag attached to the transaction on the blockchain.
  • event: SEND
  • guid: Unique transaction ID on the platform.
  • invoice_id: The invoice ID attached to the transaction on the blockchain.
  • network: The network of the wallet that triggered the event. ripple.
  • network_fee: The amount paid in network fees. (Paid in XRP)
  • 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. 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.