v4

latestOpenAPI 3.1.02026-08-08186985685.3 KB
checkout

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.

post/checkout/zero-authorization/{merchantId}

Path parameters

merchantIdstring required

Headers

x-coinflow-auth-session-keystring required
x-device-idstring
x-coinflow-client-ipstring

Request body

OR

Response

Ok

paymentIdstring required

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 CIT transaction. Only present when card-on-file or MIT settings are enabled on the merchant.