API ReferenceCheckout

ACH Checkout

Processes a checkout via ACH.

Authentication

x-coinflow-auth-session-keystring

The session key generated for 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

Path parameters

merchantIdstringRequired

Request

This endpoint expects an object.
subtotalobjectRequired
tokenstringRequired
Token for the bankAccount to be used for the checkout.
fixedFeeobjectOptional
threeDsChallengePreferenceenumOptional
Allowed values:
settlementTypeenumOptional
Allowed values:
customerInfoobjectOptional
webhookInfoobjectOptional
chargebackProtectionDatalist of any or objectsOptional

Purchase *

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

authOnlybooleanOptional

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

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.
transactionstring or nullOptional
  • (Solana): A Base58 encoded transaction

Response

Ok
paymentIdstring
The ID of the payment that was created.

Errors