Interface OffRampUrlParams

Parameters for generating an off-ramp URL via OffRampIntegration.getOffRampUrl.

An off-ramp URL redirects the user to a provider's page where they sell crypto from gAddress and receive fiat currency.

interface OffRampUrlParams {
    amount: string;
    asset: string;
    fiatCurrency: string;
    gAddress: string;
    provider: OffRampProvider;
}

Properties

amount: string

Amount of crypto the user wants to sell (as a decimal string).

asset: string

Crypto asset the user is selling.

'XLM', 'USDC'

fiatCurrency: string

ISO 4217 fiat currency the user wants to receive.

'USD', 'EUR'

gAddress: string

Source G-address from which the user will send crypto to the provider. Must be a valid Stellar G-address (Ed25519 public key).

Provider to use for this transaction.