API ReferenceCheckout

Create Pix Payment

Initiates a Pix payment order. Returns a BR code used to pay the order. Must be paid before the returned expiration date (5 minutes).

Authentication

x-coinflow-auth-session-keystring

The session key generated for the end user - see https://docs.coinflow.cash/reference/authentication

OR
x-coinflow-auth-walletstring

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

x-coinflow-auth-blockchainstring

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

OR
x-coinflow-auth-user-idstring

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

x-coinflow-auth-blockchainstring

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

Request

This endpoint expects an object.
subtotalobjectRequired
emailstringRequiredformat: "(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))"
merchantIdstringRequired
Merchant Identifier
fixedFeeobjectOptional
customerInfoobjectOptional
webhookInfoobjectOptional
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.

jwtTokenstringOptional
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.
settlementTypeenumOptional
Allowed values:
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.

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.

Response

Ok
paymentIdstring
The ID of the payment that was created.
brCodestring
QR code to display to complete payment.
quoteobject
expiresstring
BR Code expiration