v4

latestOpenAPI 3.1.02026-08-08186985685.3 KB

checkout

APA Checkout

Initiates the checkout for an APA Payment

post/checkout/apa/{merchantId}

Path parameters

merchantIdstring required

Headers

x-coinflow-auth-session-keystring required

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

credentialValuestring required

Lowercased email or E.164-formatted phone number, matching credentialType.

emailstring

Email for new customers paying with a phone APA credential. Not needed when credentialType is EMAIL (credentialValue is used as the email).

Response

paymentIdstring required