Class Payments

Main class that interacts with the Nevermined payments API.

Constructors

constructor

new Payments(options): Payments
Initialize the payments class.
Parameters
- options: PaymentOptions
  The options to initialize the payments class.
Returns Payments
An instance of Payments
Example
```
const payments = new Payments({
  returnUrl: 'https://mysite.example'
  environment: 'staging'
  appId: 'my-app-id'
  version: '1.0.0'
})
```
- Defined in payments.ts:58

Properties

`Optional` accountAddress

accountAddress?: string

`Optional` appId

appId?: string

environment

environment: EnvironmentInfo

`Private` `Optional` nvmApiKey

nvmApiKey?: string

returnUrl

returnUrl: string

`Optional` version

version?: string

Accessors

isLoggedIn

get isLoggedIn(): boolean
Property to check if a user logged in.

Returns boolean
True if the user is logged in.
Example
```
payments.isLoggedIn
```
- Defined in payments.ts:156

Methods

burnCredits

burnCredits(did, nftAmount, nvmApiKey?): Promise<any>
Burn credits for a given DID.
Parameters
- did: string
  The DID (Decentralized Identifier) of the asset.
- nftAmount: string
  The amount of NFT (Non-Fungible Token) credits to burn.
- Optional nvmApiKey: string
  (Optional) The NVM (Nevermined Vault Manager) API key to use for authorization.
Returns Promise<any>
A Promise that resolves to the JSON response from the server.

Throws
Error if the server response is not successful.
- Defined in payments.ts:781

checkoutSubscription

checkoutSubscription(did): void
Redirects the user to the subscription checkout page for the specified DID.
Parameters
- did: string
  The DID (Decentralized Identifier) of the item to be subscribed to.
Returns void
- Defined in payments.ts:738

connect

connect(): void
Initiate the connect flow. The user's browser will be redirected to the Nevermined App login page.

Returns void
Remarks
This is a browser only function.

Example
```
payments.connect()
```
- Defined in payments.ts:78

createCreditsSubscription

createCreditsSubscription(__namedParameters): Promise<{
did: string;
}>
Create a subscription on Nevermined.
Parameters
- __namedParameters: {
      amountOfCredits: number;
      description: string;
      name: string;
      nvmApiKey?: string;
      price: bigint;
      tags?: string[];
      tokenAddress: string;
  }
  - amountOfCredits: number
  - description: string
  - name: string
  - Optional nvmApiKey?: string
  - price: bigint
  - Optional tags?: string[]
  - tokenAddress: string
Returns Promise<{
did: string;
}>
The DID of the newly created subscription.
Example
```
 const { did } = await payments.createSubscription({
   name: "test subscription",
   description: "test",
   price: 10000000n,
   tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
   duration: 30,
   tags: ["test"]
  }
```
- Defined in payments.ts:187

createFile

createFile(__namedParameters): Promise<{
did: string;
}>
Creates a file with the specified parameters.
Parameters
- __namedParameters: {
      amountOfCredits?: number;
      assetType: string;
      curation?: object;
      dataSchema?: string;
      description: string;
      files: object[];
      filesFormat?: string;
      fineTunable?: boolean;
      framework?: string;
      maxCreditsToCharge?: number;
      minCreditsToCharge?: number;
      name: string;
      nvmApiKey?: string;
      programmingLanguage?: string;
      sampleCode?: string;
      subscriptionDid: string;
      tags?: string[];
      task?: string;
      trainingDetails?: string;
      usageExample?: string;
      variations?: string;
  }
  - Optional amountOfCredits?: number
  - assetType: string
  - Optional curation?: object
  - Optional dataSchema?: string
  - description: string
  - files: object[]
  - Optional filesFormat?: string
  - Optional fineTunable?: boolean
  - Optional framework?: string
  - Optional maxCreditsToCharge?: number
  - Optional minCreditsToCharge?: number
  - name: string
  - Optional nvmApiKey?: string
  - Optional programmingLanguage?: string
  - Optional sampleCode?: string
  - subscriptionDid: string
  - Optional tags?: string[]
  - Optional task?: string
  - Optional trainingDetails?: string
  - Optional usageExample?: string
  - Optional variations?: string
Returns Promise<{
did: string;
}>
The promise that resolves to the created file's DID.
- Defined in payments.ts:438

createService

