CreatePaymentParams

SIP Protocol API Reference v0.9.0

---

SIP Protocol API Reference / CreatePaymentParams

Interface: CreatePaymentParams

Defined in: @sip-protocol/types/dist/index.d.ts:1494

Parameters for creating a shielded payment

Properties

token

token: Asset | StablecoinSymbol

Defined in: @sip-protocol/types/dist/index.d.ts:1496

Token to transfer

---

amount

amount: bigint

Defined in: @sip-protocol/types/dist/index.d.ts:1498

Amount in token’s smallest units

---

recipientMetaAddress?

optional recipientMetaAddress?: string

Defined in: @sip-protocol/types/dist/index.d.ts:1500

Recipient’s stealth meta-address (for privacy modes)

---

recipientAddress?

optional recipientAddress?: string

Defined in: @sip-protocol/types/dist/index.d.ts:1502

Direct recipient address (for transparent mode)

---

privacy

privacy: PrivacyLevel

Defined in: @sip-protocol/types/dist/index.d.ts:1504

Privacy level

---

viewingKey?

optional viewingKey?: `0x${string}`

Defined in: @sip-protocol/types/dist/index.d.ts:1506

Viewing key (required for compliant mode)

---

sourceChain

sourceChain: ChainId

Defined in: @sip-protocol/types/dist/index.d.ts:1508

Source chain

---

destinationChain?

optional destinationChain?: ChainId

Defined in: @sip-protocol/types/dist/index.d.ts:1510

Destination chain (defaults to sourceChain)

---

purpose?

optional purpose?: PaymentPurpose

Defined in: @sip-protocol/types/dist/index.d.ts:1512

Payment purpose

---

memo?

optional memo?: string

Defined in: @sip-protocol/types/dist/index.d.ts:1514

Optional memo/reference

---

ttl?

optional ttl?: number

Defined in: @sip-protocol/types/dist/index.d.ts:1516

Time to live in seconds (default: 3600 = 1 hour)