Deposit Successful
This event is dispatched after the blockchain has confirmed the incoming transaction.
{
"event":"deposit.successful",
"data":{
"id":"xofy3d26",
"type":"coin_address",
"currency":"trx",
"amount":"3.0",
"fee":"0.0",
"txid":"c5aee052782c0f9419067b96c7a019ff21a7155878865c85e73ca76085736bab",
"status":"accepted",
"reason":null,
"created_at":"2024-04-02T13:16:17.000Z",
"done_at":null,
"wallet":{
"id":"rk46e2kb",
"currency":"trx",
"balance":"3.0",
"locked":"0.0",
"staked":"0.0",
"user":{
"id":"u2d7imxe",
"sn":"QDXTEJ7YRMF",
"email":"[email protected]",
"reference":null,
"first_name":"test",
"last_name":"user",
"display_name":null,
"created_at":"2024-04-02T13:09:40.000Z",
"updated_at":"2024-04-02T13:09:41.000Z"
},
"converted_balance":"423.75",
"reference_currency":"ngn",
"is_crypto":true,
"created_at":"2024-04-02T13:09:41.000Z",
"updated_at":"2024-04-02T13:17:37.000Z",
"deposit_address":"TKipGdUmft8UsHQsmLi8eaAX63RxxQt3cN",
"destination_tag":null
},
"user":{
"id":"u2d7imxe",
"sn":"QDXTEJ7YRMF",
"email":"[email protected]",
"reference":null,
"first_name":"test",
"last_name":"user",
"display_name":null,
"created_at":"2024-04-02T13:09:40.000Z",
"updated_at":"2024-04-02T13:09:41.000Z"
},
"payment_transaction":{
"status":"confirmed",
"confirmations":1,
"required_confirmations":1
},
"payment_address":{
"id":"mzlhmte6",
"reference":null,
"currency":"trx",
"address":"TKipGdUmft8UsHQsmLi8eaAX63RxxQt3cN",
"network":"trc20",
"user":{
"id":"u2d7imxe",
"sn":"QDXTEJ7YRMF",
"email":"[email protected]",
"reference":null,
"first_name":"test",
"last_name":"user",
"display_name":null,
"created_at":"2024-04-02T13:09:40.000Z",
"updated_at":"2024-04-02T13:09:41.000Z"
},
"destination_tag":null,
"total_payments":null,
"created_at":"2024-04-02T13:12:11.000Z",
"updated_at":"2024-04-02T13:12:12.000Z"
}
}
}
Field | Description | Type |
---|---|---|
event | The webhook event action that triggered the webhook, e.g. DEPOSIT.SUCCESSFUL. | String |
data | All information related to this specific webhook. | Object |
data.id | The id attribute of the deposit transaction. | String |
data.type | This can be either coin_address or internal. | String |
data.currency | This is the ticker sign of the crypto | String |
data.amount | The deposit amount that is being moved. | String |
data.fee | Transaction fee charged by the network. | String |
data.txId | Transaction ID from the blockchain. | String |
data.status | Transaction status this could be either submitted or confirmed. | String |
data.reason | Transaction note. | String |
data.created_at | The date the transaction was submitted. | String |
data.done_at | The data of the transaction was confirmed. | String |
data.wallet | All information related to the wallet this transaction is being carried out. | Object |
data.wallet.id | The ID of the receiving wallet. | String |
data.wallet.balance | The current balance of the receiving wallet. | String |
data.wallet.currency | The currency of the receiving wallet. | String |
data.wallet.balance | The current balance of the receiving wallet. | String |
data.wallet.locked | The current locked balance. | String |
data.wallet.stacked | The current balance is stacked. | String |
data.wallet.user | All information related to the user of which this transaction is being carried out. | Object |
data.wallet.converted_balance | The converted balance of the wallet to the reference currency | String |
data.wallet.reference_currency | The current reference currency of the wallet | String |
data.wallet.is_crypto | Identifies if the current wallet is crypto or fiat. | Bool |
data.wallet.created_at | The date the wallet was initially created | String |
data.wallet.updated_at | The data in the wallet was updated | String |
data.wallet.deposit_address | The address at which the user can accept a deposit | String |
data.user | All information related to the user of which this transaction is being carried out. | Object |
data.user.id | The receiver user-id | String |
data.user.sn | The receiver serial number | String |
data.user.email | The receiver's email address | String |
data.user.reference | The receivers tag | String |
data.user.first_name | The receiver's first name | String |
data.user.last_name | The receiver's last name | String |
data.user.display_name | The receiver username or display name | String |
data.user.created_at | The date at which the user was created. | String |
data.user.updated_at | The date at which the user attributes were updated. | String |
data.payment_transaction | The payment transaction object | Object |
data.payment_transaction.status | The current status of the transaction, confirmed or unconfirmed. | String |
data.payment_transaction.confirmations | The number of times the blockchain has confirmed the transaction. | String |
data.payment_transaction.required_confirmations | The number of times the transaction has to be confirmed before being marked as a successful transaction. | String |
data.payment_address | The payment address object | Object |
data.payment_address.id | The id of the payment address. | String |
data.payment_address.currency | The currency of the wallet | String |
data.payment_address.address | The deposit address of the cryptocurrency. | String |
data.payment_address.network | The network of which the deposit was made. | String |
data.payment_address.user | All information related to the user of which this transaction is being carried out. | Object |
data.payment_address.total_payments | The total balance of the wallet | String |
data.payment_address.created_at | The datetime the wallet was created. | String |
data.payment_address.updated_at | The datetime the wallet was updated. | String |
Updated about 1 month ago