API ReferenceCheckout

Get Checkout Link

Gets a checkout link for the UserID that can be embedded in vanilla iframe or the user can be redirected to

Authentication

x-coinflow-auth-user-idstring

The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

OR
x-coinflow-auth-walletstring

The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

x-coinflow-auth-blockchainstring

The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Headers

x-coinflow-submerchant-idstringOptional

Request

This endpoint expects an object.
emailstringOptional
blockchainenumOptional

Coinflow Types *

threeDsChallengePreferenceenumOptional
Allowed values:
settlementTypeenumOptional
Allowed values:
customerInfoobjectOptional
webhookInfoobjectOptional
chargebackProtectionDatalist of any or objectsOptional

Purchase *

subtotalobjectOptional
planCodestringOptional
presentmentenumOptional
accountFundingTransactionobjectOptional
Used for Account Funding Transactions
authOnlybooleanOptional

Only authorize the purchase. This will not actually capture the payment.(default: false)

allowedPaymentMethodslist of enumsOptional
The payment methods displayed on the UI. If omitted, all available payment methods will be displayed.
isZeroAuthorizationbooleanOptional
partialUsdcCheckedbooleanOptional

If true, pre-checks the partial USDC payment checkbox when USDC balance is available. If false or undefined, maintains default behavior (unchecked).

deviceIdstringOptional
The DeviceID gotten from the Coinflow SDK: https://docs.coinflow.cash/guides/checkout/fraud-protection/chargeback-protection/implement-chargeback-protection#how-to-add-chargeback-protection nSureSDK.getDeviceId()
supportEmailstringOptional
Your company email address that the customer can contact.
originslist of stringsOptional
If rendering the Coinflow component within multiple nested iframes, all ancestors in the chain must be provided as a comma-separated list. Example: Primary origin that will be interacting with the Coinflow iFrame: foo.com Subsequent origins that will render foo.com: bar.com The origin array would then be: [https://foo.com,https://bar.com]
themeobjectOptional
fixedFeeobjectOptional
feePercentagedoubleOptional0-100

If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is taken from the subtotal amount.

redemptionCheckbooleanOptional

(Solana only) If a transaction involved in the purchase, should payment be checked for redemption

customerUsdcTransferDataobjectOptional

Customer signed USDC transferWithAuthorization data for dual-source payments Used for combined USDC + Credit Card payments on EVM chains

transactionDataobjectOptional

(EVM only) if you want to execute an EVM transaction on a successful purchase, you can pass a transaction request here.

Gas fees for the transaction will be automatically calculated and added to the total charged to the customer. Optionally the merchant can opt to pay for these gas fees.

rentobjectOptional

(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.

authentication3DSobjectOptional
destinationAuthKeystringOptional
If utilizing USDC settlement to addresses other than your main merchant settlement address. Utilize this destinationAuthKey which is a JWT encoded with the information for which address to send the USDC to.
destinationstringOptional
If utilizing USDC settlement to addresses other than your main merchant settlement address. Utilize this destination which is the address to send the USDC to.
idempotencyKeystringOptional

(Optional) Idemptotency Key to pass to prevent multiple purchases with the same checkout link. If not passed, a random one will be generated for you automatically.

standaloneLinkConfigobjectOptional

Response

Ok