Callbacks

When instantiating theAzimuthBuyWithCryptoclass, an optional onPaymentSuccessCallback and onWalletConnectCallback functions can be passed as parameters to the constructor. Below we detail the structure and possible usage for each of these.

onPaymentSuccessCallback

This function is triggered when a customer successfully completes a transaction and is provided with a JSON-formatted event object containing all the relevant details about the transaction. This enables you to access and manipulate transaction data for delivering acknowledgments, sending customer invoices or credits, or any other customized functionality in your application. The callback function must have a void type, which means it has a signature of the form(txnDetails) => ().

txnDetails

The txnDetailsobject passed to the onPaymentSuccessCallback function upon successful transaction processing is a JSON-formatted object with the following properties:

{ 
    "method": <method>,
    "senderAddress": <senderAddress>,
    "chainName": <chainName>,
    "tokenSymbol": <tokenSymbol>,
    "txnTokensAmount": <txnTokensAmount>,
    "tokenUsdPrice": <tokenUsdPrice>,
    "txnUsdPrice": <txnUsdPrice>,
    "txnUtcTimestamp": <txnUtcTimestamp>,
    "tokenContractAddress": <tokenContractAddress>,
    "transactionHash": <transactionHash>
}

Where the objects properties are defined as:

Property Name	Type	Values	Description
method	String (Enum)	"NATIVE_COIN_TXN" | "ERC20_TXN"	The type of token used for the transaction
senderAddress	String	Any valid wallet address	The wallet address of the user who initiated the transaction
chainName	String (Enum)	"Ethereum" | "Polygon" | "Binance" | "Arbitrum" | "Optimism" | "Base" | "Avalanche" | "Fantom"	The name of the blockchain network used to process the transaction
tokenSymbol	String (Enum)	"ETH" | "BNB" | "MATIC" | "AVAX" | "FTM" | "OETH" | "ARB-ETH" | "USDT" | "USDC" | "WETH" | "DAI" | "WBNB" | "BUSD" | "WAVAX" | "WFTM" | "LINK" | "XRP" | "OP" | "USDbC"	The symbol of the token used for payment
txnTokensAmount	String	Any valid string representation of a positive float	The amount of tokens paid in the transaction
tokenUsdPrice	String	Any valid string representation of a positive float	The USD price for 1 unit of the token used for payment
txnUsdPrice	String	Any valid string representation of a positive float	The total USD price of the transaction, calculated as (txnTokensAmount * tokenUsdPrice)
txnUtcTimestamp	Long	Any valid Unix timestamp	The UTC timestamp of the transaction
tokenContractAddress	String	Any valid token contract address	The blockchain's contract address of the used token. Empty for NATIVE_COIN_TXN, contains the token contract address for ERC20_TXN
transactionHash	String	Any valid transaction hash	The unique hash of the transaction generated by the blockchain network

onWalletConnectCallback

This function is triggered when a customer successfully connects his wallet into your website and is provided with a JSON-formatted event object containing the connected wallet address. This enables you to both authenticate and identify the customer using his unique wallet address, and by that automate different actions such as presenting the user his current credits count, or any other customized functionality. The callback function must have a void type, which means it has a signature of the form(walletDetails) => ().

walletDetails

The walletDetailsobject passed to the onWalletConnectCallback function upon successful wallet connection is a JSON-formatted object with the following properties:

{ 
    "walletAddress": <walletAddress>,
}

Where the objects properties are defined as:

Property Name	Type	Values	Description
walletAddress	String	Any valid wallet address	The wallet address that was connected