local-protocol 0.1.0

package/resources/payment-instruments.d.mts

@@ -0,0 +1,330 @@
+import { APIResource } from "../core/resource.mjs";
+import * as RequestsAPI from "./requests/requests.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Register payment instruments and related payment models.
+ */
+export declare class PaymentInstruments extends APIResource {
+    /**
+     * Register a payment instrument for use in order creation.
+     */
+    register(body: PaymentInstrumentRegisterParams, options?: RequestOptions): APIPromise<EvmAuthCaptureEscrowInstrument>;
+}
+/**
+ * Amount with explicit currency. Value is always in minor units (e.g., cents for
+ * USD).
+ */
+export interface Amount {
+    /**
+     * Currency descriptor (fiat or EVM token).
+     */
+    currency: Amount.FiatCurrency | EvmCurrency;
+    /**
+     * Value in minor currency units as an integer string.
+     */
+    value: string;
+}
+export declare namespace Amount {
+    /**
+     * Fiat currency descriptor.
+     */
+    interface FiatCurrency {
+        /**
+         * ISO 4217 currency code (e.g., 'USD', 'EUR', 'JPY').
+         */
+        symbol: string;
+    }
+}
+/**
+ * Amount denominated in an EVM token. Value is in atomic token units.
+ */
+export interface EvmAmount {
+    /**
+     * EVM token currency descriptor.
+     */
+    currency: EvmCurrency;
+    /**
+     * Value in atomic token units as an integer string.
+     */
+    value: string;
+}
+/**
+ * Payment instrument for auth/capture escrow on EVM chains.
+ */
+export interface EvmAuthCaptureEscrowInstrument extends PaymentInstrument, EvmAuthCaptureEscrowInstrumentDetails {
+    type: 'evm_auth_capture_escrow';
+}
+export interface EvmAuthCaptureEscrowInstrumentDetails {
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    token: EvmAuthCaptureEscrowInstrumentDetails.Token;
+    /**
+     * Amount in atomic units. Currency chain_id MUST match the instrument chain_id;
+     * currency address and decimals MUST match token address and decimals.
+     */
+    amount: EvmAmount;
+    /**
+     * Authorization expiration (RFC 3339).
+     */
+    authorization_expires_at: string;
+    /**
+     * EVM chain id.
+     */
+    chain_id: number;
+    /**
+     * Escrow contract address.
+     */
+    contract: string;
+    /**
+     * Maximum amount that can be authorized (atomic units). Currency chain_id MUST
+     * match the instrument chain_id; currency address and decimals MUST match token
+     * address and decimals.
+     */
+    max_amount: EvmAmount;
+    /**
+     * Unique nonce for payment info hash computation.
+     */
+    nonce: string;
+    /**
+     * Operator address.
+     */
+    operator: string;
+    /**
+     * Payer address.
+     */
+    payer: string;
+    /**
+     * Hash identifying the on-chain payment authorization.
+     */
+    payment_info_hash: string;
+    /**
+     * Pre-approval expiration (RFC 3339).
+     */
+    preapproval_expires_at: string;
+    /**
+     * Receiver address for captures.
+     */
+    receiver: string;
+    /**
+     * Refund expiration (RFC 3339).
+     */
+    refund_expires_at: string;
+    [k: string]: unknown;
+}
+export declare namespace EvmAuthCaptureEscrowInstrumentDetails {
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    interface Token {
+        /**
+         * Token decimals.
+         */
+        decimals: number;
+        /**
+         * Token symbol (e.g., USDC).
+         */
+        symbol: string;
+        /**
+         * ERC-20 contract address. Omit for native gas tokens.
+         */
+        address?: string;
+    }
+}
+/**
+ * EVM token currency descriptor.
+ */
+export interface EvmCurrency {
+    /**
+     * Token contract address.
+     */
+    address: string;
+    /**
+     * EVM chain id.
+     */
+    chain_id: number;
+    /**
+     * Decimal places for the token.
+     */
+    decimals: number;
+}
+/**
+ * Payment configuration containing instruments.
+ */
+export interface Payment {
+    /**
+     * Payment instruments available. Each instrument is associated with a handler via
+     * handler_id.
+     */
+    instruments?: Array<SelectedPaymentInstrument>;
+}
+/**
+ * Base definition for any payment instrument.
+ */
+export interface PaymentInstrument {
+    /**
+     * Unique instrument identifier.
+     */
+    id: string;
+    /**
+     * Handler instance identifier.
+     */
+    handler_id: string;
+    /**
+     * Instrument category (e.g., 'card', 'tokenized_card').
+     */
+    type: string;
+    /**
+     * Billing address.
+     */
+    billing_address?: RequestsAPI.PostalAddress;
+    /**
+     * Base definition for any payment credential.
+     */
+    credential?: PaymentInstrument.Credential;
+    /**
+     * Display information for the instrument. Each payment instrument schema defines
+     * its specific display properties, as outlined by the payment handler.
+     */
+    display?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace PaymentInstrument {
+    /**
+     * Base definition for any payment credential.
+     */
+    interface Credential {
+        /**
+         * Credential type discriminator.
+         */
+        type: string;
+        [k: string]: unknown;
+    }
+}
+/**
+ * A payment instrument with selection state.
+ */
+export interface SelectedPaymentInstrument extends PaymentInstrument, SelectedPaymentInstrumentSelectionState {
+}
+export interface SelectedPaymentInstrumentSelectionState {
+    /**
+     * Whether this instrument is selected by the user.
+     */
+    selected?: boolean;
+}
+export interface PaymentInstrumentRegisterParams {
+    /**
+     * Unique instrument identifier.
+     */
+    id: string;
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    token: PaymentInstrumentRegisterParams.Token;
+    /**
+     * Amount in atomic units. Currency chain_id MUST match the instrument chain_id;
+     * currency address and decimals MUST match token address and decimals.
+     */
+    amount: EvmAmount;
+    /**
+     * Authorization expiration (RFC 3339).
+     */
+    authorization_expires_at: string;
+    /**
+     * EVM chain id.
+     */
+    chain_id: number;
+    /**
+     * Escrow contract address.
+     */
+    contract: string;
+    /**
+     * Handler instance identifier.
+     */
+    handler_id: string;
+    /**
+     * Maximum amount that can be authorized (atomic units). Currency chain_id MUST
+     * match the instrument chain_id; currency address and decimals MUST match token
+     * address and decimals.
+     */
+    max_amount: EvmAmount;
+    /**
+     * Unique nonce for payment info hash computation.
+     */
+    nonce: string;
+    /**
+     * Operator address.
+     */
+    operator: string;
+    /**
+     * Payer address.
+     */
+    payer: string;
+    /**
+     * Hash identifying the on-chain payment authorization.
+     */
+    payment_info_hash: string;
+    /**
+     * Pre-approval expiration (RFC 3339).
+     */
+    preapproval_expires_at: string;
+    /**
+     * Receiver address for captures.
+     */
+    receiver: string;
+    /**
+     * Refund expiration (RFC 3339).
+     */
+    refund_expires_at: string;
+    type: 'evm_auth_capture_escrow';
+    /**
+     * Billing address.
+     */
+    billing_address?: RequestsAPI.PostalAddress;
+    /**
+     * Base definition for any payment credential.
+     */
+    credential?: PaymentInstrumentRegisterParams.Credential;
+    /**
+     * Display information for the instrument. Each payment instrument schema defines
+     * its specific display properties, as outlined by the payment handler.
+     */
+    display?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace PaymentInstrumentRegisterParams {
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    interface Token {
+        /**
+         * Token decimals.
+         */
+        decimals: number;
+        /**
+         * Token symbol (e.g., USDC).
+         */
+        symbol: string;
+        /**
+         * ERC-20 contract address. Omit for native gas tokens.
+         */
+        address?: string;
+    }
+    /**
+     * Base definition for any payment credential.
+     */
+    interface Credential {
+        /**
+         * Credential type discriminator.
+         */
+        type: string;
+        [k: string]: unknown;
+    }
+}
+export declare namespace PaymentInstruments {
+    export { type Amount as Amount, type EvmAmount as EvmAmount, type EvmAuthCaptureEscrowInstrument as EvmAuthCaptureEscrowInstrument, type EvmAuthCaptureEscrowInstrumentDetails as EvmAuthCaptureEscrowInstrumentDetails, type EvmCurrency as EvmCurrency, type Payment as Payment, type PaymentInstrument as PaymentInstrument, type SelectedPaymentInstrument as SelectedPaymentInstrument, type SelectedPaymentInstrumentSelectionState as SelectedPaymentInstrumentSelectionState, type PaymentInstrumentRegisterParams as PaymentInstrumentRegisterParams, };
+}
+//# sourceMappingURL=payment-instruments.d.mts.map

package/resources/payment-instruments.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-instruments.d.mts","sourceRoot":"","sources":["../src/resources/payment-instruments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;IACjD;;OAEG;IACH,QAAQ,CACN,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,8BACf,SAAQ,iBAAiB,EACvB,qCAAqC;IACvC,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,KAAK,EAAE,qCAAqC,CAAC,KAAK,CAAC;IAEnD;;;OAGG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC;IAE5C;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;IAE1C;;;OAGG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBACf,SAAQ,iBAAiB,EACvB,uCAAuC;CAAG;AAE9C,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,+BAA+B,CAAC,KAAK,CAAC;IAE7C;;;OAGG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B,IAAI,EAAE,yBAAyB,CAAC;IAEhC;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC;IAE5C;;OAEG;IACH,UAAU,CAAC,EAAE,+BAA+B,CAAC,UAAU,CAAC;IAExD;;;OAGG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}

package/resources/payment-instruments.d.ts

@@ -0,0 +1,330 @@
+import { APIResource } from "../core/resource.js";
+import * as RequestsAPI from "./requests/requests.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Register payment instruments and related payment models.
+ */
+export declare class PaymentInstruments extends APIResource {
+    /**
+     * Register a payment instrument for use in order creation.
+     */
+    register(body: PaymentInstrumentRegisterParams, options?: RequestOptions): APIPromise<EvmAuthCaptureEscrowInstrument>;
+}
+/**
+ * Amount with explicit currency. Value is always in minor units (e.g., cents for
+ * USD).
+ */
+export interface Amount {
+    /**
+     * Currency descriptor (fiat or EVM token).
+     */
+    currency: Amount.FiatCurrency | EvmCurrency;
+    /**
+     * Value in minor currency units as an integer string.
+     */
+    value: string;
+}
+export declare namespace Amount {
+    /**
+     * Fiat currency descriptor.
+     */
+    interface FiatCurrency {
+        /**
+         * ISO 4217 currency code (e.g., 'USD', 'EUR', 'JPY').
+         */
+        symbol: string;
+    }
+}
+/**
+ * Amount denominated in an EVM token. Value is in atomic token units.
+ */
+export interface EvmAmount {
+    /**
+     * EVM token currency descriptor.
+     */
+    currency: EvmCurrency;
+    /**
+     * Value in atomic token units as an integer string.
+     */
+    value: string;
+}
+/**
+ * Payment instrument for auth/capture escrow on EVM chains.
+ */
+export interface EvmAuthCaptureEscrowInstrument extends PaymentInstrument, EvmAuthCaptureEscrowInstrumentDetails {
+    type: 'evm_auth_capture_escrow';
+}
+export interface EvmAuthCaptureEscrowInstrumentDetails {
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    token: EvmAuthCaptureEscrowInstrumentDetails.Token;
+    /**
+     * Amount in atomic units. Currency chain_id MUST match the instrument chain_id;
+     * currency address and decimals MUST match token address and decimals.
+     */
+    amount: EvmAmount;
+    /**
+     * Authorization expiration (RFC 3339).
+     */
+    authorization_expires_at: string;
+    /**
+     * EVM chain id.
+     */
+    chain_id: number;
+    /**
+     * Escrow contract address.
+     */
+    contract: string;
+    /**
+     * Maximum amount that can be authorized (atomic units). Currency chain_id MUST
+     * match the instrument chain_id; currency address and decimals MUST match token
+     * address and decimals.
+     */
+    max_amount: EvmAmount;
+    /**
+     * Unique nonce for payment info hash computation.
+     */
+    nonce: string;
+    /**
+     * Operator address.
+     */
+    operator: string;
+    /**
+     * Payer address.
+     */
+    payer: string;
+    /**
+     * Hash identifying the on-chain payment authorization.
+     */
+    payment_info_hash: string;
+    /**
+     * Pre-approval expiration (RFC 3339).
+     */
+    preapproval_expires_at: string;
+    /**
+     * Receiver address for captures.
+     */
+    receiver: string;
+    /**
+     * Refund expiration (RFC 3339).
+     */
+    refund_expires_at: string;
+    [k: string]: unknown;
+}
+export declare namespace EvmAuthCaptureEscrowInstrumentDetails {
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    interface Token {
+        /**
+         * Token decimals.
+         */
+        decimals: number;
+        /**
+         * Token symbol (e.g., USDC).
+         */
+        symbol: string;
+        /**
+         * ERC-20 contract address. Omit for native gas tokens.
+         */
+        address?: string;
+    }
+}
+/**
+ * EVM token currency descriptor.
+ */
+export interface EvmCurrency {
+    /**
+     * Token contract address.
+     */
+    address: string;
+    /**
+     * EVM chain id.
+     */
+    chain_id: number;
+    /**
+     * Decimal places for the token.
+     */
+    decimals: number;
+}
+/**
+ * Payment configuration containing instruments.
+ */
+export interface Payment {
+    /**
+     * Payment instruments available. Each instrument is associated with a handler via
+     * handler_id.
+     */
+    instruments?: Array<SelectedPaymentInstrument>;
+}
+/**
+ * Base definition for any payment instrument.
+ */
+export interface PaymentInstrument {
+    /**
+     * Unique instrument identifier.
+     */
+    id: string;
+    /**
+     * Handler instance identifier.
+     */
+    handler_id: string;
+    /**
+     * Instrument category (e.g., 'card', 'tokenized_card').
+     */
+    type: string;
+    /**
+     * Billing address.
+     */
+    billing_address?: RequestsAPI.PostalAddress;
+    /**
+     * Base definition for any payment credential.
+     */
+    credential?: PaymentInstrument.Credential;
+    /**
+     * Display information for the instrument. Each payment instrument schema defines
+     * its specific display properties, as outlined by the payment handler.
+     */
+    display?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace PaymentInstrument {
+    /**
+     * Base definition for any payment credential.
+     */
+    interface Credential {
+        /**
+         * Credential type discriminator.
+         */
+        type: string;
+        [k: string]: unknown;
+    }
+}
+/**
+ * A payment instrument with selection state.
+ */
+export interface SelectedPaymentInstrument extends PaymentInstrument, SelectedPaymentInstrumentSelectionState {
+}
+export interface SelectedPaymentInstrumentSelectionState {
+    /**
+     * Whether this instrument is selected by the user.
+     */
+    selected?: boolean;
+}
+export interface PaymentInstrumentRegisterParams {
+    /**
+     * Unique instrument identifier.
+     */
+    id: string;
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    token: PaymentInstrumentRegisterParams.Token;
+    /**
+     * Amount in atomic units. Currency chain_id MUST match the instrument chain_id;
+     * currency address and decimals MUST match token address and decimals.
+     */
+    amount: EvmAmount;
+    /**
+     * Authorization expiration (RFC 3339).
+     */
+    authorization_expires_at: string;
+    /**
+     * EVM chain id.
+     */
+    chain_id: number;
+    /**
+     * Escrow contract address.
+     */
+    contract: string;
+    /**
+     * Handler instance identifier.
+     */
+    handler_id: string;
+    /**
+     * Maximum amount that can be authorized (atomic units). Currency chain_id MUST
+     * match the instrument chain_id; currency address and decimals MUST match token
+     * address and decimals.
+     */
+    max_amount: EvmAmount;
+    /**
+     * Unique nonce for payment info hash computation.
+     */
+    nonce: string;
+    /**
+     * Operator address.
+     */
+    operator: string;
+    /**
+     * Payer address.
+     */
+    payer: string;
+    /**
+     * Hash identifying the on-chain payment authorization.
+     */
+    payment_info_hash: string;
+    /**
+     * Pre-approval expiration (RFC 3339).
+     */
+    preapproval_expires_at: string;
+    /**
+     * Receiver address for captures.
+     */
+    receiver: string;
+    /**
+     * Refund expiration (RFC 3339).
+     */
+    refund_expires_at: string;
+    type: 'evm_auth_capture_escrow';
+    /**
+     * Billing address.
+     */
+    billing_address?: RequestsAPI.PostalAddress;
+    /**
+     * Base definition for any payment credential.
+     */
+    credential?: PaymentInstrumentRegisterParams.Credential;
+    /**
+     * Display information for the instrument. Each payment instrument schema defines
+     * its specific display properties, as outlined by the payment handler.
+     */
+    display?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace PaymentInstrumentRegisterParams {
+    /**
+     * EVM token identifier used for auth/capture settlement.
+     */
+    interface Token {
+        /**
+         * Token decimals.
+         */
+        decimals: number;
+        /**
+         * Token symbol (e.g., USDC).
+         */
+        symbol: string;
+        /**
+         * ERC-20 contract address. Omit for native gas tokens.
+         */
+        address?: string;
+    }
+    /**
+     * Base definition for any payment credential.
+     */
+    interface Credential {
+        /**
+         * Credential type discriminator.
+         */
+        type: string;
+        [k: string]: unknown;
+    }
+}
+export declare namespace PaymentInstruments {
+    export { type Amount as Amount, type EvmAmount as EvmAmount, type EvmAuthCaptureEscrowInstrument as EvmAuthCaptureEscrowInstrument, type EvmAuthCaptureEscrowInstrumentDetails as EvmAuthCaptureEscrowInstrumentDetails, type EvmCurrency as EvmCurrency, type Payment as Payment, type PaymentInstrument as PaymentInstrument, type SelectedPaymentInstrument as SelectedPaymentInstrument, type SelectedPaymentInstrumentSelectionState as SelectedPaymentInstrumentSelectionState, type PaymentInstrumentRegisterParams as PaymentInstrumentRegisterParams, };
+}
+//# sourceMappingURL=payment-instruments.d.ts.map

package/resources/payment-instruments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-instruments.d.ts","sourceRoot":"","sources":["../src/resources/payment-instruments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;IACjD;;OAEG;IACH,QAAQ,CACN,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,8BACf,SAAQ,iBAAiB,EACvB,qCAAqC;IACvC,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,KAAK,EAAE,qCAAqC,CAAC,KAAK,CAAC;IAEnD;;;OAGG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC;IAE5C;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;IAE1C;;;OAGG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBACf,SAAQ,iBAAiB,EACvB,uCAAuC;CAAG;AAE9C,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,+BAA+B,CAAC,KAAK,CAAC;IAE7C;;;OAGG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B,IAAI,EAAE,yBAAyB,CAAC;IAEhC;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC;IAE5C;;OAEG;IACH,UAAU,CAAC,EAAE,+BAA+B,CAAC,UAAU,CAAC;IAExD;;;OAGG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}

package/resources/payment-instruments.js

@@ -0,0 +1,18 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentInstruments = void 0;
+const resource_1 = require("../core/resource.js");
+/**
+ * Register payment instruments and related payment models.
+ */
+class PaymentInstruments extends resource_1.APIResource {
+    /**
+     * Register a payment instrument for use in order creation.
+     */
+    register(body, options) {
+        return this._client.post('/payment-instruments', { body, ...options });
+    }
+}
+exports.PaymentInstruments = PaymentInstruments;
+//# sourceMappingURL=payment-instruments.js.map

package/resources/payment-instruments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-instruments.js","sourceRoot":"","sources":["../src/resources/payment-instruments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C;;GAEG;AACH,MAAa,kBAAmB,SAAQ,sBAAW;IACjD;;OAEG;IACH,QAAQ,CACN,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAVD,gDAUC"}