API ReferenceCheckout

Card On File Checkout

Processes a Card On File Transaction using a saved card from a previous Customer Initiated Transaction (CIT).

This endpoint can only be used if the customer is actively involved in the purchase flow and has explicitly granted their authorization to charge their card.

Authentication

x-coinflow-auth-user-idstring
The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
x-coinflow-auth-user-idstring
The external identifier 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
Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
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

Headers

x-device-idstringOptional
x-coinflow-client-ipstringOptional

Request

This endpoint expects an object.
CardOnFileCheckoutArgsWithOriginalPaymentIdobjectRequired
Card on file using the original payment ID
OR
CardOnFileCheckoutArgsWithTokenobjectRequired
Card on file using a token

Response

Ok
paymentIdstring
The ID of the payment that was created.

Errors

403
Forbidden Error
410
Gone Error
412
Precondition Failed Error