Class DelegationAPI

API for managing payment methods and delegations (card and crypto).

Hierarchy

BasePaymentsAPI
- DelegationAPI

Constructors

constructor

new DelegationAPI(options: PaymentOptions): DelegationAPI
Parameters
- options: PaymentOptions
Returns DelegationAPI
Inherited from BasePaymentsAPI.constructor
- Defined in src/api/base-payments.ts:69

Properties

`Protected`accountAddress

accountAddress: string

`Protected` `Optional`appId

appId?: string

`Protected`currentOrganizationId

currentOrganizationId: string | null

`Protected`environment

environment: EnvironmentInfo

`Protected`environmentName

environmentName: EnvironmentName

`Protected`heliconeApiKey

heliconeApiKey: string

isBrowserInstance

isBrowserInstance: boolean = true

`Protected`nvmApiKey

nvmApiKey: string

`Protected`returnUrl

returnUrl: string

`Protected`scheme

scheme: "nvm"

`Protected` `Optional`version

version?: string

Methods

createDelegation

createDelegation(
payload: CreateDelegationPayload,
): Promise<CreateDelegationResponse>
Create a new delegation for any supported provider (stripe, braintree, visa, or erc4337).

Note: Visa delegations require a per-delegation device-binding ceremony (FIDO/passkey + assuranceData) that must be performed in the browser via the Nevermined webapp. The SDK can list and consume an already- created Visa delegation but cannot create one programmatically.
Parameters
- payload: CreateDelegationPayload
  The delegation creation parameters
Returns Promise<CreateDelegationResponse>
The created delegation ID (and token for card delegations)
- Defined in src/x402/delegation-api.ts:183

getAccountAddress

getAccountAddress(): string | undefined
It returns the account address associated with the NVM API Key used to initialize the Payments Library instance.

Returns string | undefined
The account address extracted from the NVM API Key
Inherited from BasePaymentsAPI.getAccountAddress
- Defined in src/api/base-payments.ts:125

`Protected`getBackendHTTPOptions

getBackendHTTPOptions(
    method: string,
    body?: any,
    extraHeaders?: Record<string, string>,
): any
Internal
Returns the HTTP options required to query the backend.
Parameters
- method: string
  HTTP method.
- Optionalbody: any
  Optional request body.
- OptionalextraHeaders: Record<string, string>
  Optional per-call header overrides. Use { 'X-Current-Org-Id': orgId } to target a specific workspace for one call without mutating the instance-level pin.
Returns any
HTTP options object.
Inherited from BasePaymentsAPI.getBackendHTTPOptions
- Defined in src/api/base-payments.ts:162

getEnvironmentName

getEnvironmentName(): EnvironmentName
Returns the environment name used to initialize the Payments instance.

Returns EnvironmentName
The environment name (e.g. 'sandbox', 'live')
Inherited from BasePaymentsAPI.getEnvironmentName
- Defined in src/api/base-payments.ts:117

getOrganizationId

getOrganizationId(): string | null
Returns the current organization context applied to every authenticated backend request via the X-Current-Org-Id header.

null means "no pinned workspace" — the backend falls back to the caller's API-key tag or most-recent active membership.

Returns string | null
Inherited from BasePaymentsAPI.getOrganizationId
- Defined in src/api/base-payments.ts:136

`Protected`getPublicHTTPOptions

getPublicHTTPOptions(
    method: string,
    body?: any,
): {
    body?: string;
    headers: { Accept: string; "Content-Type": string };
    method: string;
}
Internal
Get HTTP options for public backend requests (no authorization header). Converts body keys from snake_case to camelCase for consistency.
Parameters
- method: string
  HTTP method
- Optionalbody: any
  Optional request body (keys will be converted to camelCase)
Returns {
    body?: string;
    headers: { Accept: string; "Content-Type": string };
    method: string;
}
HTTP options object
Inherited from BasePaymentsAPI.getPublicHTTPOptions
- Defined in src/api/base-payments.ts:201

getPurchasingPower

getPurchasingPower(): Promise<PurchasingPower>
Get the agent's purchasing power — accessible cards, active delegations, and combined remaining budget.

