Deposit Successful
This event is dispatched after the blockchain has confirmed the incoming transaction.
{
"event": "deposit.successful",
"data": {
"id": "birch5mm",
"type": "coin_address",
"currency": "trx",
"amount": "1.0",
"fee": "0.0",
"txid": "036dc5da61f321a77e8454bdee3acf45bf3fda909395bd00d6daf5950d9a5f34",
"status": "accepted",
"reason": null,
"created_at": "2021-11-16T21:05:22.000Z",
"done_at": null,
"wallet": {
"id": "j5lzsrz7",
"currency": "trx",
"balance": "10.3134710029",
"locked": "0.0",
"staked": "0.0",
"converted_balance": "616.333027133304",
"reference_currency": "ngn",
"is_crypto": true,
"created_at": "2021-04-09T09:48:14.000Z",
"updated_at": "2021-11-16T21:17:19.000Z",
"deposit_address": "TZCDWPRaoMay6GSJpbv6yEk2Nn7nE11XwX",
"destination_tag": null
},
"user": {
"id": "23azi7bj",
"sn": "QDXXIRPXXKS",
"email": "[email protected]",
"reference": null,
"first_name": "Oye",
"last_name": "Olalekan",
"display_name": "appstate",
"created_at": "2021-04-09T09:48:14.000Z",
"updated_at": "2021-04-09T10:54:32.000Z"
},
"payment_transaction": {
"status": "confirmed",
"confirmations": 18,
"required_confirmations": 17
},
"payment_address": {
"id": "efcficfj",
"reference": null,
"currency": "trx",
"address": "TZCDWPRaoMay6GSJpbv6yEk2Nn7nE11XwX",
"destination_tag": null,
"total_payments": "21.82077",
"created_at": "2021-04-09T09:49:59.000Z",
"updated_at": "2021-04-09T09:50:02.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 be 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 the transaction was confirmed. | String |
data.wallet | All information related to the wallet of which 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 balance that currently in transit to be transferred | String |
data.wallet.stacked | The current balance that is stacked. | String |
data.wallet.converted_balance | The converted balance of 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 the wallet was updated | String |
data.wallet.deposit_address | The address at which the user can accept deposit | String |
data.user | All information related to the user of which this transaction is being carried out. | String |
data.user.id | The receivers user id | String |
data.user.sn | The receivers serial number | String |
data.user.email | The receivers email address | String |
data.user.reference | The receivers tag | String |
data.user.first_name | The receivers first name | String |
data.user.last_name | The receivers last name | String |
data.user.display_name | The receivers 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 where 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 transaction has been confirmed by the blockchain. | String |
data.payment_transaction.required_confirmations | The number of times the transaction has to be confirmed before being marked as 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 crypto currency. | String |
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 9 months ago