@coinflowlabs/react NPM

Coinflow React

Withdraw Usage

import {useWallet} from '@solana/wallet-adapter-react';
const wallet = useWallet();
const connection = useConnection();

<CoinflowWithdraw wallet={wallet} merchantId='<YOUR MERCHANT ID>' env='prod|sandbox|staging' connection={connection} />;

Props:

wallet: The Solana Wallet Adapter Wallet
merchantId: Your Merchant ID (Contact Coinflow support for this)
connection: Solana Connection
env (optional): This defaults to prod
- For testing set to staging
onSuccess (optional): function to run when the withdrawal process is successful
lockAmount (optional): Whether to let the user select the amount to withdraw or to disable the input
amount (optional): The amount to withdraw - required if lockAmount=true
tokens (optional): Define a list to filter the available tokens
lockDefaultToken (optional): Only allow the default token to be used
email (optional): Set the default email to be used in entry fields
bankAccountLinkRedirect (optional): The URL to be used for bank account setup
additionalWallets (optional): Define additional wallets to assign to the user
usePermit (optional): Pass as false to disable permit message signing for EVM and use approve transactions
transactionSigner (optional): Public Key of the wallet which will actually execute the withdrawal transaction. Must be associated with the same withdrawer as the main wallet.

Purchase Usage

import {useWallet} from '@solana/wallet-adapter-react';
const wallet = useWallet();
const connection = useConnection();

<CoinflowPurchase wallet={wallet} merchantId='<YOUR MERCHANT ID>' env='prod|sandbox|staging' connection={connection} />;

Props:

wallet: The Solana Wallet Adapter Wallet
merchantId: Your Merchant ID (Contact Coinflow support for this)
connection: Solana Connection
env (optional): This defaults to prod
- For testing set to staging
onSuccess (optional): function to run when the purchase process is successful
transaction (optional): 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 (optional): 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 (optional): 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 (optional): The token to use for the purchase. Defaults to USDC. Currently only supported for the Solana Blockchain.
planCode (optional): When a subscription is being purchased, the code of the subscription plan.
settlementType (optional): The settlement method to use for the proceeds of a purchase. (Credits, USDC, or Bank)
amount (optional): Fix the amount of purchase
webhookInfo (optional): Product or transaction based information that you want transmitted when you receive webhooks regarding the purchase
email (optional): Set the default email to use in email entry fields
chargebackProtectionData (optional):
disableApplePay (optional): Ability to disable Apple Pay
disableGooglePay (optional): Ability to disable Google Pay
customerInfo (optional): Additional information about the customer
rent (optional, Solana only): Specify the blockchain rent amount to add to the total
nativeSolToConvert (optional, Solana only): Specify the amount of native SOL to convert wSOL for the purchase
jwtToken (optional): A JWT token which encodes verified checkout parameters to prevent spoofing of arguments.
supportEmail (optional): Your business support email address to use for support inquiries

Utils

CoinflowUtils

getFeePayer - Return the PublicKey of the Coinflow Fee Payer

Changelog

4.5.1

Added sessionKey authentication mechanism to CoinflowWithdraw

4.5.0

Added sessionKey authentication mechanism to CoinflowPurchase

4.4.1

Added onError callback to Apple Pay and Google Pay buttons

4.4.0

Added overlay to digital wallet buttons to make the loading time 0

4.3.1

CoinflowPurchaseV2 component added for a modernized purchase flow

4.3.0

Added arbitrum blockchain support

4.2.10

Added getWalletFromEmail function to CoinflowUtils

4.2.9

Added placeholder CSS to card form elements

4.2.8

Custom fonts for card elements

4.2.5

Allow custom taker on reservoir transactions

4.2.4

Memoize styles on credit card inputs

4.1.0

Add base blockchain support
Added AuthOnly parameter to CoinflowPurchase

4.0.0

Require signMessage on wallets for stronger withdraw authentication

3.1.11

Added new ChargebackProtectionData productTypes

3.1.10

Added waitForHash to EvmTransactionData

3.1.9

Added theme props to Coinflow components for easy color control

3.1.8

Added orderId option for reservoir items

3.1.7

Added nativeSolToConvert for Solana transactions

3.1.5

Settlement type param for settlement control

3.1.4

Customer info param for added reporting capabilities

3.1.2

Added disableGooglePay and disableApplePay props to CoinflowPurchase

3.1.1

Added support for EVM NFT purchases

3.0.1

Update to CoinflowPurchaseProtection to make partnerId required

3.0.0

Breaking Changes

Added supportsVersionedTransactions to CoinflowWithdraw allowing platforms with wallets that support versioned transactions to Withdraw non-USDC/EuroE tokens in a single transaction with better prices.
This is enabled to true by default. If you are using a wallet that does not support versioned transactions, you must set supportsVersionedTransactions in CoinflowWithdraw to false.

2.7.1

Added new property lockDefaultToken which locks the withdrawal option to the users default currency (USDC or EUROe)

2.7.0

Added support for paying solana rent for a transaction
Added camera support document verification

2.6.1

Added built in support for SSR which fixes a "window not defined" error.

2.6.0

Added support for Apple Pay and Google Pay

2.5.0

Added the CoinflowCardForm component which allows merchants to collect credit card information from their users in a PCI compliant way. Tokenize it, and then utilize the remainder of Coinflow's APIs.