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:23

Properties

`Protected`accountAddress

accountAddress: string

`Protected` `Optional`appId

appId?: string

`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: PaymentScheme

`Protected` `Optional`version

version?: string

Methods

createDelegation

createDelegation(
payload: CreateDelegationPayload,
): Promise<CreateDelegationResponse>
Create a new delegation for either stripe or erc4337 provider.
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:150

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:73

`Protected`getBackendHTTPOptions

getBackendHTTPOptions(method: string, body?: any): any
Internal
Returns the HTTP options required to query the backend.
Parameters
- method: string
  HTTP method.
- Optionalbody: any
  Optional request body.
Returns any
HTTP options object.
Inherited from BasePaymentsAPI.getBackendHTTPOptions
- Defined in src/api/base-payments.ts:84

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:65

`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:105

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:124

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:114

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:104

`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:47

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:158

`Static`getInstance

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

Class DelegationAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DelegationAPI

Properties

ProtectedaccountAddress

Protected OptionalappId

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

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

updatePaymentMethod

Parameters

Returns Promise<PaymentMethodSummary>

StaticgetInstance

Parameters

Returns DelegationAPI

Settings

On This Page

`Protected`accountAddress

`Protected` `Optional`appId

`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