Skip to content

Summary ​

Display-ready result of the last completed Cash App onramp.

When to use ​

On the success screen after cashApp:orderCompleted, or when session transaction data already reflects a completed Cash App deposit.

Methods ​

MethodReturnsPurpose
getCompletedTransactionSummary()CashAppCompletedTransactionSummary | nullSend / receive amounts, fees, destination, tx hash

Always two legs: fiat in (send) and crypto out (receive). May be null after reload / restartSession() even if payment completed on the server.

Example ​

ts
const summary = client.cashApp.getCompletedTransactionSummary()

if (summary) {
  console.log(summary.provider)
  console.log(summary.send.amount, summary.send.currency)
  console.log(summary.receive.amount, summary.receive.currency)
  console.log(summary.receive.network)
  console.log(summary.fees)
  console.log(summary.from, summary.to)
  console.log(summary.transaction?.hash, summary.sessionId)
}

await client.restartSession() // required before another payment

Or react to completion:

ts
client.cashApp.onOrderCompleted(() => {
  const summary = client.cashApp.getCompletedTransactionSummary()
  // show success UI
})

Errors ​

This getter does not throw. If it returns null, there is no completed summary available yet.

The next createOrder can hit SESSION_NOT_ACTIVE if you did not call restartSession() - see Errors.