Interface ProviderConfig

Capability and configuration data for a single off-ramp/on-ramp provider. Returned by OffRampIntegration.getProviderConfig.

interface ProviderConfig {
    feePercentage: string;
    maxAmount: string;
    minAmount: string;
    provider: OffRampProvider;
    supportedAssets: string[];
    supportedCountries: string[];
    supportedFiatCurrencies: string[];
    testModeAvailable: boolean;
}

Properties

feePercentage maxAmount minAmount provider supportedAssets supportedCountries supportedFiatCurrencies testModeAvailable

Properties

feePercentage

feePercentage: string

Provider fee as a percentage string (e.g. "4.5" means 4.5%). Does not include network fees.

maxAmount

maxAmount: string

Maximum transaction amount in fiat (as a decimal string, e.g. "50000").

minAmount

minAmount: string

Minimum transaction amount in fiat (as a decimal string, e.g. "20").

provider

provider: OffRampProvider

Provider identifier.

supportedAssets

supportedAssets: string[]

Cryptocurrency asset codes supported by this provider on Stellar.

Example

['XLM', 'USDC', 'ETH', 'BTC']

supportedCountries

supportedCountries: string[]

ISO 3166-1 alpha-2 country codes where this provider operates.

Example

['US', 'GB', 'DE']

supportedFiatCurrencies

supportedFiatCurrencies: string[]

ISO 4217 fiat currency codes accepted by this provider.

Example

['USD', 'EUR', 'GBP']

testModeAvailable

testModeAvailable: boolean

Whether this provider's sandbox/test environment is available.

Settings

Member Visibility

On This Page

Properties