Faremeter API

---

Faremeter API / types/src / client

​

client

​

Type Aliases

​

PaymentExecer

PaymentExecer = object

Defined in: packages/types/src/client.ts:21 Payment execer - the primary interface for payment execution. Uses requirements with the amount field.

​

Properties

requirements

requirements: x402PaymentRequirements

Defined in: packages/types/src/client.ts:22

​

Methods

exec()

exec(): Promise<PaymentExecResult>

Defined in: packages/types/src/client.ts:23

Returns

Promise<PaymentExecResult>

---

​

PaymentExecerV1

PaymentExecerV1 = object

Defined in: packages/types/src/client.ts:46

​

Deprecated

Use PaymentExecer instead

​

Properties

requirements

requirements: x402PaymentRequirements

Defined in: packages/types/src/client.ts:47

​

Methods

exec()

exec(): Promise<PaymentExecResult>

Defined in: packages/types/src/client.ts:48

Returns

Promise<PaymentExecResult>

---

​

PaymentExecResult

PaymentExecResult = object

Defined in: packages/types/src/client.ts:13

​

Properties

payload

payload: object

Defined in: packages/types/src/client.ts:14

---

​

PaymentHandler()

PaymentHandler = (context, accepts) => Promise<PaymentExecer[]>

Defined in: packages/types/src/client.ts:30 Payment handler - the primary interface for payment handlers. Receives requirements and returns execers.

​

Parameters

context

RequestContext

accepts

x402PaymentRequirements[]

​

Returns

Promise<PaymentExecer[]>

---

​

PaymentHandlerV1()

PaymentHandlerV1 = (context, accepts) => Promise<PaymentExecerV1[]>

Defined in: packages/types/src/client.ts:63

​

Parameters

context

RequestContext

accepts

x402PaymentRequirements[]

​

Returns

Promise<PaymentExecerV1[]>

​

Deprecated

Use PaymentHandler instead

---

​

RequestContext

RequestContext = object

Defined in: packages/types/src/client.ts:9

​

Properties

request

request: RequestInfo | URL

Defined in: packages/types/src/client.ts:10

​

Functions

​

adaptPaymentHandlerV1ToV2()

adaptPaymentHandlerV1ToV2(handler, translateNetwork): PaymentHandler

Defined in: packages/types/src/client.ts:91 Adapt a v1 PaymentHandlerV1 to the PaymentHandler interface. This allows existing v1 payment handlers to be used with v2 infrastructure. Requirements are converted from v2 to v1 before being passed to the handler, and the resulting execers are wrapped to convert requirements back to v2. Accepts both spec-compliant handlers (with optional mimeType) and legacy handlers (with required mimeType) for backwards compatibility.

​

Parameters

handler

The v1 payment handler to adapt PaymentHandlerV1 | PaymentHandlerV1Strict

translateNetwork

NetworkTranslator Function to translate legacy network IDs to CAIP-2

​

Returns

PaymentHandler

---

​

adaptPaymentHandlerV2ToV1()

adaptPaymentHandlerV2ToV1(handler, translateNetwork): PaymentHandlerV1

Defined in: packages/types/src/client.ts:129 Adapt a PaymentHandler to the v1 PaymentHandlerV1 interface. This allows v2 payment handlers to be used with v1 infrastructure.

​

Parameters

handler

PaymentHandler The v2 payment handler to adapt

translateNetwork

NetworkTranslator Function to translate legacy network IDs to CAIP-2

​

Returns

PaymentHandlerV1