Appearance
@swapped/connect-sdk / core / ExchangePay
Interface: ExchangePay
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:68
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:383
Close the active order.
Returns
Promise<void>
createOrder()
createOrder(
request):Promise<ExchangePayOrder>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:299
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:111
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:116
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:124
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:176
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
getFormattedOrder()
getFormattedOrder():
ExchangePayFormattedOrder|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:149
Display-ready active order (all order fields + formatted amounts). Each fiatValue is null and exchangeRateLoading is true until the live quote loads. null when there is no active order.
Returns
ExchangePayFormattedOrder | null
getMaxAmountFiat()
getMaxAmountFiat(
provider):number
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:201
Maximum fiat amount (currently USD) for an Exchange Pay provider. Uses a paymentMethods override when present, otherwise the remote limits.exchangePayMaxAmountFiat default.
Parameters
provider
Returns
number
getOrder()
getOrder():
Promise<ExchangePayOrderStatus>
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:354
Fetch status for the active order.
Returns
Promise<ExchangePayOrderStatus>
getPreferredCurrencyToReceive()
getPreferredCurrencyToReceive():
TokenSymbol|null
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:256
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:262
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:140
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:190
Whether the provider is a supported Exchange Pay provider.
Parameters
provider
IntegrationProvider | undefined
Returns
provider is ExchangePayProvider
onFormattedOrderUpdated()
onFormattedOrderUpdated(
handler): () =>void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:162
Subscribe to formatted-order quote updates.
Parameters
handler
(payload) => void
Returns
() => void
onOrderCompleted()
onOrderCompleted(
handler): () =>void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:235
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:244
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:228
Subscribe to active order updates.
Parameters
handler
(payload) => void
Returns
() => void
reset()
reset():
void
Defined in: src/modules/exchange-pay/exchange-pay.module.ts:206
Clear the active order (also used when the session refreshes).
Returns
void