Checkout
Last updated
Last updated
This function triggers a modal for the user to confirm the transfer
The checkout function is designed to be the simplest way for your users to purchase items on your website using crypto. Once users complete their purchase, you will receive a webhook at the URL that you configure.
Parameter | Type | Definition |
---|---|---|
None
You can configure a POST Webhook URL in the developer portal that will be invoked once the funds have been transferred to your treasury address.
The following is the format of the webhook call body:
callback?
Action<dynamic>
Function that will be invoked once the transaction is complete
args.treasuryAddress
String
Address to send funds to. This should be your treasury address.
args.cost
String
Amount to send in display units of the currency. So if you want the user to pay 0.5 ETH, pass in '0.5' to this field.
args.currency
Metafi.Unity.Asset
Asset object of the currency you want to accept as the mode of payment.
args.itemDescription
String
Description of the item that you would like users to be shown on the Checkout screen.
args.webhookMetadata?
String
Metadata you want to be sent along with your webhook. Please validate this data on your webhook notification endpoint before using. Eg.
'{productName:"Crew T-shirt",sku:AX19281BN}'