Events

Subscribe to Cash App order lifecycle signals.

When to use

Navigate to success, show failed or expired UI. For the current order you can also read getActiveOrder().

Methods

Method	Event	When
onOrderCompleted	cashApp:orderCompleted	Payment succeeded ({ order })
onOrderFailed	cashApp:orderFailed	Payment failed ({ order, payload })
onOrderExpired	cashApp:orderExpired	Local timer hit expiresAt ({ order })
onDepositStatus	cashApp:depositStatus	Optional raw status (pending / success / failure)

Each returns an unsubscribe function. You can also use client.on('cashApp:…') — see Events (Core).

Prefer onOrderCompleted / onOrderFailed / onOrderExpired for UI. Use onDepositStatus only when you need the raw status payload.

Example

const offs = [
  client.cashApp.onOrderCompleted(({ order }) => {
    // success screen — then getCompletedTransactionSummary()
    console.log('paid', order.id);
  }),
  client.cashApp.onOrderFailed(({ order }) => {
    // failed UI — create a new order or go back
    console.log('failed', order.id);
  }),
  client.cashApp.onOrderExpired(({ order }) => {
    // expired UI — create a new order or go back
    console.log('expired', order.id);
  }),
];

// later
offs.forEach(off => off());

Related

• Orders & checkout for create / checkout fields
• Expiry for countdown helpers
• Errors for failure mapping