Skip to content

@checkout-kit/react / UseCheckoutResult

Interface: UseCheckoutResult ​

Extends ​

  • CheckoutSnapshot

Properties ​

PropertyModifierTypeDescriptionInherited from
actionreadonlyPaymentAction | nullThe action waiting to be run, or the one currently running.CheckoutSnapshot.action
attemptreadonlynumberHow many actions this payment has already been through.CheckoutSnapshot.attempt
capabilitiesreadonlyProviderCapabilities | nullWhat the current provider can do, once it has loaded. null until then. For rendering and validation only - whether to ask for a card at all. What a payment needs is decided by the action the provider returns.CheckoutSnapshot.capabilities
enginepublicCheckoutEngine--
errorreadonlyPaymentError | null-CheckoutSnapshot.error
intentreadonlyPaymentIntent | null-CheckoutSnapshot.intent
isBusypublicbooleanA request is in flight. action_pending is not busy: the shopper is acting.-
isLockedpublicbooleanNothing about the payment may be changed any more. What a form disables on.-
isSettledpublicbooleanNothing further will happen without the shopper starting over.-
phasereadonlyCheckoutPhase-CheckoutSnapshot.phase
providerIdreadonlystring | null-CheckoutSnapshot.providerId

Apache-2.0 · Headless engine, provider adapters and runnable examples.