Returns Promise<PurchasingPower>
- Defined in src/x402/delegation-api.ts:151

listDelegations

listDelegations(options?: ListOptions): Promise<DelegationListResponse>
List the user's existing delegations. When accessible: true, only usable delegations (Active, non-expired, with budget) are returned.
Parameters
- Optionaloptions: ListOptions
Returns Promise<DelegationListResponse>
- Defined in src/x402/delegation-api.ts:141

listPaymentMethods

listPaymentMethods(options?: ListOptions): Promise<PaymentMethodSummary[]>
List the user's enrolled payment methods for card delegation. When accessible: true, only cards accessible to the requesting API key are returned.
Parameters
- Optionaloptions: ListOptions
Returns Promise<PaymentMethodSummary[]>
- Defined in src/x402/delegation-api.ts:131

`Protected`parseNvmApiKey

parseNvmApiKey(): { accountAddress: string; heliconeApiKey: string }
Parses the NVM API Key to extract the account address.

Returns { accountAddress: string; heliconeApiKey: string }
Throws
PaymentsError if the API key is invalid.
Inherited from BasePaymentsAPI.parseNvmApiKey
- Defined in src/api/base-payments.ts:99

setOrganizationId

setOrganizationId(organizationId: string | null): void
Sets the organization context applied to every subsequent authenticated backend request via the X-Current-Org-Id header.

Pass null to clear the pin and fall back to the backend default.
Parameters
- organizationId: string | null
  Org ID (e.g. org-…) or null to clear.
Returns void
Inherited from BasePaymentsAPI.setOrganizationId
- Defined in src/api/base-payments.ts:148

updatePaymentMethod

updatePaymentMethod(
paymentMethodId: string,
dto: UpdatePaymentMethodDto,
): Promise<PaymentMethodSummary>
Update a payment method's alias and/or allowed API keys.
Parameters
- paymentMethodId: string
- dto: UpdatePaymentMethodDto
Returns Promise<PaymentMethodSummary>
- Defined in src/x402/delegation-api.ts:191

`Static`getInstance

getInstance(options: PaymentOptions): DelegationAPI
Parameters
- options: PaymentOptions
Returns DelegationAPI
- Defined in src/x402/delegation-api.ts:123

Class DelegationAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DelegationAPI

Properties

ProtectedaccountAddress

Protected OptionalappId

ProtectedcurrentOrganizationId

Protectedenvironment

ProtectedenvironmentName

ProtectedheliconeApiKey

isBrowserInstance

ProtectednvmApiKey

ProtectedreturnUrl

Protectedscheme

Protected Optionalversion

Methods

createDelegation

Parameters

Returns Promise<CreateDelegationResponse>

getAccountAddress

Returns string | undefined

ProtectedgetBackendHTTPOptions

Parameters

Returns any

getEnvironmentName

Returns EnvironmentName

getOrganizationId

Returns string | null

ProtectedgetPublicHTTPOptions

Parameters

Returns { body?: string; headers: { Accept: string; "Content-Type": string }; method: string;}

getPurchasingPower

Returns Promise<PurchasingPower>

listDelegations

Parameters

Returns Promise<DelegationListResponse>

listPaymentMethods

Parameters

Returns Promise<PaymentMethodSummary[]>

ProtectedparseNvmApiKey

Returns { accountAddress: string; heliconeApiKey: string }

Throws

setOrganizationId

Parameters

Returns void

updatePaymentMethod

Parameters

Returns Promise<PaymentMethodSummary>

StaticgetInstance

Parameters

Returns DelegationAPI

Settings

On This Page

`Protected`accountAddress

`Protected` `Optional`appId

`Protected`currentOrganizationId

`Protected`environment

`Protected`environmentName

`Protected`heliconeApiKey

`Protected`nvmApiKey

`Protected`returnUrl

`Protected`scheme

`Protected` `Optional`version

`Protected`getBackendHTTPOptions

`Protected`getPublicHTTPOptions

Returns {
body?: string;
headers: { Accept: string; "Content-Type": string };
method: string;
}

`Protected`parseNvmApiKey

`Static`getInstance