@peable.to/contracts 3.0.0 → 4.0.0

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

@@ -1,3 +1,16 @@
+/**
+ * Why FairCoin cannot be paid with on an order right now (ADR 0021). It is
+ * still offered — never hidden — and says why:
+ *
+ *  - `faircoin_wallet_missing` — the Peable wallet of the account that receives
+ *    (the merchant's owner, or the seller) isn't set up yet: no identity key;
+ *  - `faircoin_network_closed` — this deployment does not open payments on the
+ *    order's FairCoin network yet (ADR 0002's gate);
+ *  - `price_unavailable` — no fresh FairCoin price exists to quote a fiat order;
+ *  - `temporarily_unavailable` — whether the wallet exists could not be checked.
+ */
+export declare const FAIRCOIN_UNAVAILABLE_REASONS: readonly ["faircoin_wallet_missing", "faircoin_network_closed", "price_unavailable", "temporarily_unavailable"];
+export type FaircoinUnavailableReason = (typeof FAIRCOIN_UNAVAILABLE_REASONS)[number];
 export declare const CHECKOUT_SESSION_MODES: readonly ["payment", "setup", "subscription"];
 export type CheckoutSessionMode = (typeof CHECKOUT_SESSION_MODES)[number];
 export declare const CHECKOUT_SESSION_STATUSES: readonly ["open", "complete", "expired"];

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

@@ -34,6 +34,7 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly parameter_missing: "A required parameter is missing; `param` names it.";
     readonly parameter_unknown: "The request carries a parameter this route does not accept; `param` names it.";
     readonly payment_intent_unexpected_state: "The PaymentIntent is in a status that does not allow this operation.";
+    readonly payment_method_locked: "The payment method cannot be turned off or removed: FairCoin is always offered to every payer; `param` names the field.";
     readonly payout_not_allowed: "Payouts cannot be created for this account.";
     readonly rate_limited: "Too many requests; back off and retry.";
     readonly refund_not_cancelable: "The refund has already left a cancelable state.";
@@ -44,7 +45,6 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly test_mode_only: "This operation exists in test mode only.";
     readonly too_many_streams: "Too many live streams are open for this merchant.";
     readonly url_invalid: "The URL is not an allowed https URL.";
-    readonly watch_only_violation: "The extended key carries a private key. Peable only ever accepts watch-only (public) keys.";
     readonly webhook_endpoint_disabled: "The webhook endpoint is disabled.";
     readonly webhook_endpoint_limit_reached: "The merchant already has the maximum number of webhook endpoints.";
     readonly account_not_ready: "The connected account cannot take this payment yet: its onboarding or a capability is incomplete.";
@@ -105,6 +105,9 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly promotion_code_minimum_amount: "The purchase is below the promotion code minimum amount.";
     readonly payment_method_missing: "No payment method is available to charge.";
     readonly faircoin_cannot_debit: "A FairCoin invoice cannot be charged automatically: the payer signs every payment.";
+    readonly faircoin_price_unavailable: "No fresh FairCoin price exists right now, so this order cannot be quoted in FAIR. The other payment methods still work; try FairCoin again shortly.";
+    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 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.";
     readonly meter_event_customer_missing: "The meter event names no customer of this merchant.";
@@ -116,8 +119,7 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly network_mismatch: "The FairCoin network differs from the one this object uses.";
     readonly link_expired: "The onboarding link has expired or was already used; `refresh_url` is where the seller gets a fresh one.";
     readonly wrong_seller: "The onboarding link names a different Oxy account; sign in as the seller it was minted for.";
-    readonly already_registered: "The seller already registered a FairCoin key, and it cannot be changed.";
-    readonly key_in_use: "The key already receives payments for another account.";
+    readonly already_registered: "The seller already confirmed FairCoin payments into their Peable wallet.";
     readonly no_faircoin_half: "The connected account has no FairCoin half to register a key for.";
     readonly merchant_missing: "The application has no merchant in this environment yet; register one (Orbit shows \"Set up payments\").";
     readonly application_membership_required: "The signed-in Oxy account is not a member of the account that owns this application.";

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

@@ -146,8 +146,12 @@ export type WebhookEndpointStatus = (typeof WEBHOOK_ENDPOINT_STATUSES)[number];
  *  - `delivery_failures`    — every delivery to it failed for three days
  *    straight, so Peable stopped sending. Re-enabling it (`disabled: false`)
  *    starts the clock again.
