Appearance
@swapped/connect-sdk / core / ExchangePay
Interface: ExchangePay
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:62
Exchange Pay operations.
Available on the client as client.exchangePay. Event subscriptions and idle reads work before a session is loaded; create/close order actions require a loaded session.
Methods
closeOrder()
closeOrder():
Promise<void>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:286
Close the active order.
Returns
Promise<void>
createOrder()
createOrder(
request):Promise<ExchangePayOrder>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:206
Create a deposit order; closes any previous closable active order first.
Parameters
request
Returns
Promise<ExchangePayOrder>
getActiveOrder()
getActiveOrder():
ExchangePayOrder|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:101
Return the in-memory active order, if any.
Returns
ExchangePayOrder | null
getActiveOrderExpiresAt()
getActiveOrderExpiresAt():
number|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:106
Return the active order expiry timestamp (ms since epoch), if any.
Returns
number | null
getCompletedTransactionSummary()
getCompletedTransactionSummary():
ExchangePayCompletedTransactionSummary|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:116
Display-ready summary of the last completed Exchange Pay order.
Prefers the in-memory completed order transaction, falling back to session transactionData when the provider is an Exchange Pay provider.
Returns
ExchangePayCompletedTransactionSummary | null
getOrder()
getOrder():
Promise<ExchangePayOrderStatus>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:257
Fetch status for the active order.
Returns
Promise<ExchangePayOrderStatus>
getSupportedCurrencies()
getSupportedCurrencies(
__namedParameters):Promise<ExchangePaySupportedCurrency[]>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:170
Load supported currencies for a provider.
Parameters
__namedParameters
GetExchangePaySupportedCurrenciesRequest
Returns
Promise<ExchangePaySupportedCurrency[]>
isExchangePayProvider()
isExchangePayProvider(
provider):provider is ExchangePayProvider
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:130
Whether the provider is a supported Exchange Pay provider.
Parameters
provider
IntegrationProvider | undefined
Returns
provider is ExchangePayProvider
onOrderCompleted()
onOrderCompleted(
handler): () =>void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:152
Subscribe to active order completion.
Parameters
handler
(payload) => void
Returns
() => void
onOrderExpired()
onOrderExpired(
handler): () =>void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:161
Subscribe to active order expiry.
Parameters
handler
(payload) => void
Returns
() => void
onOrderUpdated()
onOrderUpdated(
handler): () =>void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:145
Subscribe to active order updates.
Parameters
handler
(payload) => void
Returns
() => void
reset()
reset():
void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:137
Clear the active order (also used when the session refreshes).
Returns
void