@peable.to/contracts 5.4.0 → 5.6.0

package/dist/cjs/resources/checkout/checkoutSessions.js

@@ -474,6 +474,10 @@ exports.confirmCheckoutSessionPublicParams = zod_1.z
         .enum(['card', 'faircoin'])
         .optional()
         .describe("How the payer pays: one of the session's `payment_method_types`. Default: the rail of the order's currency (`card` on a fiat order). `faircoin` on a fiat order quotes its total in FAIR for 10 minutes; confirming again with the other method replaces a payment that has not started moving money."),
+    locale: zod_1.z
+        .enum(checkout_1.CHECKOUT_LOCALES)
+        .optional()
+        .describe("The language the payer is completing checkout in. Recorded on the session (never on its `locale`) and given to a customer checkout creates as its `preferred_locales`; the session's emails are written in it when the customer has no preferred language."),
 })
     .strict();
 /** `POST /v1/test_helpers/checkout_sessions/{id}/expire` takes nothing. */

package/dist/cjs/resources/core/customers.js

@@ -8,6 +8,7 @@ const objects_1 = require("../../common/objects");
 const params_1 = require("../../common/params");
 const primitives_1 = require("../../common/primitives");
 const route_1 = require("../../route");
+const checkout_1 = require("../../vocabulary/checkout");
 /**
  * Customers (`cus_…`) — Orbit's own object (ADR 0016). A provider customer is an
  * internal binding created lazily, per mode, when a card payment method is
@@ -24,6 +25,9 @@ exports.customerSchema = (0, objects_1.defineObject)('customer', 'Customer', zod
     description: zod_1.z.string().nullable(),
     address: address_1.addressSchema.nullable(),
     shipping: address_1.shippingSchema.nullable(),
+    preferred_locales: zod_1.z
+        .array(zod_1.z.enum(checkout_1.CHECKOUT_LOCALES))
+        .describe("The customer's preferred languages, most preferred first (Stripe's `preferred_locales`), from the payer locale set. Receipts, invoices and dunning emails are written in the first; empty when none is known. A customer Checkout creates gets the language the payer completed it in."),
     invoice_settings: zod_1.z
         .object({
         default_payment_method: (0, objects_1.expandable)('payment_method', '`pm_…`, or the PaymentMethod with `expand[]=invoice_settings.default_payment_method`.').nullable(),
@@ -52,6 +56,7 @@ exports.customerSchema = (0, objects_1.defineObject)('customer', 'Customer', zod
             description: null,
             address: null,
             shipping: null,
+            preferred_locales: ['fr', 'en'],
             invoice_settings: { default_payment_method: null },
             metadata: { order_id: '6735' },
             balance: '0',
@@ -66,6 +71,11 @@ exports.deletedCustomerSchema = (0, objects_1.defineComponent)('DeletedCustomer'
 const name = zod_1.z.string().max(500);
 const phone = zod_1.z.string().max(40);
 const description = zod_1.z.string().max(1000);
+const preferredLocales = zod_1.z
+    .array(zod_1.z.enum(checkout_1.CHECKOUT_LOCALES))
+    .max(checkout_1.CHECKOUT_LOCALES.length)
+    .refine((locales) => new Set(locales).size === locales.length, 'a language is listed once')
+    .describe('Most preferred first, each once, from the payer locale set (`ar`, `bn`, `ca`, `de`, `en`, `es`, `fr`, `hi`, `id`, `it`, `ja`, `pt`, `ru`, `tr`, `zh`).');
 exports.createCustomerParams = zod_1.z
     .object({
     email: address_1.emailParam.optional(),
@@ -74,6 +84,7 @@ exports.createCustomerParams = zod_1.z
     description: description.optional(),
     address: address_1.addressParams.optional(),
     shipping: address_1.shippingParams.optional(),
+    preferred_locales: preferredLocales.optional(),
     invoice_settings: zod_1.z.object({ default_payment_method: params_1.idParam.optional() }).strict().optional(),
     metadata: params_1.metadataCreateParam.optional(),
     test_clock: params_1.idParam
@@ -91,6 +102,9 @@ exports.updateCustomerParams = zod_1.z
     description: (0, params_1.clearable)(description).optional(),
     address: (0, params_1.clearable)(address_1.addressParams).optional(),
     shipping: (0, params_1.clearable)(address_1.shippingParams).optional(),
+    preferred_locales: (0, params_1.clearable)(preferredLocales)
+        .optional()
+        .describe('Replaces the list; `[]` or `""` clears it.'),
     invoice_settings: zod_1.z
         .object({ default_payment_method: (0, params_1.clearable)(params_1.idParam).optional() })
         .strict()

package/dist/cjs/resources/payments/social.js

@@ -148,7 +148,7 @@ exports.socialRoutes = [
         path: '/v1/social/{username}/next_address',
         tag: 'Social payments',
         summary: 'Reserve an address to pay a person',
-        description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`; paying yourself is refused.",
+        description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`, and one whose wallet watches no further address (every index below its watched bound is taken) 503 `faircoin_receive_tree_full`; paying yourself is refused.",
         auth: 'user',
         params: { username: 'The recipient’s Oxy username.' },
         body: exports.socialNextAddressParams,

package/dist/cjs/vocabulary/errors.js

@@ -135,6 +135,7 @@ exports.ERROR_CODE_DESCRIPTIONS = {
     faircoin_wallet_missing: "The Peable wallet that receives this payment (the merchant owner's, or the seller's) isn't set up yet, so it cannot be paid in FairCoin. The other payment methods still work.",
     faircoin_network_closed: 'FairCoin payments on this network are not open on this deployment yet. The other payment methods still work.',
     faircoin_capacity_reached: 'Too many FairCoin payments to this recipient are waiting to be paid right now, so no new FairCoin address can be handed out. The other payment methods still work; try FairCoin again shortly.',
+    faircoin_receive_tree_full: "Every FairCoin address the recipient's Peable wallet watches has been handed out, so no new one can be derived for them. Nothing was reserved.",
     faircoin_amount_too_small: "One seller's share of this order is below the smallest amount the FairCoin network relays, so it cannot be paid in FairCoin. The other payment methods still work.",
     credit_note_exceeds_invoice: "The credit note's amount exceeds what the invoice can still credit.",
     test_clock_unexpected_state: 'The test clock is advancing; wait until it is ready.',

package/dist/cjs/vocabulary/index.js

@@ -38,3 +38,4 @@ __exportStar(require("./identity"), exports);
 __exportStar(require("./merchants"), exports);
 __exportStar(require("./paymentMethodConfigurations"), exports);
 __exportStar(require("./realtime"), exports);
+__exportStar(require("./receiveTree"), exports);

package/dist/cjs/vocabulary/payments.js

@@ -33,17 +33,21 @@ exports.PAYMENT_INTENT_STATUSES = [
     'canceled',
 ];
 /**
- * Why an intent was cancelled — Stripe's reasons, plus two FairCoin-only ones:
- * `underpaid` (a transaction paid less than the amount) and
+ * Why an intent was cancelled — Stripe's reasons, plus three FairCoin-only ones:
+ * `underpaid` (a transaction paid less than the amount),
  * `recipient_key_changed` (the recipient's identity key was replaced after the
  * address was reserved, so the address is no longer in the wallet it pays —
  * ADR 0002, amended 2026-11-06; nothing had been broadcast, and the order stays
- * open for a fresh address).
+ * open for a fresh address) and `faircoin_network_closed` (the deployment
+ * closed the payment's FairCoin network — ADR 0002's gate — before anything was
+ * broadcast; the order stays open, and FairCoin on it says the network is
+ * closed).
  */
 exports.PAYMENT_INTENT_CANCELLATION_REASONS = [
     'abandoned',
     'automatic',
     'duplicate',
+    'faircoin_network_closed',
     'fraudulent',
     'recipient_key_changed',
     'requested_by_customer',

package/dist/cjs/vocabulary/receiveTree.js

@@ -0,0 +1,44 @@
+"use strict";
+/**
+ * The size of a recipient's FairCoin receive tree (ADR 0021 D9, amended
+ * 2026-11-06) — ONE answer, read by the gateway that hands out indices and by
+ * the Peable wallet that watches them.
+ *
+ * Every FairCoin address the gateway reserves for an account — a merchant
+ * payment, a marketplace seller's, an invoice's, `@username` — is index `i` of
+ * that account's identity tree (ADR 0002, ADR 0021 D5). The wallet watches a
+ * contiguous window, indices `0 .. SOCIAL_RECEIVE_MAX_WATCHED - 1`, reaching
+ * {@link SOCIAL_RECEIVE_GAP_LIMIT} past the highest index reserved
+ * (`planSocialReceiveWindow` in `packages/frontend/src/wallet/social-receive.ts`),
+ * and stops offering `@username` once that reach would pass its bound. So an
+ * index is reserved only when the wallet, after reserving it, still reaches
+ * the gap above it inside its bound:
+ *
+ *     index + SOCIAL_RECEIVE_GAP_LIMIT  <=  SOCIAL_RECEIVE_MAX_WATCHED - 1
+ *     index                             <   SOCIAL_RECEIVE_INDEX_LIMIT
+ *
+ * The gateway refuses to mint `index >= SOCIAL_RECEIVE_INDEX_LIMIT` (in the
+ * reservation's own statement), so every address it hands out is inside the
+ * window the wallet watches. Zod-free and dependency-free: the wallet bundles
+ * this module alone (`@peable.to/contracts/vocabulary/receiveTree`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOCIAL_RECEIVE_NEARLY_FULL_REMAINING = exports.SOCIAL_RECEIVE_INDEX_LIMIT = exports.SOCIAL_RECEIVE_GAP_LIMIT = exports.SOCIAL_RECEIVE_MAX_WATCHED = void 0;
+/** The most indices the wallet watches: `0 .. SOCIAL_RECEIVE_MAX_WATCHED - 1`. */
+exports.SOCIAL_RECEIVE_MAX_WATCHED = 2000;
+/**
+ * How many unused addresses the wallet watches beyond the highest index used
+ * or reserved — the FairCoin BIP44 external-chain gap limit.
+ */
+exports.SOCIAL_RECEIVE_GAP_LIMIT = 20;
+/**
+ * The first index the gateway never mints (exclusive bound): `1 980`. Every
+ * minted index `i` satisfies `i < SOCIAL_RECEIVE_INDEX_LIMIT`, i.e.
+ * `i + SOCIAL_RECEIVE_GAP_LIMIT <= SOCIAL_RECEIVE_MAX_WATCHED - 1`.
+ */
+exports.SOCIAL_RECEIVE_INDEX_LIMIT = exports.SOCIAL_RECEIVE_MAX_WATCHED - exports.SOCIAL_RECEIVE_GAP_LIMIT;
+/**
+ * How close to {@link SOCIAL_RECEIVE_INDEX_LIMIT} a tree is "nearly full":
+ * Orbit warns the owners once fewer fresh indices than this are left.
+ */
+exports.SOCIAL_RECEIVE_NEARLY_FULL_REMAINING = 200;

package/dist/esm/resources/checkout/checkoutSessions.js

@@ -471,6 +471,10 @@ export const confirmCheckoutSessionPublicParams = z
         .enum(['card', 'faircoin'])
         .optional()
         .describe("How the payer pays: one of the session's `payment_method_types`. Default: the rail of the order's currency (`card` on a fiat order). `faircoin` on a fiat order quotes its total in FAIR for 10 minutes; confirming again with the other method replaces a payment that has not started moving money."),
+    locale: z
+        .enum(CHECKOUT_LOCALES)
+        .optional()
+        .describe("The language the payer is completing checkout in. Recorded on the session (never on its `locale`) and given to a customer checkout creates as its `preferred_locales`; the session's emails are written in it when the customer has no preferred language."),
 })
     .strict();
 /** `POST /v1/test_helpers/checkout_sessions/{id}/expire` takes nothing. */