createService(__namedParameters): Promise<{
did: string;
}>
Creates a service.
Parameters
- __namedParameters: {
      amountOfCredits?: number;
      apiDescription?: string;
      authType: "none" | "basic" | "oauth";
      curation?: object;
      description: string;
      endpoints?: Endpoint[];
      integration?: string;
      maxCreditsToCharge?: number;
      minCreditsToCharge?: number;
      name: string;
      nvmApiKey?: string;
      openApiUrl?: string;
      openEndpoints?: string[];
      password?: string;
      sampleLink?: string;
      serviceChargeType: "fixed" | "dynamic";
      subscriptionDid: string;
      tags?: string[];
      token?: string;
      username?: string;
  }
  - Optional amountOfCredits?: number
  - Optional apiDescription?: string
  - authType: "none" | "basic" | "oauth"
  - Optional curation?: object
  - description: string
  - Optional endpoints?: Endpoint[]
  - Optional integration?: string
  - Optional maxCreditsToCharge?: number
  - Optional minCreditsToCharge?: number
  - name: string
  - Optional nvmApiKey?: string
  - Optional openApiUrl?: string
  - Optional openEndpoints?: string[]
  - Optional password?: string
  - Optional sampleLink?: string
  - serviceChargeType: "fixed" | "dynamic"
  - subscriptionDid: string
  - Optional tags?: string[]
  - Optional token?: string
  - Optional username?: string
Returns Promise<{
did: string;
}>
A promise that resolves to the created service DID.
- Defined in payments.ts:328

createTimeSubscription

createTimeSubscription(__namedParameters): Promise<{
did: string;
}>
Create a subscription on Nevermined.
Parameters
- __namedParameters: {
      description: string;
      duration?: number;
      name: string;
      nvmApiKey?: string;
      price: bigint;
      tags?: string[];
      tokenAddress: string;
  }
  - description: string
  - Optional duration?: number
  - name: string
  - Optional nvmApiKey?: string
  - price: bigint
  - Optional tags?: string[]
  - tokenAddress: string
Returns Promise<{
did: string;
}>
The DID of the newly created subscription.
Example
```
 const { did } = await payments.createSubscription({
   name: "test subscription",
   description: "test",
   price: 10000000n,
   tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
   duration: 30,
   tags: ["test"]
  }
```
- Defined in payments.ts:259

downloadFiles

downloadFiles(did, nvmApiKey?): Promise<any>
Downloads files for a given DID asset.
Parameters
- did: string
  The DID of the file.
- Optional nvmApiKey: string
  The NVM API key to use for the request.
Returns Promise<any>
A promise that resolves to the JSON response from the server.
- Defined in payments.ts:687

getAssetDDO

getAssetDDO(did): Promise<any>
Get the DDO for a given DID.
Parameters
- did: string
  The DID of the asset.
Returns Promise<any>
A promise that resolves to the DDO.
- Defined in payments.ts:530

getFileDetails

getFileDetails(did): void
Redirects the user to the file details for the specified DID (Decentralized Identifier).
Parameters
- did: string
  The DID of the file.
Returns void
- Defined in payments.ts:729

getServiceDetails

getServiceDetails(did): void
Redirects the user to the service details for a given DID.
Parameters
- did: string
  The DID (Decentralized Identifier) of the service.
Returns void
- Defined in payments.ts:720

getServiceToken

getServiceToken(did, nvmApiKey?): Promise<{
    token: {
        accessToken: string;
        neverminedProxyUri: string;
    };
}>
Get the service token for a given DID.
Parameters
- did: string
  The DID of the service.
- Optional nvmApiKey: string
Returns Promise<{
    token: {
        accessToken: string;
        neverminedProxyUri: string;
    };
}>
A promise that resolves to the service token.
- Defined in payments.ts:622

getSubscriptionAssociatedFiles

getSubscriptionAssociatedFiles(subscriptionDid): Promise<any>
Get array of files DIDs associated with a subscription.
Parameters
- subscriptionDid: string
Returns Promise<any>
A promise that resolves to array of files DIDs.
- Defined in payments.ts:564

getSubscriptionAssociatedServices

getSubscriptionAssociatedServices(subscriptionDid): Promise<any>
Get array of services DIDs associated with a subscription.
Parameters
- subscriptionDid: string
Returns Promise<any>
A promise that resolves to the array of services DIDs.
- Defined in payments.ts:546

getSubscriptionBalance

getSubscriptionBalance(subscriptionDid, accountAddress?, nvmApiKey?): Promise<{
    balance: bigint;
    isOwner: boolean;
    isSubscriptor: boolean;
    subscriptionType: string;
}>
Get the balance of an account for a subscription.
Parameters
- subscriptionDid: string
  The subscription DID of the service to be published.
- Optional accountAddress: string
  The address of the account to get the balance.
- Optional nvmApiKey: string
  The NVM API key to use for the request.
Returns Promise<{
    balance: bigint;
    isOwner: boolean;
    isSubscriptor: boolean;
    subscriptionType: string;
}>
A promise that resolves to the balance result.
- Defined in payments.ts:584

getSubscriptionDetails

getSubscriptionDetails(did): void
Redirects the user to the subscription details for a given DID.
Parameters
- did: string
  The DID (Decentralized Identifier) of the subscription.
Returns void
- Defined in payments.ts:711

init

init(): void
Method to initialize the class once the user has been logged in. This method should be called has soon as the user has been redirected back to the app (returnUrl).

Returns void
Remarks
This is a browser only function.

