Sign in

v3

latestOpenAPI 3.1.02026-08-06186981679.4 KB
checkout

Crypto Payin

Initiates a payment where the customer is paying with Crypto

post/checkout/crypto

Headers

x-coinflow-auth-user-idstring required

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

Request body

feePercentagenumber double

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.

jwtTokenstring

This is a token encoding the parameters for the request. Allows purchase parameters to be verified to prevent manipulation when the checkout page is presented to the user.

stellarTransactionstring

(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.

For transaction purchases, pass the base64 XDR string created using .toXDR() on a transaction built with generated TypeScript bindings (e.g., NftClientWrapper.buildNftPurchaseTx).

For direct USDC transfers (no merchant transaction), omit this field or pass undefined.

Gas fees for the transaction will be automatically calculated and added to the total charged to the customer.

settlementType'Credits' | 'USDC'
destinationAuthKeystring

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.

overrideChargebackProtectionDecisionboolean
doNotReviewChargebackProtectionboolean
emailstring required
chainstring required

The name of the chain to perform the crypto payin on.

tokenstring required

The symbol of the token to execute the payin with.

Response

Ok

sessionIdstring required

The session/payment identifier

depositAddressstring required

The deposit address where funds should be sent

paymentChainNamestring required

Human-readable chain name

paymentCurrencySymbolstring required

The token symbol

paymentAmountstring required

The amount to pay in the selected currency

chainLogoUrlstring required
currencyLogoUrlstring required
paymentIdstring required