⚛️ React Environment Properties

Property	Required	Description
wallet	Y	Set the Solana wallet adapter
blockchain	Y	The blockchain for the purchase (solana)
merchantId	Y	The merchant identifier - the target of the checkout (Contact Coinflow support for this)
connection	Y	The Solana connection
env	N	The environment - defaults to `prod`, for testing set it to `staging`
onSuccess	N	Specify a function to run when the checkout process succeeds
transaction	N	Transaction for the user to run which redeems their credits with your smart contract. Create this transaction just like you would for a normal user who has USDC in their account.
partialSigners	N	Keypairs of Partial Signers to sign the transaction with, this is necessary when initializing new accounts as the new account Keypair must sign the transaction.
debugTx	N	Setting this to `true` will sign the transaction with the wallet, and send the transaction with no preflight checks allowing for easier debug of any issues.
token	N	The token to use for the purchase. Defaults to USDC. Currently only supported for the Solana Blockchain.
planCode	N	When a subscription is being purchased, the code of the subscription plan
settlementType	N	The settlement method to use for the proceeds of a purchase. (Credits, USDC, or Bank)
amount	N	Fix the amount of the purchase
webhookInfo	N	Product or transaction based information that you want transmitted when you receive webhooks regarding the purchase (See example)
email	N	Set the default email to use in email entry fields
chargebackProtectionData	N	Information to formulate the chargeback protection logic (See example)
disableApplePay	N	Ability to disable Apple Pay
disableGooglePay	N	Ability to disable Google Pay
customerInfo	N	Additional information about the customer (See example)
supportsVersionedTransactions	N	Instruct the system that you support versioned transactions
rent	N	Specify the blockchain rent amount to add to the total (See example)
origins	N	If rendering the Coinflow component within multiple nested iframes, all ancestors in the chain must be provided as a comma-separated list.

Usage

Base

1 import {useWallet} from '@solana/wallet-adapter-react';
2 const wallet = useWallet();
3 const connection = useConnection();
4 
5 <CoinflowPurchase wallet={wallet} merchantId='<YOUR MERCHANT ID>' env='prod|sandbox|staging' connection={connection} />;

Webhook Info

1 // This is only an example - this is merchant defined
2 const webhookInfo = {
3   productId: 'N421',
4   code: 'PX8242342',
5 }

Chargeback Protection

1 const chargebackProtection = [
2   {
3     productName: 'Widget',
4     productType: 'computingContract',
5     quantity: 1,
6     rawProductData: {
7       description: 'Market best widgets'
8     }
9   } 
10 ]

The product type settings:

inGameProduct
gameOfSkill
dataStorage
computingResources
sportsTicket
eSportsTicket
musicTicket
conferenceTicket
virtualSportsTicket
virtualESportsTicket
virtualMusicTicket
virtualConferenceTicket
alcohol
DLC
subscription
fundACause
realEstate
computingContract
digitalArt
topUp

The raw product data is optional but can be used to provide additional information to assist in the chargeback protection decision.

Customer Info

1 // All the fields are optional
2 const custonmerInfo = {
3   name: 'Suzy Customer',
4   verificationId: '123',
5   displayName: 'Suzy',
6   address: '123 Main St'
7   city: 'Somewhereville',
8   state: 'AK',
9   zip: '99546',
10   country: 'US',
11   ip: '172.10.0.1'
12   lat: '58.2005N',
13   lng: '152.2100W'
14 }

Rent

const rent = { lamports: 100000 }