Connect SDK

Appearance

@swapped/connect-sdk / core / CashApp

Interface: CashApp ​

Defined in: src/modules/cash-app/cash-app.module.ts:42

Cash App onramp operations.

Available on the client as client.cashApp. Event subscriptions and idle reads work before a session is loaded; create-order actions require a loaded session.

Methods ​

createOrder() ​

createOrder(request): Promise<CashAppOrder>

Defined in: src/modules/cash-app/cash-app.module.ts:197

Create an onramp order; replaces any previous active order.

Parameters ​

request ​

CreateCashAppOrderRequest

Returns ​

Promise<CashAppOrder>

destroy() ​

destroy(): void

Defined in: src/modules/cash-app/cash-app.module.ts:123

Tear down subscriptions owned by this instance.

Returns ​

void

getActiveOrder() ​

getActiveOrder(): CashAppOrder | null

Defined in: src/modules/cash-app/cash-app.module.ts:81

Return the in-memory active order, if any.

Returns ​

CashAppOrder | null

getActiveOrderExpiresAt() ​

getActiveOrderExpiresAt(): number | null

Defined in: src/modules/cash-app/cash-app.module.ts:86

Return the active order expiry timestamp (ms since epoch), if any.

Returns ​

number | null

getCompletedTransactionSummary() ​

getCompletedTransactionSummary(): CashAppCompletedTransactionSummary | null

Defined in: src/modules/cash-app/cash-app.module.ts:96

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

Prefers session transactionData when the provider is Cash App, falling back to the in-memory completed order.

Returns ​

CashAppCompletedTransactionSummary | null

getSupportedAssets() ​

getSupportedAssets(): Promise<CashAppSupportedAsset[]>

Defined in: src/modules/cash-app/cash-app.module.ts:167

Load destination assets for the current session.

Returns ​

Promise<CashAppSupportedAsset[]>

onDepositStatus() ​

onDepositStatus(handler): () => void

Defined in: src/modules/cash-app/cash-app.module.ts:130

Subscribe to raw cashApp:depositStatus websocket events.

Parameters ​

handler ​

(payload) => void

Returns ​

() => void

onOrderCompleted() ​

onOrderCompleted(handler): () => void

Defined in: src/modules/cash-app/cash-app.module.ts:137

Subscribe to active order completion.

Parameters ​

handler ​

(payload) => void

Returns ​

() => void

onOrderExpired() ​

onOrderExpired(handler): () => void

Defined in: src/modules/cash-app/cash-app.module.ts:153

Subscribe to active order expiry.

Parameters ​

handler ​

(payload) => void

Returns ​

() => void

onOrderFailed() ​

onOrderFailed(handler): () => void

Defined in: src/modules/cash-app/cash-app.module.ts:146

Subscribe to active order failure.

Parameters ​

handler ​

(payload) => void

Returns ​

() => void

onOrderReset() ​

onOrderReset(handler): () => void

Defined in: src/modules/cash-app/cash-app.module.ts:160

Subscribe when the local active order is cleared via reset.

Parameters ​

handler ​

(payload) => void

Returns ​

() => void

reset() ​

reset(): void

Defined in: src/modules/cash-app/cash-app.module.ts:110

Clear the local active order and emit cashApp:orderReset. Also used internally when the session refreshes (no event on destroy).

Returns ​

void