Appearance
@swapped/connect-sdk / core / ExchangePay
Interface: ExchangePay
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:66
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:339
Close the active order.
Returns
Promise<void>
createOrder()
createOrder(
request):Promise<ExchangePayOrder>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:256
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:106
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:111
Return the active order expiry timestamp (ms since epoch), if any.
Returns
number | null
getActiveOrderTimeLeft()
getActiveOrderTimeLeft(
now?):ExchangePayOrderTimeLeft|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:119
Remaining time on the active order as hours / minutes / seconds. null when there is no active order.
Parameters
now?
number = ...
Returns
ExchangePayOrderTimeLeft | null
getCompletedTransactionSummary()
getCompletedTransactionSummary():
ExchangePayCompletedTransactionSummary|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:145
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:310
Fetch status for the active order.
Returns
Promise<ExchangePayOrderStatus>
getPreferredCurrencyToReceive()
getPreferredCurrencyToReceive():
TokenSymbol|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:214
Default Exchange Pay receive token from session settings. null when no session is loaded or the field is absent.
Returns
TokenSymbol | null
getSupportedCurrencies()
getSupportedCurrencies(
__namedParameters):Promise<ExchangePaySupportedCurrency[]>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:220
Load supported currencies for a provider.
Parameters
__namedParameters
GetExchangePaySupportedCurrenciesRequest
Returns
Promise<ExchangePaySupportedCurrency[]>
isActiveOrderExpired()
isActiveOrderExpired(
now?):boolean
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:135
Whether the active order has expired. false when there is no order.
Parameters
now?
number = ...
Returns
boolean
isExchangePayProvider()
isExchangePayProvider(
provider):provider is ExchangePayProvider
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:159
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:193
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:202
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:186
Subscribe to active order updates.
Parameters
handler
(payload) => void
Returns
() => void
reset()
reset():
void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:166
Clear the active order (also used when the session refreshes).
Returns
void