@peable.to/contracts 3.1.0 → 4.1.0

package/dist/types/resources/connect/balance.d.ts

@@ -57,8 +57,8 @@ export declare const balanceTransactionSchema: z.ZodObject<{
         refund: "refund";
         dispute: "dispute";
         adjustment: "adjustment";
-        other: "other";
         payment: "payment";
+        other: "other";
         payment_refund: "payment_refund";
         application_fee_refund: "application_fee_refund";
         payout_cancel: "payout_cancel";
@@ -79,6 +79,37 @@ export declare const balanceTransactionSchema: z.ZodObject<{
     created: z.ZodNumber;
     description: z.ZodNullable<z.ZodString>;
     exchange_rate: z.ZodNullable<z.ZodNumber>;
+    faircoin_quote: z.ZodNullable<z.ZodObject<{
+        currency: z.ZodEnum<{
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        amount: z.ZodString;
+        rate: z.ZodString;
+        price: z.ZodObject<{
+            source: z.ZodLiteral<"wfair-base">;
+            usd_per_fair: z.ZodString;
+            observed_at: z.ZodNumber;
+        }, z.core.$strict>;
+        reference_rates: z.ZodNullable<z.ZodObject<{
+            source: z.ZodLiteral<"ecb">;
+            usd_per_eur: z.ZodString;
+            currency_per_eur: z.ZodString;
+            observed_at: z.ZodNumber;
+        }, z.core.$strict>>;
+        quoted_at: z.ZodNumber;
+        expires_at: z.ZodNumber;
+    }, z.core.$strict>>;
     fee_details: z.ZodArray<z.ZodObject<{
         amount: z.ZodString;
         currency: z.ZodString;
@@ -150,8 +181,8 @@ export declare const listBalanceTransactionsQuery: z.ZodObject<{
         refund: "refund";
         dispute: "dispute";
         adjustment: "adjustment";
-        other: "other";
         payment: "payment";
+        other: "other";
         payment_refund: "payment_refund";
         application_fee_refund: "application_fee_refund";
         payout_cancel: "payout_cancel";
@@ -253,8 +284,8 @@ export declare const balanceRoutes: readonly [{
             refund: "refund";
             dispute: "dispute";
             adjustment: "adjustment";
-            other: "other";
             payment: "payment";
+            other: "other";
             payment_refund: "payment_refund";
             application_fee_refund: "application_fee_refund";
             payout_cancel: "payout_cancel";
@@ -287,8 +318,8 @@ export declare const balanceRoutes: readonly [{
                 refund: "refund";
                 dispute: "dispute";
                 adjustment: "adjustment";
-                other: "other";
                 payment: "payment";
+                other: "other";
                 payment_refund: "payment_refund";
                 application_fee_refund: "application_fee_refund";
                 payout_cancel: "payout_cancel";
@@ -309,6 +340,37 @@ export declare const balanceRoutes: readonly [{
             created: z.ZodNumber;
             description: z.ZodNullable<z.ZodString>;
             exchange_rate: z.ZodNullable<z.ZodNumber>;
+            faircoin_quote: z.ZodNullable<z.ZodObject<{
+                currency: z.ZodEnum<{
+                    EUR: "EUR";
+                    USD: "USD";
+                    GBP: "GBP";
+                    CHF: "CHF";
+                    SEK: "SEK";
+                    NOK: "NOK";
+                    DKK: "DKK";
+                    PLN: "PLN";
+                    CZK: "CZK";
+                    CAD: "CAD";
+                    AUD: "AUD";
+                    JPY: "JPY";
+                }>;
+                amount: z.ZodString;
+                rate: z.ZodString;
+                price: z.ZodObject<{
+                    source: z.ZodLiteral<"wfair-base">;
+                    usd_per_fair: z.ZodString;
+                    observed_at: z.ZodNumber;
+                }, z.core.$strict>;
+                reference_rates: z.ZodNullable<z.ZodObject<{
+                    source: z.ZodLiteral<"ecb">;
+                    usd_per_eur: z.ZodString;
+                    currency_per_eur: z.ZodString;
+                    observed_at: z.ZodNumber;
+                }, z.core.$strict>>;
+                quoted_at: z.ZodNumber;
+                expires_at: z.ZodNumber;
+            }, z.core.$strict>>;
             fee_details: z.ZodArray<z.ZodObject<{
                 amount: z.ZodString;
                 currency: z.ZodString;
@@ -359,8 +421,8 @@ export declare const balanceRoutes: readonly [{
             refund: "refund";
             dispute: "dispute";
             adjustment: "adjustment";
-            other: "other";
             payment: "payment";
+            other: "other";
             payment_refund: "payment_refund";
             application_fee_refund: "application_fee_refund";
             payout_cancel: "payout_cancel";
@@ -381,6 +443,37 @@ export declare const balanceRoutes: readonly [{
         created: z.ZodNumber;
         description: z.ZodNullable<z.ZodString>;
         exchange_rate: z.ZodNullable<z.ZodNumber>;
+        faircoin_quote: z.ZodNullable<z.ZodObject<{
+            currency: z.ZodEnum<{
+                EUR: "EUR";
+                USD: "USD";
+                GBP: "GBP";
+                CHF: "CHF";
+                SEK: "SEK";
+                NOK: "NOK";
+                DKK: "DKK";
+                PLN: "PLN";
+                CZK: "CZK";
+                CAD: "CAD";
+                AUD: "AUD";
+                JPY: "JPY";
+            }>;
+            amount: z.ZodString;
+            rate: z.ZodString;
+            price: z.ZodObject<{
+                source: z.ZodLiteral<"wfair-base">;
+                usd_per_fair: z.ZodString;
+                observed_at: z.ZodNumber;
+            }, z.core.$strict>;
+            reference_rates: z.ZodNullable<z.ZodObject<{
+                source: z.ZodLiteral<"ecb">;
+                usd_per_eur: z.ZodString;
+                currency_per_eur: z.ZodString;
+                observed_at: z.ZodNumber;
+            }, z.core.$strict>>;
+            quoted_at: z.ZodNumber;
+            expires_at: z.ZodNumber;
+        }, z.core.$strict>>;
         fee_details: z.ZodArray<z.ZodObject<{
             amount: z.ZodString;
             currency: z.ZodString;

package/dist/types/resources/connect/connectedAccounts.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { type Expand } from '../../common/objects';
-/** The FairCoin half of a seller's account. The seller's xpub is deliberately ABSENT (ADR 0012 D6). */
+/** The FairCoin half of a seller's account: paid into the Peable wallet of the seller's own Oxy account (ADR 0021 D5). */
 export declare const connectedAccountFaircoinSchema: z.ZodObject<{
     network: z.ZodEnum<{
         mainnet: "mainnet";
@@ -71,9 +71,9 @@ declare module '../../common/objects' {
  * `POST /v1/connected_accounts`: open (or return) the account for one seller.
  *
  * Two halves, at least one: the CARD half (`country` + `business_type`, both or
- * neither) and the FAIRCOIN half (`faircoin`). There is deliberately no `xpub`
- * here: the key comes from the SELLER's own session, never from the platform
- * (ADR 0012 D3).
+ * neither) and the FAIRCOIN half (`faircoin`). There is no key: the seller's
+ * FairCoin goes to their own account's Peable wallet, confirmed only from the
+ * SELLER's own session (ADR 0012 D3, ADR 0021 D5).
  */
 export declare const createConnectedAccountParams: z.ZodObject<{
     external_ref: z.ZodString;

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

@@ -691,8 +691,8 @@ export declare const connectRoutes: readonly [{
             refund: "refund";
             dispute: "dispute";
             adjustment: "adjustment";
-            other: "other";
             payment: "payment";
+            other: "other";
             payment_refund: "payment_refund";
             application_fee_refund: "application_fee_refund";
             payout_cancel: "payout_cancel";
@@ -725,8 +725,8 @@ export declare const connectRoutes: readonly [{
                 refund: "refund";
                 dispute: "dispute";
                 adjustment: "adjustment";
-                other: "other";
                 payment: "payment";
+                other: "other";
                 payment_refund: "payment_refund";
                 application_fee_refund: "application_fee_refund";
                 payout_cancel: "payout_cancel";
@@ -747,6 +747,37 @@ export declare const connectRoutes: readonly [{
             created: import("zod").ZodNumber;
             description: import("zod").ZodNullable<import("zod").ZodString>;
             exchange_rate: import("zod").ZodNullable<import("zod").ZodNumber>;
+            faircoin_quote: import("zod").ZodNullable<import("zod").ZodObject<{
+                currency: import("zod").ZodEnum<{
+                    EUR: "EUR";
+                    USD: "USD";
+                    GBP: "GBP";
+                    CHF: "CHF";
+                    SEK: "SEK";
+                    NOK: "NOK";
+                    DKK: "DKK";
+                    PLN: "PLN";
+                    CZK: "CZK";
+                    CAD: "CAD";
+                    AUD: "AUD";
+                    JPY: "JPY";
+                }>;
+                amount: import("zod").ZodString;
+                rate: import("zod").ZodString;
+                price: import("zod").ZodObject<{
+                    source: import("zod").ZodLiteral<"wfair-base">;
+                    usd_per_fair: import("zod").ZodString;
+                    observed_at: import("zod").ZodNumber;
+                }, import("zod/v4/core").$strict>;
+                reference_rates: import("zod").ZodNullable<import("zod").ZodObject<{
+                    source: import("zod").ZodLiteral<"ecb">;
+                    usd_per_eur: import("zod").ZodString;
+                    currency_per_eur: import("zod").ZodString;
+                    observed_at: import("zod").ZodNumber;
+                }, import("zod/v4/core").$strict>>;
+                quoted_at: import("zod").ZodNumber;
+                expires_at: import("zod").ZodNumber;
+            }, import("zod/v4/core").$strict>>;
             fee_details: import("zod").ZodArray<import("zod").ZodObject<{
                 amount: import("zod").ZodString;
                 currency: import("zod").ZodString;
@@ -797,8 +828,8 @@ export declare const connectRoutes: readonly [{
             refund: "refund";
             dispute: "dispute";
             adjustment: "adjustment";
-            other: "other";
             payment: "payment";
+            other: "other";
             payment_refund: "payment_refund";
             application_fee_refund: "application_fee_refund";
             payout_cancel: "payout_cancel";
@@ -819,6 +850,37 @@ export declare const connectRoutes: readonly [{
         created: import("zod").ZodNumber;
         description: import("zod").ZodNullable<import("zod").ZodString>;
         exchange_rate: import("zod").ZodNullable<import("zod").ZodNumber>;
+        faircoin_quote: import("zod").ZodNullable<import("zod").ZodObject<{
+            currency: import("zod").ZodEnum<{
+                EUR: "EUR";
+                USD: "USD";
+                GBP: "GBP";
+                CHF: "CHF";
+                SEK: "SEK";
+                NOK: "NOK";
+                DKK: "DKK";
+                PLN: "PLN";
+                CZK: "CZK";
+                CAD: "CAD";
+                AUD: "AUD";
+                JPY: "JPY";
+            }>;
+            amount: import("zod").ZodString;
+            rate: import("zod").ZodString;
+            price: import("zod").ZodObject<{
+                source: import("zod").ZodLiteral<"wfair-base">;
+                usd_per_fair: import("zod").ZodString;
+                observed_at: import("zod").ZodNumber;
+            }, import("zod/v4/core").$strict>;
+            reference_rates: import("zod").ZodNullable<import("zod").ZodObject<{
+                source: import("zod").ZodLiteral<"ecb">;
+                usd_per_eur: import("zod").ZodString;
+                currency_per_eur: import("zod").ZodString;
+                observed_at: import("zod").ZodNumber;
+            }, import("zod/v4/core").$strict>>;
+            quoted_at: import("zod").ZodNumber;
+            expires_at: import("zod").ZodNumber;
+        }, import("zod/v4/core").$strict>>;
         fee_details: import("zod").ZodArray<import("zod").ZodObject<{
             amount: import("zod").ZodString;
             currency: import("zod").ZodString;
@@ -1114,8 +1176,8 @@ export declare const connectRoutes: readonly [{
                 refund: "refund";
                 dispute: "dispute";
                 adjustment: "adjustment";
-                other: "other";
                 payment: "payment";
+                other: "other";
                 payment_refund: "payment_refund";
                 application_fee_refund: "application_fee_refund";
                 payout_cancel: "payout_cancel";
@@ -1136,6 +1198,37 @@ export declare const connectRoutes: readonly [{
             created: import("zod").ZodNumber;
             description: import("zod").ZodNullable<import("zod").ZodString>;
             exchange_rate: import("zod").ZodNullable<import("zod").ZodNumber>;
+            faircoin_quote: import("zod").ZodNullable<import("zod").ZodObject<{
+                currency: import("zod").ZodEnum<{
+                    EUR: "EUR";
+                    USD: "USD";
+                    GBP: "GBP";
+                    CHF: "CHF";
+                    SEK: "SEK";
+                    NOK: "NOK";
+                    DKK: "DKK";
+                    PLN: "PLN";
+                    CZK: "CZK";
+                    CAD: "CAD";
+                    AUD: "AUD";
+                    JPY: "JPY";
+                }>;
+                amount: import("zod").ZodString;
+                rate: import("zod").ZodString;
+                price: import("zod").ZodObject<{
+                    source: import("zod").ZodLiteral<"wfair-base">;
+                    usd_per_fair: import("zod").ZodString;
+                    observed_at: import("zod").ZodNumber;
+                }, import("zod/v4/core").$strict>;
+                reference_rates: import("zod").ZodNullable<import("zod").ZodObject<{
+                    source: import("zod").ZodLiteral<"ecb">;
+                    usd_per_eur: import("zod").ZodString;
+                    currency_per_eur: import("zod").ZodString;
+                    observed_at: import("zod").ZodNumber;
+                }, import("zod/v4/core").$strict>>;
+                quoted_at: import("zod").ZodNumber;
+                expires_at: import("zod").ZodNumber;
+            }, import("zod/v4/core").$strict>>;
             fee_details: import("zod").ZodArray<import("zod").ZodObject<{
                 amount: import("zod").ZodString;
                 currency: import("zod").ZodString;
@@ -1322,19 +1415,17 @@ export declare const connectRoutes: readonly [{
         return_url: import("zod").ZodString;
     }, import("zod/v4/core").$strict>;
 }, {
-    readonly operationId: "registerConnectOnboardingFaircoinKey";
+    readonly operationId: "confirmConnectOnboardingFaircoin";
     readonly method: "post";
     readonly path: "/v1/connect/onboarding/{token}/faircoin";
     readonly tag: "Connect onboarding";
-    readonly summary: "Register the seller's FairCoin key";
-    readonly description: "The ONLY way a key reaches a connected account: runs the non-custody firewall, consumes the link and tells the platform (`connected_account.updated`), in one transaction. The key is immutable once registered and never appears on any response.";
+    readonly summary: "Confirm FairCoin payments into the seller’s Peable wallet";
+    readonly description: "The seller, signed in as the account the link names, confirms that FairCoin paid to them goes to that account’s Peable wallet (ADR 0021 D5) — the only way a FairCoin half becomes payable. No key is sent: addresses derive from the account’s public identity key. 409 `faircoin_wallet_missing` while the account has no Peable wallet yet. Consumes the link and tells the platform (`connected_account.updated`) in one transaction.";
     readonly auth: "user";
     readonly params: {
         readonly token: "The onboarding link token (the last segment of its `url`).";
     };
-    readonly body: import("zod").ZodObject<{
-        xpub: import("zod").ZodString;
-    }, import("zod/v4/core").$strict>;
+    readonly body: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
     readonly response: import("zod").ZodObject<{
         object: import("zod").ZodLiteral<"connect_onboarding">;
         account_id: import("zod").ZodString;

package/dist/types/resources/connect/onboarding.d.ts

@@ -4,10 +4,10 @@ import { type Expand } from '../../common/objects';
  * The SELLER-facing half of FairCoin connected accounts (ADR 0012 D3).
  *
  * A platform mints an onboarding link for a seller's account; the SELLER opens
- * it signed in with Oxy and registers the watch-only key their FairCoin will be
- * paid to. These routes are `auth: 'user'` — the seller's own session, never a
- * service token — because the key that decides who receives a seller's money is
- * accepted only from the seller. A platform cannot reach them at all, and the
+ * it signed in with Oxy and confirms that their FairCoin is paid into the
+ * Peable wallet of that account (ADR 0021 D5). These routes are `auth: 'user'`
+ * — the seller's own session, never a service token — because who receives a
+ * seller's money is the seller's consent. A platform cannot reach them at all, and the
  * link token alone is not enough without the session it names.
  */
 export declare const connectOnboardingSchema: z.ZodObject<{
@@ -40,11 +40,13 @@ declare module '../../common/objects' {
         connect_onboarding: ConnectOnboarding;
     }
 }
-/** `POST /v1/connect/onboarding/{token}/faircoin` — the seller's watch-only ACCOUNT xpub. */
-export declare const registerFaircoinKeyParams: z.ZodObject<{
-    xpub: z.ZodString;
-}, z.core.$strict>;
-export type RegisterFaircoinKeyParams = z.input<typeof registerFaircoinKeyParams>;
+/**
+ * `POST /v1/connect/onboarding/{token}/faircoin` takes nothing: the seller
+ * confirms, in their own Oxy session, that their FairCoin is paid into the
+ * Peable wallet of that account (ADR 0021 D5). No key travels.
+ */
+export declare const confirmFaircoinOnboardingParams: z.ZodObject<{}, z.core.$strict>;
+export type ConfirmFaircoinOnboardingParams = z.input<typeof confirmFaircoinOnboardingParams>;
 export declare const connectOnboardingRoutes: readonly [{
     readonly operationId: "retrieveConnectOnboarding";
     readonly method: "get";
@@ -73,19 +75,17 @@ export declare const connectOnboardingRoutes: readonly [{
         return_url: z.ZodString;
     }, z.core.$strict>;
 }, {
-    readonly operationId: "registerConnectOnboardingFaircoinKey";
+    readonly operationId: "confirmConnectOnboardingFaircoin";
     readonly method: "post";
     readonly path: "/v1/connect/onboarding/{token}/faircoin";
     readonly tag: "Connect onboarding";
-    readonly summary: "Register the seller's FairCoin key";
-    readonly description: "The ONLY way a key reaches a connected account: runs the non-custody firewall, consumes the link and tells the platform (`connected_account.updated`), in one transaction. The key is immutable once registered and never appears on any response.";
+    readonly summary: "Confirm FairCoin payments into the seller’s Peable wallet";
+    readonly description: "The seller, signed in as the account the link names, confirms that FairCoin paid to them goes to that account’s Peable wallet (ADR 0021 D5) — the only way a FairCoin half becomes payable. No key is sent: addresses derive from the account’s public identity key. 409 `faircoin_wallet_missing` while the account has no Peable wallet yet. Consumes the link and tells the platform (`connected_account.updated`) in one transaction.";
     readonly auth: "user";
     readonly params: {
         readonly token: "The onboarding link token (the last segment of its `url`).";
     };
-    readonly body: z.ZodObject<{
-        xpub: z.ZodString;
-    }, z.core.$strict>;
+    readonly body: z.ZodObject<{}, z.core.$strict>;
     readonly response: z.ZodObject<{
         object: z.ZodLiteral<"connect_onboarding">;
         account_id: z.ZodString;

package/dist/types/resources/connect/payouts.d.ts

@@ -61,8 +61,8 @@ export declare const payoutReconciliationReportSchema: z.ZodObject<{
             refund: "refund";
             dispute: "dispute";
             adjustment: "adjustment";
-            other: "other";
             payment: "payment";
+            other: "other";
             payment_refund: "payment_refund";
             application_fee_refund: "application_fee_refund";
             payout_cancel: "payout_cancel";
@@ -83,6 +83,37 @@ export declare const payoutReconciliationReportSchema: z.ZodObject<{
         created: z.ZodNumber;
         description: z.ZodNullable<z.ZodString>;
         exchange_rate: z.ZodNullable<z.ZodNumber>;
+        faircoin_quote: z.ZodNullable<z.ZodObject<{
+            currency: z.ZodEnum<{
+                EUR: "EUR";
+                USD: "USD";
+                GBP: "GBP";
+                CHF: "CHF";
+                SEK: "SEK";
+                NOK: "NOK";
+                DKK: "DKK";
+                PLN: "PLN";
+                CZK: "CZK";
+                CAD: "CAD";
+                AUD: "AUD";
+                JPY: "JPY";
+            }>;
+            amount: z.ZodString;
+            rate: z.ZodString;
+            price: z.ZodObject<{
+                source: z.ZodLiteral<"wfair-base">;
+                usd_per_fair: z.ZodString;
+                observed_at: z.ZodNumber;
+            }, z.core.$strict>;
+            reference_rates: z.ZodNullable<z.ZodObject<{
+                source: z.ZodLiteral<"ecb">;
+                usd_per_eur: z.ZodString;
+                currency_per_eur: z.ZodString;
+                observed_at: z.ZodNumber;
+            }, z.core.$strict>>;
+            quoted_at: z.ZodNumber;
+            expires_at: z.ZodNumber;
+        }, z.core.$strict>>;
         fee_details: z.ZodArray<z.ZodObject<{
             amount: z.ZodString;
             currency: z.ZodString;
@@ -471,8 +502,8 @@ export declare const payoutRoutes: readonly [{
                 refund: "refund";
                 dispute: "dispute";
                 adjustment: "adjustment";
-                other: "other";
                 payment: "payment";
+                other: "other";
                 payment_refund: "payment_refund";
                 application_fee_refund: "application_fee_refund";
                 payout_cancel: "payout_cancel";
@@ -493,6 +524,37 @@ export declare const payoutRoutes: readonly [{
             created: z.ZodNumber;
             description: z.ZodNullable<z.ZodString>;
             exchange_rate: z.ZodNullable<z.ZodNumber>;
+            faircoin_quote: z.ZodNullable<z.ZodObject<{
+                currency: z.ZodEnum<{
+                    EUR: "EUR";
+                    USD: "USD";
+                    GBP: "GBP";
+                    CHF: "CHF";
+                    SEK: "SEK";
+                    NOK: "NOK";
+                    DKK: "DKK";
+                    PLN: "PLN";
+                    CZK: "CZK";
+                    CAD: "CAD";
+                    AUD: "AUD";
+                    JPY: "JPY";
+                }>;
+                amount: z.ZodString;
+                rate: z.ZodString;
+                price: z.ZodObject<{
+                    source: z.ZodLiteral<"wfair-base">;
+                    usd_per_fair: z.ZodString;
+                    observed_at: z.ZodNumber;
+                }, z.core.$strict>;
+                reference_rates: z.ZodNullable<z.ZodObject<{
+                    source: z.ZodLiteral<"ecb">;
+                    usd_per_eur: z.ZodString;
+                    currency_per_eur: z.ZodString;
+                    observed_at: z.ZodNumber;
+                }, z.core.$strict>>;
+                quoted_at: z.ZodNumber;
+                expires_at: z.ZodNumber;
+            }, z.core.$strict>>;
             fee_details: z.ZodArray<z.ZodObject<{
                 amount: z.ZodString;
                 currency: z.ZodString;