SettleOrderParams

Defined in: src/settlement/settle-order.ts:34

Parameters for settleOrder.

Properties

amount

readonly amount: bigint

Defined in: src/settlement/settle-order.ts:38

The exact amount, in the token’s smallest unit (JPYC has 18 decimals). Must be positive.

---

details

readonly details: `0x${string}`

Defined in: src/settlement/settle-order.ts:42

The commitment to the order’s contents — see hashOrderDetails. 32 bytes.

---

expectedRef?

readonly optional expectedRef?: `0x${string}`

Defined in: src/settlement/settle-order.ts:49

The order reference the caller expects — typically the one the order’s issuer quoted. When given, it is compared with the locally computed reference BEFORE anything is sent, and a difference throws SettlementOrderRefMismatchError. Pass it whenever the reference came from someone else: it is what stops an agent paying for something other than what it agreed to.

---

merchant

readonly merchant: `0x${string}`

Defined in: src/settlement/settle-order.ts:36

The order’s recipient.

---

nowSeconds?

readonly optional nowSeconds?: number

Defined in: src/settlement/settle-order.ts:56

The current time in unix seconds. Defaults to the system clock; injectable for tests.

---

validUntil

readonly validUntil: bigint

Defined in: src/settlement/settle-order.ts:40

Unix seconds after which the order can no longer be paid. Enforced on chain.

---

waitForReceipt?

readonly optional waitForReceipt?: boolean

Defined in: src/settlement/settle-order.ts:54

If false, returns immediately after submitting the UserOp without waiting for the bundler receipt. Defaults to true.