Interface OffRampWithdrawParams

Inputs for executing an off-ramp withdrawal against a quote.

interface OffRampWithdrawParams {
    bankAccountId: string;
    cryptoAmount: string;
    cryptoCurrency: string;
    fiatAmount: string;
    fiatCurrency: string;
    quoteToken: string;
}

Properties

bankAccountId: string

Id of the destination bank account (from OffRamp.banks). Required.

cryptoAmount: string

Crypto amount being sold (must match the quote), as a decimal string. Required.

cryptoCurrency: string

Crypto asset being sold (must match the quote). Required.

fiatAmount: string

Fiat amount to be received (from the quote), as a decimal string. Required.

fiatCurrency: string

Fiat currency being received (must match the quote). Required.

quoteToken: string

The quote token returned by OffRamp.quote. Time-limited. Required.