Skip to main content

Crypto Charge Events

Events related to crypto payments and deposits.

crypto.charge.deposited

Triggered when a deposit is detected on a wallet address monitored by the system.

Available Data

FieldTypeDescription
account_txnstringAccount transaction token
resource_idstringUnique identifier for the charge
amountamountThe amount deposited
wallet_addresswalletThe wallet address where the deposit was received
timestampstringDate and time of the event
successbooleanStatus of the deposit

Token Object

The token field contains nested information about the token deposited:

FieldTypeDescription
token.idtokenUnique identifier of the token
token.symboltoken_symbolSymbol of the token (e.g., USDC, ETH)
token.contract_addressstringSmart contract address of the token
token.decimalsnumericNumber of decimals for the token
token.chainobjectInformation about the blockchain network

crypto.charge.paid

Triggered when a crypto payment is fully confirmed on the blockchain.

Available Data

This event shares the same structure as crypto.charge.deposited.

FieldTypeDescription
account_txnstringAccount transaction token
resource_idstringUnique identifier for the charge
amountamountThe amount paid
wallet_addresswalletThe wallet address where the payment was received
timestampstringDate and time of the event
successbooleanStatus of the payment

Token Object

Includes the same token object details as above.

Example Usage

{
"hook_type": "crypto.charge.paid",
"data": {
"amount": "100.00",
"token": {
"symbol": "USDC",
"chain": { "name": "Polygon" }
}
}
}