Interface OffRampConfig

Configuration for the OffRampIntegration class.

Provide API keys for the providers you intend to use. Keys are optional so that you can construct the integration with only the providers you need.

Example

const offramp = new OffRampIntegration({
  moonpayApiKey: process.env.MOONPAY_KEY,
  transakApiKey: process.env.TRANSAK_KEY,
  testMode: process.env.NODE_ENV !== 'production',
});
interface OffRampConfig {
    banxaApiKey?: string;
    moonpayApiKey?: string;
    rampApiKey?: string;
    testMode?: boolean;
    transakApiKey?: string;
}

Properties

banxaApiKey? moonpayApiKey? rampApiKey? testMode? transakApiKey?

Properties

OptionalbanxaApiKey

banxaApiKey?: string

Banxa API key. Required for Banxa URLs.

OptionalmoonpayApiKey

moonpayApiKey?: string

Moonpay publishable API key. Required for Moonpay URLs.

OptionalrampApiKey

rampApiKey?: string

Ramp Network host API key. Required for Ramp URLs.

OptionaltestMode

testMode?: boolean

When true, sandbox/staging endpoints are used for all providers that support a test mode (Moonpay, Transak). Defaults to false.

OptionaltransakApiKey

transakApiKey?: string

Transak API key. Required for Transak URLs.

Settings

Member Visibility

On This Page

Properties