package/dist/esm/resources/core/customers.js

@@ -5,6 +5,7 @@ import { defineComponent, defineObject, expandable } from '../../common/objects.
 import { clearable, expandOnlyQuery, expandParam, idParam, listQuery, metadataCreateParam, metadataUpdateParam, searchQuery, } from '../../common/params.js';
 import { currency, livemode, metadata, signedAmount, unixSeconds } from '../../common/primitives.js';
 import { defineRoute } from '../../route.js';
+import { CHECKOUT_LOCALES } from '../../vocabulary/checkout.js';
 /**
  * Customers (`cus_…`) — Orbit's own object (ADR 0016). A provider customer is an
  * internal binding created lazily, per mode, when a card payment method is
@@ -21,6 +22,9 @@ export const customerSchema = defineObject('customer', 'Customer', z
     description: z.string().nullable(),
     address: addressSchema.nullable(),
     shipping: shippingSchema.nullable(),
+    preferred_locales: z
+        .array(z.enum(CHECKOUT_LOCALES))
+        .describe("The customer's preferred languages, most preferred first (Stripe's `preferred_locales`), from the payer locale set. Receipts, invoices and dunning emails are written in the first; empty when none is known. A customer Checkout creates gets the language the payer completed it in."),
     invoice_settings: z
         .object({
         default_payment_method: expandable('payment_method', '`pm_…`, or the PaymentMethod with `expand[]=invoice_settings.default_payment_method`.').nullable(),
@@ -49,6 +53,7 @@ export const customerSchema = defineObject('customer', 'Customer', z
             description: null,
             address: null,
             shipping: null,
+            preferred_locales: ['fr', 'en'],
             invoice_settings: { default_payment_method: null },
             metadata: { order_id: '6735' },
             balance: '0',
@@ -63,6 +68,11 @@ export const deletedCustomerSchema = defineComponent('DeletedCustomer', deletedO
 const name = z.string().max(500);
 const phone = z.string().max(40);
 const description = z.string().max(1000);
+const preferredLocales = z
+    .array(z.enum(CHECKOUT_LOCALES))
+    .max(CHECKOUT_LOCALES.length)
+    .refine((locales) => new Set(locales).size === locales.length, 'a language is listed once')
+    .describe('Most preferred first, each once, from the payer locale set (`ar`, `bn`, `ca`, `de`, `en`, `es`, `fr`, `hi`, `id`, `it`, `ja`, `pt`, `ru`, `tr`, `zh`).');
 export const createCustomerParams = z
     .object({
     email: emailParam.optional(),
@@ -71,6 +81,7 @@ export const createCustomerParams = z
     description: description.optional(),
     address: addressParams.optional(),
     shipping: shippingParams.optional(),
+    preferred_locales: preferredLocales.optional(),
     invoice_settings: z.object({ default_payment_method: idParam.optional() }).strict().optional(),
     metadata: metadataCreateParam.optional(),
     test_clock: idParam
@@ -88,6 +99,9 @@ export const updateCustomerParams = z
     description: clearable(description).optional(),
     address: clearable(addressParams).optional(),
     shipping: clearable(shippingParams).optional(),
+    preferred_locales: clearable(preferredLocales)
+        .optional()
+        .describe('Replaces the list; `[]` or `""` clears it.'),
     invoice_settings: z
         .object({ default_payment_method: clearable(idParam).optional() })
         .strict()

package/dist/esm/resources/payments/social.js

@@ -145,7 +145,7 @@ export const socialRoutes = [
         path: '/v1/social/{username}/next_address',
         tag: 'Social payments',
         summary: 'Reserve an address to pay a person',
-        description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`; paying yourself is refused.",
+        description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`, and one whose wallet watches no further address (every index below its watched bound is taken) 503 `faircoin_receive_tree_full`; paying yourself is refused.",
         auth: 'user',
         params: { username: 'The recipient’s Oxy username.' },
         body: socialNextAddressParams,

package/dist/esm/vocabulary/errors.js

@@ -130,6 +130,7 @@ export const ERROR_CODE_DESCRIPTIONS = {
     faircoin_wallet_missing: "The Peable wallet that receives this payment (the merchant owner's, or the seller's) isn't set up yet, so it cannot be paid in FairCoin. The other payment methods still work.",
     faircoin_network_closed: 'FairCoin payments on this network are not open on this deployment yet. The other payment methods still work.',
     faircoin_capacity_reached: 'Too many FairCoin payments to this recipient are waiting to be paid right now, so no new FairCoin address can be handed out. The other payment methods still work; try FairCoin again shortly.',
+    faircoin_receive_tree_full: "Every FairCoin address the recipient's Peable wallet watches has been handed out, so no new one can be derived for them. Nothing was reserved.",
     faircoin_amount_too_small: "One seller's share of this order is below the smallest amount the FairCoin network relays, so it cannot be paid in FairCoin. The other payment methods still work.",
     credit_note_exceeds_invoice: "The credit note's amount exceeds what the invoice can still credit.",
     test_clock_unexpected_state: 'The test clock is advancing; wait until it is ready.',

package/dist/esm/vocabulary/index.js

@@ -22,3 +22,4 @@ export * from './identity.js';
 export * from './merchants.js';
 export * from './paymentMethodConfigurations.js';
 export * from './realtime.js';
+export * from './receiveTree.js';

package/dist/esm/vocabulary/payments.js

@@ -30,17 +30,21 @@ export const PAYMENT_INTENT_STATUSES = [
     'canceled',
 ];
 /**
- * Why an intent was cancelled — Stripe's reasons, plus two FairCoin-only ones:
- * `underpaid` (a transaction paid less than the amount) and
+ * Why an intent was cancelled — Stripe's reasons, plus three FairCoin-only ones:
+ * `underpaid` (a transaction paid less than the amount),
  * `recipient_key_changed` (the recipient's identity key was replaced after the
  * address was reserved, so the address is no longer in the wallet it pays —
  * ADR 0002, amended 2026-11-06; nothing had been broadcast, and the order stays
- * open for a fresh address).
+ * open for a fresh address) and `faircoin_network_closed` (the deployment
+ * closed the payment's FairCoin network — ADR 0002's gate — before anything was
+ * broadcast; the order stays open, and FairCoin on it says the network is
+ * closed).
  */
 export const PAYMENT_INTENT_CANCELLATION_REASONS = [
     'abandoned',
     'automatic',
     'duplicate',
+    'faircoin_network_closed',
     'fraudulent',
     'recipient_key_changed',
     'requested_by_customer',

package/dist/esm/vocabulary/receiveTree.js

@@ -0,0 +1,41 @@
+/**
+ * The size of a recipient's FairCoin receive tree (ADR 0021 D9, amended
+ * 2026-11-06) — ONE answer, read by the gateway that hands out indices and by
+ * the Peable wallet that watches them.
+ *
+ * Every FairCoin address the gateway reserves for an account — a merchant
+ * payment, a marketplace seller's, an invoice's, `@username` — is index `i` of
+ * that account's identity tree (ADR 0002, ADR 0021 D5). The wallet watches a
+ * contiguous window, indices `0 .. SOCIAL_RECEIVE_MAX_WATCHED - 1`, reaching
+ * {@link SOCIAL_RECEIVE_GAP_LIMIT} past the highest index reserved
+ * (`planSocialReceiveWindow` in `packages/frontend/src/wallet/social-receive.ts`),
+ * and stops offering `@username` once that reach would pass its bound. So an
+ * index is reserved only when the wallet, after reserving it, still reaches
+ * the gap above it inside its bound:
+ *
+ *     index + SOCIAL_RECEIVE_GAP_LIMIT  <=  SOCIAL_RECEIVE_MAX_WATCHED - 1
+ *     index                             <   SOCIAL_RECEIVE_INDEX_LIMIT
+ *
+ * The gateway refuses to mint `index >= SOCIAL_RECEIVE_INDEX_LIMIT` (in the
+ * reservation's own statement), so every address it hands out is inside the
+ * window the wallet watches. Zod-free and dependency-free: the wallet bundles
+ * this module alone (`@peable.to/contracts/vocabulary/receiveTree`).
+ */
+/** The most indices the wallet watches: `0 .. SOCIAL_RECEIVE_MAX_WATCHED - 1`. */
+export const SOCIAL_RECEIVE_MAX_WATCHED = 2000;
+/**
+ * How many unused addresses the wallet watches beyond the highest index used
+ * or reserved — the FairCoin BIP44 external-chain gap limit.
+ */
+export const SOCIAL_RECEIVE_GAP_LIMIT = 20;
+/**
+ * The first index the gateway never mints (exclusive bound): `1 980`. Every
+ * minted index `i` satisfies `i < SOCIAL_RECEIVE_INDEX_LIMIT`, i.e.
+ * `i + SOCIAL_RECEIVE_GAP_LIMIT <= SOCIAL_RECEIVE_MAX_WATCHED - 1`.
+ */
+export const SOCIAL_RECEIVE_INDEX_LIMIT = SOCIAL_RECEIVE_MAX_WATCHED - SOCIAL_RECEIVE_GAP_LIMIT;
+/**
+ * How close to {@link SOCIAL_RECEIVE_INDEX_LIMIT} a tree is "nearly full":
+ * Orbit warns the owners once fewer fresh indices than this are left.
+ */
+export const SOCIAL_RECEIVE_NEARLY_FULL_REMAINING = 200;

package/dist/types/resources/checkout/checkoutSessions.d.ts

@@ -873,6 +873,23 @@ export declare const confirmCheckoutSessionPublicParams: z.ZodObject<{
         card: "card";
         faircoin: "faircoin";
     }>>;
+    locale: z.ZodOptional<z.ZodEnum<{
+        id: "id";
+        ar: "ar";
+        bn: "bn";
+        ca: "ca";
+        de: "de";
+        en: "en";
+        es: "es";
+        fr: "fr";
+        hi: "hi";
+        it: "it";
+        ja: "ja";
+        pt: "pt";
+        ru: "ru";
+        tr: "tr";
+        zh: "zh";
+    }>>;
 }, z.core.$strict>;
 export type ConfirmCheckoutSessionPublicParams = z.input<typeof confirmCheckoutSessionPublicParams>;
 /** `POST /v1/test_helpers/checkout_sessions/{id}/expire` takes nothing. */
