API ReferenceCheckout

Zero Authorization

Performs an Authorization transaction on a Card for $0.00 to be validated and stored for future use.

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-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
x-coinflow-client-ipstringOptional

Request

This endpoint expects an object.
ZeroAuthorizationCheckoutArgsNewCardWithoutReasonobjectRequired
OR
ZeroAuthorizationCheckoutArgsSavedCardWithoutReasonobjectRequired

Response

Ok
paymentIdstring
The ID of the payment that was created.
authorizationExpirationstring

The datetime when this authorization expires and subsequent card-on-file or merchant-initiated transactions can no longer be made. After this time, the card must be re-authorized via another zero-authorization or CIT transaction.

Errors

403
Forbidden Error
410
Gone Error
412
Precondition Failed Error