API ReferenceCheckout

Apple Pay Checkout

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

Headers

x-device-idstringOptional

Request

This endpoint expects an object.
subtotalobjectRequired
applePayPaymentobjectRequired
Apple Pay Payment received from the Apple Pay SDK Details can be found here: https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment
fixedFeeobjectOptional
threeDsChallengePreferenceenumOptional
Allowed values:
statementDescriptorstringOptional
If the bank supports dynamic descriptors, this will appear on the customer's statement.
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.
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.

presentmentenumOptional
accountFundingTransactionobjectOptional
Used for Account Funding Transactions
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.

Response

Ok
paymentIdstring
The ID of the payment that was created.

Errors