Skip to main content

Interface: OnramperWidgetRequest

gSwap SDK 2.0.0-rc.4

gSwap SDK 2.0.0-rc.4 / OnramperWidgetRequest

Interface: OnramperWidgetRequest

Defined in: packages/gswap-sdk/dist/index.d.ts:2244

The request of Onramper.generateWidgetUrl: the fields of the swap backend's GenerateWidgetUrlDto, no others (the backend refuses a field it does not know). A field left out is the backend's default (mode buy, defaultFiat USD, defaultAmount 100, sellDefaultAmount 1, onlyCryptoNetworks gala, defaultPaymentMethod creditcard, networkPrefix gala_gala).

Properties​

defaultAmount?​

optional defaultAmount?: number

Defined in: packages/gswap-sdk/dist/index.d.ts:2250

The fiat amount the widget opens with (the backend accepts 15 to 15 000, at most 2 decimals).

defaultCrypto?​

optional defaultCrypto?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2255

defaultFiat?​

optional defaultFiat?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2248

defaultPaymentMethod?​

optional defaultPaymentMethod?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2254

excludeFiat?​

optional excludeFiat?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2259

excludePaymentMethods?​

optional excludePaymentMethods?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2257

isAddressEditable?​

optional isAddressEditable?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2260

mode?​

optional mode?: "swap" | "buy" | "sell"

Defined in: packages/gswap-sdk/dist/index.d.ts:2247

networkPrefix?​

optional networkPrefix?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2261

onlyCryptoNetworks?​

optional onlyCryptoNetworks?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2253

onlyFiat?​

optional onlyFiat?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2258

onlyPaymentMethods?​

optional onlyPaymentMethods?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2256

sellDefaultAmount?​

optional sellDefaultAmount?: number

Defined in: packages/gswap-sdk/dist/index.d.ts:2252

The crypto amount a sell opens with (0.000001 to 1 000 000, at most 18 decimals).

walletAddress​

walletAddress: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2246

The wallet that receives the crypto, sent as given (the backend wants an 0x Ethereum address).