+ *  - `url_refused`          — its stored `url` breaks the rules a URL is
+ *    registered under (https in live mode, ports 80/443, no private, loopback
+ *    or reserved address), judged again before every delivery, so Peable never
+ *    sent to it. It is re-enabled only together with a `url` that passes.
  */
-export declare const WEBHOOK_ENDPOINT_DISABLED_REASONS: readonly ["disabled_by_merchant", "delivery_failures"];
+export declare const WEBHOOK_ENDPOINT_DISABLED_REASONS: readonly ["disabled_by_merchant", "delivery_failures", "url_refused"];
 export type WebhookEndpointDisabledReason = (typeof WEBHOOK_ENDPOINT_DISABLED_REASONS)[number];
 /** At most this many endpoints per merchant (per mode). */
 export declare const WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT = 16;

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

@@ -1,6 +1,13 @@
-import { type FiatCurrencyCode } from './money';
+import { type CurrencyCode } from './money';
 /**
- * The methods a configuration can turn on.
+ * The methods a configuration lists.
+ *
+ * `faircoin` is listed and LOCKED (ADR 0021 D2): every payer can always pay
+ * with FairCoin, so its entry is always `display_preference.value: 'on'` with
+ * `locked: true`, and a create or update that sets it `off` is refused with
+ * `payment_method_locked`. It is the chain rail, never a card-provider method:
+ * it is never pushed to the provider and never appears in a card PaymentIntent's
+ * `payment_method_types`. Every other method is the merchant's to turn on and off.
  *
  * `apple_pay` and `google_pay` are WALLETS over a card: a payment made with one
  * is a `card` payment, so they appear here and never in a PaymentIntent's
@@ -11,19 +18,26 @@ import { type FiatCurrencyCode } from './money';
  * checkout, `payment-provider-boundary.md`) and giropay (discontinued by the
  * scheme).
  */
-export declare const PAYMENT_METHOD_CONFIGURATION_TYPES: readonly ["card", "apple_pay", "google_pay", "sepa_debit", "ideal", "bancontact", "eps", "bizum"];
+export declare const PAYMENT_METHOD_CONFIGURATION_TYPES: readonly ["faircoin", "card", "apple_pay", "google_pay", "sepa_debit", "ideal", "bancontact", "eps", "bizum"];
 export type PaymentMethodConfigurationType = (typeof PAYMENT_METHOD_CONFIGURATION_TYPES)[number];
 /**
  * Why a method cannot be offered whatever the merchant chooses.
  *
  *  - `provider_unsupported` — the processing provider does not offer it;
- *  - `requires_card` — a wallet rides on card payments, and card is off.
+ *  - `requires_card` — a wallet rides on card payments, and card is off;
+ *  - `faircoin_wallet_missing` — the Peable wallet of the account that owns
+ *    the merchant isn't set up yet (no identity key), so FairCoin cannot be
+ *    received (ADR 0021 D5); the owner sets it up in Peable;
+ *  - `faircoin_network_closed` — the deployment does not open the merchant's
+ *    FairCoin network yet (ADR 0002's gate);
+ *  - `temporarily_unavailable` — the wallet could not be checked just now.
  */
-export declare const PAYMENT_METHOD_UNAVAILABLE_REASONS: readonly ["provider_unsupported", "requires_card"];
+export declare const PAYMENT_METHOD_UNAVAILABLE_REASONS: readonly ["provider_unsupported", "requires_card", "faircoin_wallet_missing", "faircoin_network_closed", "temporarily_unavailable"];
 export type PaymentMethodUnavailableReason = (typeof PAYMENT_METHOD_UNAVAILABLE_REASONS)[number];
 /**
  * The currencies each method can take a payment in. A method is offered on a
  * payment only when its currency is listed — so iDEAL never appears on a USD
- * payment, and a payer is never shown a method that would fail.
+ * payment, and a payer is never shown a method that would fail. FairCoin takes
+ * every currency: a `FAIR` order directly, a fiat one at a quoted price (ADR 0021).
  */
-export declare const PAYMENT_METHOD_CURRENCIES: Readonly<Record<PaymentMethodConfigurationType, readonly FiatCurrencyCode[]>>;
+export declare const PAYMENT_METHOD_CURRENCIES: Readonly<Record<PaymentMethodConfigurationType, readonly CurrencyCode[]>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/contracts",
-  "version": "3.0.0",
+  "version": "4.0.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",