@swapped/connect-sdk / react / UseExchangePayOrderResult

Type Alias: UseExchangePayOrderResult

UseExchangePayOrderResult = object

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:21

Result of useExchangePayOrder.

Properties

closeOrder

closeOrder: () => Promise<void>

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:40

Close / cancel the active order.

Returns

Promise<void>

---

createOrder

createOrder: () => Promise<ExchangePayOrder>

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:38

Create an order using the current ExchangePayContextProvider selection.

Returns

Promise<ExchangePayOrder>

---

error

error: Error | null

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:50

Last create / close / fetch error, or null.

---

expiredOrder

expiredOrder: ExchangePayOrder | null

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:28

Order that most recently expired. Set when exchangePay:orderExpired fires; cleared on create / close / reset.

---

formattedOrder

formattedOrder: ExchangePayFormattedOrder | null

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:55

Display-ready order with formatted amounts. Fiat values fill in after the live quote loads.

---

getOrder

getOrder: () => Promise<ExchangePayOrderStatus>

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:42

Fetch the latest order status from the API.

Returns

Promise<ExchangePayOrderStatus>

---

isClosing

isClosing: boolean

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:46

Whether closeOrder is in progress.

---

isCompleted

isCompleted: boolean

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:34

Whether the order has completed successfully.

---

isCreating

isCreating: boolean

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:44

Whether createOrder is in progress.

---

isExpired

isExpired: boolean

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:36

Whether the order has expired.

---

isFetchingStatus

isFetchingStatus: boolean

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:48

Whether getOrder is in progress.

---

order

order: ExchangePayOrder | null

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:23

Active order created for this flow, or null when none.

---

status

status: ExchangePayOrderStatusValue | null

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:30

High-level order status value (e.g. pending / completed), or null.

---

transaction

transaction: ExchangePayOrderStatus | null

Defined in: src/react/exchange-pay/hooks/useExchangePayOrder/useExchangePayOrder.ts:32

Full order-status payload from the last update or fetch, or null.