@usdctofiat/offramp
@usdctofiat/offramp / OfframpParams
Interface: OfframpParams
Defined in: packages/offramp-sdk/src/types.ts:26
Properties
amount
amount:
string
Defined in: packages/offramp-sdk/src/types.ts:28
USDC amount as decimal string, min 1.
currency
currency:
CurrencyEntry
Defined in: packages/offramp-sdk/src/types.ts:32
Fiat currency — use CURRENCIES.EUR etc.
idempotencyKey?
optionalidempotencyKey?:string
Defined in: packages/offramp-sdk/src/types.ts:51
Optional per-wallet key to replay the first successful result for 10 minutes.
Browser-only: the replay cache is backed by sessionStorage and is a no-op
in Node/worker runtimes (no duplicate protection there). It is honored only
by the Offramp class (createDeposit) / the useOfframp hook — the
standalone offramp() function ignores it. For server-side dedup, call
deposits(walletAddress) and reuse an existing open deposit before creating
a new one (the SDK's own resume behavior does this for the delegation step).
identifier
identifier:
string
Defined in: packages/offramp-sdk/src/types.ts:34
Platform-specific identifier (username, email, IBAN).
integratorId?
optionalintegratorId?:string
Defined in: packages/offramp-sdk/src/types.ts:40
Optional SDK-only integrator metadata for telemetry attribution.
otcTaker?
optionalotcTaker?:string
Defined in: packages/offramp-sdk/src/types.ts:36
Optional: restrict the deposit to this taker wallet (OTC private order).
platform
platform:
PlatformEntry
Defined in: packages/offramp-sdk/src/types.ts:30
Payment platform — use PLATFORMS.REVOLUT etc.
referralId?
optionalreferralId?:string
Defined in: packages/offramp-sdk/src/types.ts:38
Optional SDK-only referral metadata for telemetry attribution.