@@ -2856,6 +2873,23 @@ export declare const checkoutSessionRoutes: readonly [{
             card: "card";
             faircoin: "faircoin";
         }>>;
+        locale: z.ZodOptional<z.ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
     }, z.core.$strict>;
     readonly response: z.ZodObject<{
         line_items: z.ZodArray<z.ZodObject<{

package/dist/types/resources/checkout/index.d.ts

@@ -1985,6 +1985,23 @@ export declare const checkoutRoutes: readonly [{
             card: "card";
             faircoin: "faircoin";
         }>>;
+        locale: import("zod").ZodOptional<import("zod").ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
     }, import("zod/v4/core").$strict>;
     readonly response: import("zod").ZodObject<{
         line_items: import("zod").ZodArray<import("zod").ZodObject<{

package/dist/types/resources/core/customers.d.ts

@@ -35,6 +35,23 @@ export declare const customerSchema: z.ZodObject<{
         carrier: z.ZodNullable<z.ZodString>;
         tracking_number: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>>;
+    preferred_locales: z.ZodArray<z.ZodEnum<{
+        id: "id";
+        ar: "ar";
+        bn: "bn";
+        ca: "ca";
+        de: "de";
+        en: "en";
+        es: "es";
+        fr: "fr";
+        hi: "hi";
+        it: "it";
+        ja: "ja";
+        pt: "pt";
+        ru: "ru";
+        tr: "tr";
+        zh: "zh";
+    }>>;
     invoice_settings: z.ZodObject<{
         default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
     }, z.core.$strict>;
@@ -98,6 +115,23 @@ export declare const createCustomerParams: z.ZodObject<{
         carrier: z.ZodOptional<z.ZodString>;
         tracking_number: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>>;
+    preferred_locales: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        id: "id";
+        ar: "ar";
+        bn: "bn";
+        ca: "ca";
+        de: "de";
+        en: "en";
+        es: "es";
+        fr: "fr";
+        hi: "hi";
+        it: "it";
+        ja: "ja";
+        pt: "pt";
+        ru: "ru";
+        tr: "tr";
+        zh: "zh";
+    }>>>;
     invoice_settings: z.ZodOptional<z.ZodObject<{
         default_payment_method: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>>;
@@ -134,6 +168,23 @@ export declare const updateCustomerParams: z.ZodObject<{
         carrier: z.ZodOptional<z.ZodString>;
         tracking_number: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>, z.ZodLiteral<"">]>>;
+    preferred_locales: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodEnum<{
+        id: "id";
+        ar: "ar";
+        bn: "bn";
+        ca: "ca";
+        de: "de";
+        en: "en";
+        es: "es";
+        fr: "fr";
+        hi: "hi";
+        it: "it";
+        ja: "ja";
+        pt: "pt";
+        ru: "ru";
+        tr: "tr";
+        zh: "zh";
+    }>>, z.ZodLiteral<"">]>>;
     invoice_settings: z.ZodOptional<z.ZodObject<{
         default_payment_method: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
     }, z.core.$strict>>;
@@ -196,6 +247,23 @@ export declare const customerRoutes: readonly [{
             carrier: z.ZodOptional<z.ZodString>;
             tracking_number: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>;
+        preferred_locales: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>>;
         invoice_settings: z.ZodOptional<z.ZodObject<{
             default_payment_method: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>;
@@ -233,6 +301,23 @@ export declare const customerRoutes: readonly [{
             carrier: z.ZodNullable<z.ZodString>;
             tracking_number: z.ZodNullable<z.ZodString>;
         }, z.core.$strict>>;
+        preferred_locales: z.ZodArray<z.ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
         invoice_settings: z.ZodObject<{
             default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
         }, z.core.$strict>;
@@ -318,6 +403,23 @@ export declare const customerRoutes: readonly [{
                 carrier: z.ZodNullable<z.ZodString>;
                 tracking_number: z.ZodNullable<z.ZodString>;
             }, z.core.$strict>>;
+            preferred_locales: z.ZodArray<z.ZodEnum<{
+                id: "id";
+                ar: "ar";
+                bn: "bn";
+                ca: "ca";
+                de: "de";
+                en: "en";
+                es: "es";
+                fr: "fr";
+                hi: "hi";
+                it: "it";
+                ja: "ja";
+                pt: "pt";
+                ru: "ru";
+                tr: "tr";
+                zh: "zh";
+            }>>;
             invoice_settings: z.ZodObject<{
                 default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
             }, z.core.$strict>;
@@ -391,6 +493,23 @@ export declare const customerRoutes: readonly [{
             carrier: z.ZodNullable<z.ZodString>;
             tracking_number: z.ZodNullable<z.ZodString>;
         }, z.core.$strict>>;
+        preferred_locales: z.ZodArray<z.ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
         invoice_settings: z.ZodObject<{
             default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
         }, z.core.$strict>;
@@ -460,6 +579,23 @@ export declare const customerRoutes: readonly [{
             carrier: z.ZodOptional<z.ZodString>;
             tracking_number: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>, z.ZodLiteral<"">]>>;
+        preferred_locales: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>, z.ZodLiteral<"">]>>;
         invoice_settings: z.ZodOptional<z.ZodObject<{
             default_payment_method: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
         }, z.core.$strict>>;
@@ -496,6 +632,23 @@ export declare const customerRoutes: readonly [{
             carrier: z.ZodNullable<z.ZodString>;
             tracking_number: z.ZodNullable<z.ZodString>;
         }, z.core.$strict>>;
+        preferred_locales: z.ZodArray<z.ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
         invoice_settings: z.ZodObject<{
             default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
         }, z.core.$strict>;
@@ -586,6 +739,23 @@ export declare const customerRoutes: readonly [{
                 carrier: z.ZodNullable<z.ZodString>;
                 tracking_number: z.ZodNullable<z.ZodString>;
             }, z.core.$strict>>;
+            preferred_locales: z.ZodArray<z.ZodEnum<{
+                id: "id";
+                ar: "ar";
+                bn: "bn";
+                ca: "ca";
+                de: "de";
+                en: "en";
+                es: "es";
+                fr: "fr";
+                hi: "hi";
+                it: "it";
+                ja: "ja";
+                pt: "pt";
+                ru: "ru";
+                tr: "tr";
+                zh: "zh";
+            }>>;
             invoice_settings: z.ZodObject<{
                 default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
             }, z.core.$strict>;

package/dist/types/resources/core/index.d.ts

@@ -37,6 +37,23 @@ export declare const coreRoutes: readonly [{
             carrier: import("zod").ZodOptional<import("zod").ZodString>;
             tracking_number: import("zod").ZodOptional<import("zod").ZodString>;
         }, import("zod/v4/core").$strict>>;
+        preferred_locales: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>>;
         invoice_settings: import("zod").ZodOptional<import("zod").ZodObject<{
             default_payment_method: import("zod").ZodOptional<import("zod").ZodString>;
         }, import("zod/v4/core").$strict>>;
@@ -74,6 +91,23 @@ export declare const coreRoutes: readonly [{
             carrier: import("zod").ZodNullable<import("zod").ZodString>;
             tracking_number: import("zod").ZodNullable<import("zod").ZodString>;
         }, import("zod/v4/core").$strict>>;
+        preferred_locales: import("zod").ZodArray<import("zod").ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
         invoice_settings: import("zod").ZodObject<{
             default_payment_method: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
         }, import("zod/v4/core").$strict>;
@@ -159,6 +193,23 @@ export declare const coreRoutes: readonly [{
                 carrier: import("zod").ZodNullable<import("zod").ZodString>;
                 tracking_number: import("zod").ZodNullable<import("zod").ZodString>;
             }, import("zod/v4/core").$strict>>;
+            preferred_locales: import("zod").ZodArray<import("zod").ZodEnum<{
+                id: "id";
+                ar: "ar";
+                bn: "bn";
+                ca: "ca";
+                de: "de";
+                en: "en";
+                es: "es";
+                fr: "fr";
+                hi: "hi";
+                it: "it";
+                ja: "ja";
+                pt: "pt";
+                ru: "ru";
+                tr: "tr";
+                zh: "zh";
+            }>>;
             invoice_settings: import("zod").ZodObject<{
                 default_payment_method: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
             }, import("zod/v4/core").$strict>;
@@ -232,6 +283,23 @@ export declare const coreRoutes: readonly [{
             carrier: import("zod").ZodNullable<import("zod").ZodString>;
             tracking_number: import("zod").ZodNullable<import("zod").ZodString>;
         }, import("zod/v4/core").$strict>>;
+        preferred_locales: import("zod").ZodArray<import("zod").ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
         invoice_settings: import("zod").ZodObject<{
             default_payment_method: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
         }, import("zod/v4/core").$strict>;
@@ -301,6 +369,23 @@ export declare const coreRoutes: readonly [{
             carrier: import("zod").ZodOptional<import("zod").ZodString>;
             tracking_number: import("zod").ZodOptional<import("zod").ZodString>;
         }, import("zod/v4/core").$strict>, import("zod").ZodLiteral<"">]>>;
+        preferred_locales: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodArray<import("zod").ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>, import("zod").ZodLiteral<"">]>>;
         invoice_settings: import("zod").ZodOptional<import("zod").ZodObject<{
             default_payment_method: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodString, import("zod").ZodLiteral<"">]>>;
         }, import("zod/v4/core").$strict>>;
@@ -337,6 +422,23 @@ export declare const coreRoutes: readonly [{
             carrier: import("zod").ZodNullable<import("zod").ZodString>;
             tracking_number: import("zod").ZodNullable<import("zod").ZodString>;
         }, import("zod/v4/core").$strict>>;
+        preferred_locales: import("zod").ZodArray<import("zod").ZodEnum<{
+            id: "id";
+            ar: "ar";
+            bn: "bn";
+            ca: "ca";
+            de: "de";
+            en: "en";
+            es: "es";
+            fr: "fr";
+            hi: "hi";
+            it: "it";
+            ja: "ja";
+            pt: "pt";
+            ru: "ru";
+            tr: "tr";
+            zh: "zh";
+        }>>;
         invoice_settings: import("zod").ZodObject<{
             default_payment_method: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
         }, import("zod/v4/core").$strict>;
@@ -427,6 +529,23 @@ export declare const coreRoutes: readonly [{
                 carrier: import("zod").ZodNullable<import("zod").ZodString>;
                 tracking_number: import("zod").ZodNullable<import("zod").ZodString>;
             }, import("zod/v4/core").$strict>>;
+            preferred_locales: import("zod").ZodArray<import("zod").ZodEnum<{
+                id: "id";
+                ar: "ar";
+                bn: "bn";
+                ca: "ca";
+                de: "de";
+                en: "en";
+                es: "es";
+                fr: "fr";
+                hi: "hi";
+                it: "it";
+                ja: "ja";
+                pt: "pt";
+                ru: "ru";
+                tr: "tr";
+                zh: "zh";
+            }>>;
             invoice_settings: import("zod").ZodObject<{
                 default_payment_method: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
             }, import("zod/v4/core").$strict>;

package/dist/types/resources/payments/index.d.ts

@@ -178,6 +178,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -402,6 +403,7 @@ export declare const paymentsRoutes: readonly [{
                 message: import("zod").ZodString;
             }, import("zod/v4/core").$strict>>;
             cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+                faircoin_network_closed: "faircoin_network_closed";
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
                 abandoned: "abandoned";
@@ -607,6 +609,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -826,6 +829,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1075,6 +1079,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1278,6 +1283,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1486,6 +1492,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1687,6 +1694,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1888,6 +1896,7 @@ export declare const paymentsRoutes: readonly [{
                 message: import("zod").ZodString;
             }, import("zod/v4/core").$strict>>;
             cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+                faircoin_network_closed: "faircoin_network_closed";
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
                 abandoned: "abandoned";
@@ -3703,7 +3712,7 @@ export declare const paymentsRoutes: readonly [{
     readonly path: "/v1/social/{username}/next_address";
     readonly tag: "Social payments";
     readonly summary: "Reserve an address to pay a person";
-    readonly description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`; paying yourself is refused.";
+    readonly description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`, and one whose wallet watches no further address (every index below its watched bound is taken) 503 `faircoin_receive_tree_full`; paying yourself is refused.";
     readonly auth: "user";
     readonly params: {
         readonly username: "The recipient’s Oxy username.";
@@ -3911,6 +3920,7 @@ export declare const paymentsRoutes: readonly [{
             message: import("zod").ZodString;
         }, import("zod/v4/core").$strict>>;
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";

package/dist/types/resources/payments/paymentIntents.d.ts

@@ -262,6 +262,7 @@ export declare const paymentIntentSchema: z.ZodObject<{
         message: z.ZodString;
     }, z.core.$strict>>;
     cancellation_reason: z.ZodNullable<z.ZodEnum<{
+        faircoin_network_closed: "faircoin_network_closed";
         duplicate: "duplicate";
         fraudulent: "fraudulent";
         abandoned: "abandoned";
@@ -770,6 +771,7 @@ export declare const paymentIntentRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -994,6 +996,7 @@ export declare const paymentIntentRoutes: readonly [{
                 message: z.ZodString;
             }, z.core.$strict>>;
             cancellation_reason: z.ZodNullable<z.ZodEnum<{
+                faircoin_network_closed: "faircoin_network_closed";
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
                 abandoned: "abandoned";
@@ -1199,6 +1202,7 @@ export declare const paymentIntentRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1418,6 +1422,7 @@ export declare const paymentIntentRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1667,6 +1672,7 @@ export declare const paymentIntentRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -1870,6 +1876,7 @@ export declare const paymentIntentRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -2078,6 +2085,7 @@ export declare const paymentIntentRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -2279,6 +2287,7 @@ export declare const paymentIntentRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";
@@ -2480,6 +2489,7 @@ export declare const paymentIntentRoutes: readonly [{
                 message: z.ZodString;
             }, z.core.$strict>>;
             cancellation_reason: z.ZodNullable<z.ZodEnum<{
+                faircoin_network_closed: "faircoin_network_closed";
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
                 abandoned: "abandoned";

package/dist/types/resources/payments/social.d.ts

@@ -166,7 +166,7 @@ export declare const socialRoutes: readonly [{
     readonly path: "/v1/social/{username}/next_address";
     readonly tag: "Social payments";
     readonly summary: "Reserve an address to pay a person";
-    readonly description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`; paying yourself is refused.";
+    readonly description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`, and one whose wallet watches no further address (every index below its watched bound is taken) 503 `faircoin_receive_tree_full`; paying yourself is refused.";
     readonly auth: "user";
     readonly params: {
         readonly username: "The recipient’s Oxy username.";

package/dist/types/resources/payments/testHelpers.d.ts

@@ -120,6 +120,7 @@ export declare const paymentIntentTestHelperRoutes: readonly [{
             message: z.ZodString;
         }, z.core.$strict>>;
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            faircoin_network_closed: "faircoin_network_closed";
             duplicate: "duplicate";
             fraudulent: "fraudulent";
             abandoned: "abandoned";

package/dist/types/vocabulary/errors.d.ts

@@ -109,6 +109,7 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly faircoin_wallet_missing: "The Peable wallet that receives this payment (the merchant owner's, or the seller's) isn't set up yet, so it cannot be paid in FairCoin. The other payment methods still work.";
     readonly faircoin_network_closed: "FairCoin payments on this network are not open on this deployment yet. The other payment methods still work.";
     readonly faircoin_capacity_reached: "Too many FairCoin payments to this recipient are waiting to be paid right now, so no new FairCoin address can be handed out. The other payment methods still work; try FairCoin again shortly.";
+    readonly faircoin_receive_tree_full: "Every FairCoin address the recipient's Peable wallet watches has been handed out, so no new one can be derived for them. Nothing was reserved.";
     readonly faircoin_amount_too_small: "One seller's share of this order is below the smallest amount the FairCoin network relays, so it cannot be paid in FairCoin. The other payment methods still work.";
     readonly credit_note_exceeds_invoice: "The credit note's amount exceeds what the invoice can still credit.";
     readonly test_clock_unexpected_state: "The test clock is advancing; wait until it is ready.";

package/dist/types/vocabulary/index.d.ts

@@ -18,3 +18,4 @@ export * from './identity';
 export * from './merchants';
 export * from './paymentMethodConfigurations';
 export * from './realtime';
+export * from './receiveTree';

package/dist/types/vocabulary/payments.d.ts

@@ -20,14 +20,17 @@ export declare const PAYMENT_INTENT_MAX_EXPIRES_IN_SECONDS: number;
 export declare const PAYMENT_INTENT_STATUSES: readonly ["requires_payment_method", "requires_confirmation", "requires_action", "processing", "requires_capture", "succeeded", "canceled"];
 export type PaymentIntentStatus = (typeof PAYMENT_INTENT_STATUSES)[number];
 /**
- * Why an intent was cancelled — Stripe's reasons, plus two FairCoin-only ones:
- * `underpaid` (a transaction paid less than the amount) and
+ * Why an intent was cancelled — Stripe's reasons, plus three FairCoin-only ones:
+ * `underpaid` (a transaction paid less than the amount),
  * `recipient_key_changed` (the recipient's identity key was replaced after the
  * address was reserved, so the address is no longer in the wallet it pays —
  * ADR 0002, amended 2026-11-06; nothing had been broadcast, and the order stays
- * open for a fresh address).
+ * open for a fresh address) and `faircoin_network_closed` (the deployment
+ * closed the payment's FairCoin network — ADR 0002's gate — before anything was
+ * broadcast; the order stays open, and FairCoin on it says the network is
+ * closed).
  */
-export declare const PAYMENT_INTENT_CANCELLATION_REASONS: readonly ["abandoned", "automatic", "duplicate", "fraudulent", "recipient_key_changed", "requested_by_customer", "underpaid"];
+export declare const PAYMENT_INTENT_CANCELLATION_REASONS: readonly ["abandoned", "automatic", "duplicate", "faircoin_network_closed", "fraudulent", "recipient_key_changed", "requested_by_customer", "underpaid"];
 export type PaymentIntentCancellationReason = (typeof PAYMENT_INTENT_CANCELLATION_REASONS)[number];
 /** The reasons a MERCHANT may give `POST /v1/payment_intents/:id/cancel`. */
 export declare const MERCHANT_CANCELLATION_REASONS: readonly ["abandoned", "duplicate", "fraudulent", "requested_by_customer"];

package/dist/types/vocabulary/receiveTree.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The size of a recipient's FairCoin receive tree (ADR 0021 D9, amended
+ * 2026-11-06) — ONE answer, read by the gateway that hands out indices and by
+ * the Peable wallet that watches them.
+ *
+ * Every FairCoin address the gateway reserves for an account — a merchant
+ * payment, a marketplace seller's, an invoice's, `@username` — is index `i` of
+ * that account's identity tree (ADR 0002, ADR 0021 D5). The wallet watches a
+ * contiguous window, indices `0 .. SOCIAL_RECEIVE_MAX_WATCHED - 1`, reaching
+ * {@link SOCIAL_RECEIVE_GAP_LIMIT} past the highest index reserved
+ * (`planSocialReceiveWindow` in `packages/frontend/src/wallet/social-receive.ts`),
+ * and stops offering `@username` once that reach would pass its bound. So an
+ * index is reserved only when the wallet, after reserving it, still reaches
+ * the gap above it inside its bound:
+ *
+ *     index + SOCIAL_RECEIVE_GAP_LIMIT  <=  SOCIAL_RECEIVE_MAX_WATCHED - 1
+ *     index                             <   SOCIAL_RECEIVE_INDEX_LIMIT
+ *
+ * The gateway refuses to mint `index >= SOCIAL_RECEIVE_INDEX_LIMIT` (in the
+ * reservation's own statement), so every address it hands out is inside the
+ * window the wallet watches. Zod-free and dependency-free: the wallet bundles
+ * this module alone (`@peable.to/contracts/vocabulary/receiveTree`).
+ */
+/** The most indices the wallet watches: `0 .. SOCIAL_RECEIVE_MAX_WATCHED - 1`. */
+export declare const SOCIAL_RECEIVE_MAX_WATCHED = 2000;
+/**
+ * How many unused addresses the wallet watches beyond the highest index used
+ * or reserved — the FairCoin BIP44 external-chain gap limit.
+ */
+export declare const SOCIAL_RECEIVE_GAP_LIMIT = 20;
+/**
+ * The first index the gateway never mints (exclusive bound): `1 980`. Every
+ * minted index `i` satisfies `i < SOCIAL_RECEIVE_INDEX_LIMIT`, i.e.
+ * `i + SOCIAL_RECEIVE_GAP_LIMIT <= SOCIAL_RECEIVE_MAX_WATCHED - 1`.
+ */
+export declare const SOCIAL_RECEIVE_INDEX_LIMIT: number;
+/**
+ * How close to {@link SOCIAL_RECEIVE_INDEX_LIMIT} a tree is "nearly full":
+ * Orbit warns the owners once fewer fresh indices than this are left.
+ */
+export declare const SOCIAL_RECEIVE_NEARLY_FULL_REMAINING = 200;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/contracts",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "description": "The Peable wire, declared once: Zod contracts of every public route, the OpenAPI 3.1 generator and the closed value sets (ADR 0014 D5).",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",