Get Checkout Link

post

https://api-sandbox.coinflow.cash/api/checkout/link

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

blockchain

string

enum

Coinflow Types *

Allowed:

threeDsChallengePreference

string

enum

Allowed:

customerInfo

chargebackProtectionData

array of objects

Purchase *

chargebackProtectionData

subtotal

required

settlementType

string

enum

Allowed:

planCode

string

authOnly

boolean

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

presentment

string

enum

accountFundingTransaction

object

Used for Account Funding Transactions

allowedPaymentMethods

array of objects

The payment methods displayed on the UI. If omitted, all available payment methods will be displayed.

allowedPaymentMethods

partialUsdcChecked

boolean

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

deviceId

string

The DeviceID gotten from the Coinflow SDK: https://docs.coinflow.cash/docs/implement-chargeback-protection#how-to-add-chargeback-protection

window?.nSureSDK?.getDeviceId()

supportEmail

string

Your company email address that the customer can contact.

origins

array of strings

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]

origins

theme

object

standaloneLinkConfig

object

idempotencyKey

string

(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.

destination

string

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.

fixedFee

object

webhookInfo

object

feePercentage

double

0 to 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.

redemptionCheck

boolean

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

customerUsdcTransferData

object

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

transactionData

(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.

rent

object

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

destinationAuthKey

string

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.

authentication3DS

Response

200Ok