Component events

LoopCheckout provides a set of events and callback props to let your application respond to user actions, state changes, and errors.

React Event Props

Prop nameFires when...Payload type
onLoopCryptoCheckoutReadyComponent is readyInitializedEvent
onLoopCryptoCheckoutReadyFailedInitialization failedInitFailedEvent
onLoopCryptoCheckoutStateChangeState changes (see below)LoopCryptoCheckoutStateChangeEvent
onLoopCryptoCheckoutFailedPayment failedLoopCryptoCheckoutFailedEvent
onLoopCryptoCheckoutTokenChangeToken selection changedLoopCryptoCheckoutTokenChangeEvent
onLoopCryptoCheckoutAuthorizationUpdatedAuthorization updatedLoopCryptoCheckoutAuthorizationUpdatedEvent
onLoopCryptoCheckoutAuthorizationConfirmedAuthorization confirmedLoopCryptoCheckoutAuthorizationConfirmedEvent
onLoopCryptoCheckoutCreatedPayment createdLoopCryptoCheckoutCreatedEvent
onLoopCryptoCheckoutConfirmedPayment confirmed on-chainLoopCryptoCheckoutConfirmedEvent

Web Component Events

Event nameFires when...Payload type
readyComponent is readyInitializedEvent
readyfailedInitialization failedInitFailedEvent
statechangeState changes (see below)LoopCryptoCheckoutStateChangeEvent
failurePayment failedLoopCryptoCheckoutFailedEvent
tokenchangeToken selection changedLoopCryptoCheckoutTokenChangeEvent
authorizationupdatedAuthorization updatedLoopCryptoCheckoutAuthorizationUpdatedEvent
authorizationconfirmedAuthorization confirmedLoopCryptoCheckoutAuthorizationConfirmedEvent
createdPayment createdLoopCryptoCheckoutCreatedEvent
confirmedPayment confirmed on-chainLoopCryptoCheckoutConfirmedEvent
walletchangeUser changed walletWalletChangeEvent
networkchangeUser changed networkNetworkChangeEvent

State Change Events

The onLoopCryptoCheckoutStateChange/statechange event provides detailed information about the current state of the payment process. The state property can be one of:

  • idle
  • confirmingBalance
  • confirmingAuthorization
  • updatingAuthorization
  • signingMessage
  • creatingPayment
  • confirmingPayment
  • complete

Each state includes a message and a data object with state-specific details. See the type definitions for full details.

Error Events

The onLoopCryptoCheckoutFailed/failure event provides a type, message, and data object describing the error.