v4

latestOpenAPI 3.1.02026-08-08186985685.3 KB

checkout

Interac e-Transfer Checkout (Saved Contact)

Initiates an Interac e-Transfer payin with a previously saved contact.

post/checkout/interac/token

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

merchantIdstring required

Merchant Identifier

tokenstring required

Token for the account to be used for checkout

Response

paymentIdstring required

The ID of the payment that was created.

emailstring

The email the Interac e-Transfer request was sent to, if applicable.

phonestring

The phone number the Interac e-Transfer request was sent to, if applicable.