Interface PaymentOptions

interface PaymentOptions {
    appId?: string;
    environment: EnvironmentName;
    nvmApiKey: string;
    returnUrl?: string;
    scheme?: PaymentScheme;
    version?: string;
}

Properties

appId? environment nvmApiKey returnUrl? scheme? version?

Properties

Optional appId

appId?: string

The app id. This attribute is optional and helps to associate assets registered into Nevermined with a common identifier.

environment

environment: EnvironmentName

The Nevermined environment to connect to. If you are developing an agent it's recommended to use the "sandbox" environment. When deploying to live use the "live" environment.

nvmApiKey

nvmApiKey: string

The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API. You can get your API key by logging in to the Nevermined App. Required for 'nvm' scheme. Optional for 'visa' scheme.

See

https://nevermined.ai/docs/tutorials/integration/nvm-api-keys

Optional returnUrl

returnUrl?: string

The URL to return to the app after a successful login.

Optional scheme

scheme?: PaymentScheme

The payment scheme to use. Defaults to 'nvm'.

  • 'nvm': Nevermined credit-based payments
  • 'visa': Visa Token Service fiat payments

Optional version

version?: string

The version of the API to use.

Settings

Member Visibility

Theme

On This Page

appIdenvironmentnvmApiKeyreturnUrlschemeversion