Example
```
payments.init()
```
Example: Using react
You may want to use useEffect on the route that matches the passed returnUrl
```
useEffect(() => {
  payments.init()
})
```
- Defined in payments.ts:111

logout

logout(): void
Logout the user by removing the nvm api key.

Returns void
Remarks
This is a browser only function.

Example
```
payments.logout()
```
- Defined in payments.ts:142

mintCredits

mintCredits(did, nftAmount, receiver, nvmApiKey?): Promise<any>
Mint credits for a given DID and transfer them to a receiver.
Parameters
- did: string
  The DID (Decentralized Identifier) of the asset.
- nftAmount: string
  The amount of NFT (Non-Fungible Token) credits to mint.
- receiver: string
  The address of the receiver where the credits will be transferred.
- Optional nvmApiKey: string
  (Optional) The NVM (Nevermined Vault Manager) API key to use for authorization.
Returns Promise<any>
A Promise that resolves to the JSON response from the server.

Throws
Error if the server response is not successful.
- Defined in payments.ts:752

orderSubscription

orderSubscription(subscriptionDid, agreementId?, nvmApiKey?): Promise<{
agreementId: string;
success: boolean;
}>
Orders a subscription.
Parameters
- subscriptionDid: string
  The subscription DID.
- Optional agreementId: string
  The agreement ID.
- Optional nvmApiKey: string
  The NVM API key to use for the request.
Returns Promise<{
agreementId: string;
success: boolean;
}>
A promise that resolves to the agreement ID and a boolean indicating if the operation was successful.
- Defined in payments.ts:656

Class Payments

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Payments

Example

Properties

Optional accountAddress

Optional appId

environment

Private Optional nvmApiKey

returnUrl

Optional version

Accessors

isLoggedIn

Returns boolean

Example

Methods

burnCredits

Parameters

Returns Promise<any>

Throws

checkoutSubscription

Parameters

Returns void

connect

Returns void

Remarks

Example

createCreditsSubscription

Parameters

amountOfCredits: number

description: string

name: string

Optional nvmApiKey?: string

price: bigint

Optional tags?: string[]

tokenAddress: string

Returns Promise<{ did: string; }>

Example

createFile

Parameters

Optional amountOfCredits?: number

assetType: string

Optional curation?: object

Optional dataSchema?: string

description: string

files: object[]

Optional filesFormat?: string

Optional fineTunable?: boolean

Optional framework?: string

Optional maxCreditsToCharge?: number

Optional minCreditsToCharge?: number

name: string

Optional nvmApiKey?: string

Optional programmingLanguage?: string

Optional sampleCode?: string

subscriptionDid: string

Optional tags?: string[]

Optional task?: string

Optional trainingDetails?: string

Optional usageExample?: string

Optional variations?: string

Returns Promise<{ did: string; }>

createService

Parameters

Optional amountOfCredits?: number

Optional apiDescription?: string

authType: "none" | "basic" | "oauth"

Optional curation?: object

description: string

Optional endpoints?: Endpoint[]

Optional integration?: string

Optional maxCreditsToCharge?: number

Optional minCreditsToCharge?: number

`Optional` accountAddress

`Optional` appId

`Private` `Optional` nvmApiKey

`Optional` version

`Optional` nvmApiKey?: string

`Optional` tags?: string[]

Returns Promise<{
did: string;
}>

`Optional` amountOfCredits?: number

`Optional` curation?: object

`Optional` dataSchema?: string

`Optional` filesFormat?: string

`Optional` fineTunable?: boolean

`Optional` framework?: string

`Optional` maxCreditsToCharge?: number

`Optional` minCreditsToCharge?: number

`Optional` nvmApiKey?: string

`Optional` programmingLanguage?: string

`Optional` sampleCode?: string

`Optional` tags?: string[]

`Optional` task?: string

`Optional` trainingDetails?: string

`Optional` usageExample?: string

`Optional` variations?: string

Returns Promise<{
did: string;
}>

`Optional` amountOfCredits?: number

`Optional` apiDescription?: string

`Optional` curation?: object

`Optional` endpoints?: Endpoint[]

`Optional` integration?: string

`Optional` maxCreditsToCharge?: number

`Optional` minCreditsToCharge?: number

`Optional` nvmApiKey?: string

`Optional` openApiUrl?: string

`Optional` openEndpoints?: string[]

`Optional` password?: string

`Optional` sampleLink?: string

`Optional` tags?: string[]

`Optional` token?: string

`Optional` username?: string

Returns Promise<{
did: string;
}>

`Optional` duration?: number

`Optional` nvmApiKey?: string

`Optional` tags?: string[]

Returns Promise<{
did: string;
}>

Returns Promise<{
token: {
accessToken: string;
neverminedProxyUri: string;
};
}>

Returns Promise<{
balance: bigint;
isOwner: boolean;
isSubscriptor: boolean;
subscriptionType: string;
}>

Returns Promise<{
agreementId: string;
success: boolean;
}>