@peable.to/contracts 0.4.0 → 1.1.0

package/dist/cjs/resources/connect/account.js

@@ -0,0 +1,332 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.accountRoutes = exports.createAccountLinkParams = exports.updateAccountParams = exports.accountLinkSchema = exports.accountSchema = exports.accountSettingsSchema = exports.accountPayoutScheduleSchema = exports.accountBusinessProfileSchema = exports.accountRequirementsSchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const connect_1 = require("../../vocabulary/connect");
+/**
+ * The merchant's fiat account (ADR 0015 §1) — `GET /v1/account`.
+ *
+ * Orbit's funds never reach a Peable bank account: a merchant that takes fiat
+ * has its OWN provider account, opened and onboarded through Peable, and this
+ * object mirrors it. Everything here is what the provider last reported; the
+ * provider is the authority and Orbit never decides readiness itself. The
+ * provider's own `acct_…` never crosses (ADR 0016 D2).
+ *
+ * A marketplace's sellers (`/v1/connected_accounts`) are provider accounts too,
+ * and a platform reads one of them in this same shape by sending
+ * `Peable-Account: ca_…` to `GET /v1/account`.
+ */
+const capabilityStatus = zod_1.z.enum(connect_1.ACCOUNT_CAPABILITY_STATUSES);
+/**
+ * What the provider is waiting on. Requirement IDENTIFIERS only
+ * (`individual.verification.document`), never their values: the gateway
+ * records that a document is owed and never learns what it says.
+ */
+exports.accountRequirementsSchema = (0, objects_1.defineComponent)('AccountRequirements', zod_1.z
+    .object({
+    currently_due: zod_1.z.array(zod_1.z.string()),
+    eventually_due: zod_1.z.array(zod_1.z.string()),
+    past_due: zod_1.z.array(zod_1.z.string()),
+    pending_verification: zod_1.z
+        .array(zod_1.z.string())
+        .describe('Submitted and being checked — nothing for the merchant to do.'),
+    disabled_reason: zod_1.z
+        .string()
+        .nullable()
+        .describe("Why charges or payouts are disabled, in the provider's own code, or `null`."),
+})
+    .strict());
+exports.accountBusinessProfileSchema = (0, objects_1.defineComponent)('AccountBusinessProfile', zod_1.z
+    .object({
+    name: zod_1.z.string().nullable(),
+    url: zod_1.z.string().nullable(),
+    support_email: zod_1.z.string().nullable(),
+    support_url: zod_1.z.string().nullable(),
+    product_description: zod_1.z.string().nullable(),
+    mcc: zod_1.z.string().nullable().describe('Merchant category code.'),
+})
+    .strict());
+/**
+ * When the provider pays the balance out. `manual` means only an explicit
+ * `POST /v1/payouts` does — the provider still executes it; Orbit never moves
+ * the money itself (ADR 0015 §4).
+ */
+exports.accountPayoutScheduleSchema = (0, objects_1.defineComponent)('AccountPayoutSchedule', zod_1.z
+    .object({
+    interval: zod_1.z.enum(connect_1.PAYOUT_INTERVALS),
+    delay_days: zod_1.z
+        .number()
+        .int()
+        .nullable()
+        .describe('Days between a payment and its funds becoming payable; `null` when not reported.'),
+    weekly_anchor: zod_1.z.enum(connect_1.PAYOUT_WEEKLY_ANCHORS).nullable().describe('`weekly` only.'),
+    monthly_anchor: zod_1.z
+        .number()
+        .int()
+        .nullable()
+        .describe('`monthly` only: the day of the month, 1–31.'),
+})
+    .strict());
+exports.accountSettingsSchema = (0, objects_1.defineComponent)('AccountSettings', zod_1.z
+    .object({
+    payouts: zod_1.z
+        .object({
+        schedule: exports.accountPayoutScheduleSchema.nullable(),
+        statement_descriptor: zod_1.z
+            .string()
+            .nullable()
+            .describe("What the merchant's bank statement shows for a payout."),
+    })
+        .strict(),
+    payments: zod_1.z
+        .object({
+        statement_descriptor: zod_1.z
+            .string()
+            .nullable()
+            .describe("What a cardholder's statement shows — the merchant is the merchant of record."),
+    })
+        .strict(),
+    branding: zod_1.z
+        .object({
+        primary_color: zod_1.z.string().nullable(),
+        secondary_color: zod_1.z.string().nullable(),
+    })
+        .strict(),
+})
+    .strict());
+exports.accountSchema = (0, objects_1.defineObject)('account', 'Account', zod_1.z
+    .object({
+    id: zod_1.z.string().describe('`ca_…` — the same id space as a marketplace seller.'),
+    object: zod_1.z.literal('account'),
+    livemode: primitives_1.livemode,
+    type: zod_1.z.enum(connect_1.ACCOUNT_TYPES),
+    country: zod_1.z.string().describe('ISO 3166-1 alpha-2. Fixed at the provider once created.'),
+    default_currency: zod_1.z.string().nullable(),
+    business_profile: exports.accountBusinessProfileSchema,
+    capabilities: zod_1.z
+        .object({
+        card_payments: capabilityStatus.nullable(),
+        transfers: capabilityStatus.nullable(),
+    })
+        .strict()
+        .describe('`null`: never requested — a different fact from the provider declining it.'),
+    requirements: exports.accountRequirementsSchema,
+    charges_enabled: zod_1.z
+        .boolean()
+        .describe('Whether the account can take payments as merchant of record (`on_behalf_of`).'),
+    payouts_enabled: zod_1.z
+        .boolean()
+        .describe("Whether the provider will pay this account's balance out."),
+    settings: exports.accountSettingsSchema,
+    last_synced_at: primitives_1.unixSeconds
+        .nullable()
+        .describe('The last provider read; `null` before the first one completed.'),
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'ca_0193b8f2c1a87d3e9f4a',
+            object: 'account',
+            livemode: false,
+            type: 'merchant',
+            country: 'ES',
+            default_currency: 'EUR',
+            business_profile: {
+                name: 'Rosen Ceramics',
+                url: 'https://rosen.example',
+                support_email: 'help@rosen.example',
+                support_url: null,
+                product_description: 'Handmade tableware',
+                mcc: '5719',
+            },
+            capabilities: { card_payments: 'active', transfers: 'active' },
+            requirements: {
+                currently_due: [],
+                eventually_due: [],
+                past_due: [],
+                pending_verification: [],
+                disabled_reason: null,
+            },
+            charges_enabled: true,
+            payouts_enabled: true,
+            settings: {
+                payouts: {
+                    schedule: {
+                        interval: 'weekly',
+                        delay_days: 7,
+                        weekly_anchor: 'friday',
+                        monthly_anchor: null,
+                    },
+                    statement_descriptor: 'ROSEN CERAMICS',
+                },
+                payments: { statement_descriptor: 'ROSEN CERAMICS' },
+                branding: { primary_color: '#1f2937', secondary_color: null },
+            },
+            last_synced_at: 1793750460,
+            created: 1793750400,
+        },
+    ],
+});
+/**
+ * A hosted onboarding link — the merchant's own account's
+ * (`POST /v1/account_links`) or a seller's
+ * (`POST /v1/connected_accounts/{accountId}/account_links`). Single-use and
+ * short-lived: mint one when the person is about to open it, never store it.
+ */
+exports.accountLinkSchema = (0, objects_1.defineObject)('account_link', 'AccountLink', zod_1.z
+    .object({
+    object: zod_1.z.literal('account_link'),
+    livemode: primitives_1.livemode,
+    url: zod_1.z.string().describe('Where to send the person. Single use.'),
+    expires_at: primitives_1.unixSeconds.describe('When the link stops working (minutes, not days).'),
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'account_link',
+            livemode: false,
+            url: 'https://connect.peable.to/onboarding/Zk3s9v…',
+            expires_at: 1793750700,
+        },
+    ],
+});
+/** A statement descriptor: what a bank or card statement shows. */
+const statementDescriptor = zod_1.z
+    .string()
+    .min(5)
+    .max(22)
+    .regex(/^[^<>\\'"*]*$/, 'a statement descriptor may not contain < > \\ \' " *');
+const hexColor = zod_1.z.string().regex(/^#[0-9a-fA-F]{6}$/);
+/**
+ * `POST /v1/account`: the account's settings, written to the provider and read
+ * back. `country` + `business_type` OPEN the account the first time (when the
+ * merchant has none) and are refused afterwards — a provider account's country
+ * cannot change.
+ */
+exports.updateAccountParams = zod_1.z
+    .object({
+    country: zod_1.z.string().length(2).optional(),
+    business_type: zod_1.z.enum(connect_1.ACCOUNT_BUSINESS_TYPES).optional(),
+    business_profile: zod_1.z
+        .object({
+        name: zod_1.z.string().min(1).max(200).optional(),
+        url: zod_1.z.url().max(2048).optional(),
+        support_email: zod_1.z.email().max(320).optional(),
+        support_url: zod_1.z.url().max(2048).optional(),
+        product_description: zod_1.z.string().max(1000).optional(),
+        mcc: zod_1.z
+            .string()
+            .regex(/^[0-9]{4}$/)
+            .optional(),
+    })
+        .strict()
+        .optional(),
+    settings: zod_1.z
+        .object({
+        payouts: zod_1.z
+            .object({
+            schedule: zod_1.z
+                .object({
+                interval: zod_1.z.enum(connect_1.PAYOUT_INTERVALS),
+                delay_days: zod_1.z.number().int().min(1).max(365).optional(),
+                weekly_anchor: zod_1.z.enum(connect_1.PAYOUT_WEEKLY_ANCHORS).optional(),
+                monthly_anchor: zod_1.z.number().int().min(1).max(31).optional(),
+            })
+                .strict()
+                .superRefine((schedule, ctx) => {
+                if (schedule.weekly_anchor !== undefined && schedule.interval !== 'weekly') {
+                    ctx.addIssue({
+                        code: 'custom',
+                        path: ['weekly_anchor'],
+                        message: 'weekly_anchor is for a weekly schedule',
+                    });
+                }
+                if (schedule.monthly_anchor !== undefined && schedule.interval !== 'monthly') {
+                    ctx.addIssue({
+                        code: 'custom',
+                        path: ['monthly_anchor'],
+                        message: 'monthly_anchor is for a monthly schedule',
+                    });
+                }
+            })
+                .optional(),
+            statement_descriptor: statementDescriptor.optional(),
+        })
+            .strict()
+            .optional(),
+        payments: zod_1.z
+            .object({ statement_descriptor: statementDescriptor.optional() })
+            .strict()
+            .optional(),
+        branding: zod_1.z
+            .object({
+            primary_color: hexColor.optional(),
+            secondary_color: hexColor.optional(),
+        })
+            .strict()
+            .optional(),
+    })
+        .strict()
+        .optional(),
+})
+    .strict();
+/** `POST /v1/account_links`: hosted onboarding (or an update of what was submitted). */
+exports.createAccountLinkParams = zod_1.z
+    .object({
+    refresh_url: zod_1.z.url().describe('Where the person goes when the link has expired.'),
+    return_url: zod_1.z.url().describe('Where the person returns when they leave the flow.'),
+    type: zod_1.z.enum(connect_1.ACCOUNT_LINK_TYPES).optional().describe('Defaults to `account_onboarding`.'),
+})
+    .strict();
+exports.accountRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveAccount',
+        method: 'get',
+        path: '/v1/account',
+        tag: 'Account',
+        summary: 'Retrieve the account',
+        description: "The merchant's own fiat account, or with `Peable-Account: ca_…` one of a platform's sellers. A merchant without one is told so (404 `account_missing`).",
+        auth: 'service',
+        scope: 'payments:read',
+        peableAccount: true,
+        query: params_1.expandOnlyQuery,
+        response: exports.accountSchema,
+        sdk: 'account.retrieve',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateAccount',
+        method: 'post',
+        path: '/v1/account',
+        tag: 'Account',
+        summary: 'Open or update the account',
+        description: 'The first call, with `country` and `business_type`, opens the account (201); every later one writes its settings to the provider and answers the account read back (200).',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        peableAccount: true,
+        body: exports.updateAccountParams,
+        response: exports.accountSchema,
+        sdk: 'account.update',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'createAccountLink',
+        method: 'post',
+        path: '/v1/account_links',
+        tag: 'Account links',
+        summary: 'Create an account link',
+        description: "Hosted onboarding for the merchant's own account (or, with `Peable-Account`, a seller's card account), minted on demand.",
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        peableAccount: true,
+        body: exports.createAccountLinkParams,
+        response: exports.accountLinkSchema,
+        status: 201,
+        sdk: 'accountLinks.create',
+    }),
+];

package/dist/cjs/resources/connect/applicationFees.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applicationFeeRoutes = exports.listApplicationFeesQuery = exports.applicationFeeSchema = exports.feeRefundSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+/**
+ * Application fees (`fee_…`, ADR 0015 §3) — Orbit's fee on one payment, taken
+ * by the provider from the merchant's account when the charge succeeded.
+ * Created from the provider's own record, never computed after the fact, and
+ * refunded through `POST /v1/refunds` with `refund_application_fee`.
+ */
+/** A refund of an application fee (`fr_…`). */
+exports.feeRefundSchema = (0, objects_1.defineObject)('fee_refund', 'FeeRefund', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('fee_refund'),
+    amount: primitives_1.amount,
+    currency: zod_1.z.string(),
+    fee: zod_1.z.string().describe('The `fee_…` it refunds.'),
+    created: primitives_1.unixSeconds,
+})
+    .strict());
+exports.applicationFeeSchema = (0, objects_1.defineObject)('application_fee', 'ApplicationFee', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('application_fee'),
+    livemode: primitives_1.livemode,
+    account: zod_1.z.string().describe('The account (`ca_…`) the fee was taken from.'),
+    amount: primitives_1.amount,
+    amount_refunded: primitives_1.amount,
+    currency: zod_1.z.string(),
+    charge: zod_1.z
+        .string()
+        .nullable()
+        .describe('The `ch_…` it was taken on, when Orbit holds the charge.'),
+    payment_intent: zod_1.z.string().describe('The `pi_…` it was taken on.'),
+    refunded: zod_1.z.boolean().describe('Refunded in full.'),
+    refunds: (0, envelopes_1.listOf)(exports.feeRefundSchema).describe('Every refund of the fee: a complete set.'),
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'fee_0193b8f32b7f4d0e8a15',
+            object: 'application_fee',
+            livemode: false,
+            account: 'ca_0193b8f2c1a87d3e9f4a',
+            amount: '60',
+            amount_refunded: '0',
+            currency: 'EUR',
+            charge: 'ch_0193b8f2f7c94b1d8e02',
+            payment_intent: 'pi_0193b8f2e8a14f6c9d31',
+            refunded: false,
+            refunds: {
+                object: 'list',
+                data: [],
+                has_more: false,
+                url: '/v1/application_fees/fee_0193b8f32b7f4d0e8a15/refunds',
+            },
+            created: 1793750400,
+        },
+    ],
+});
+exports.listApplicationFeesQuery = (0, params_1.listQuery)({
+    payment_intent: params_1.idParam.optional().describe('Only the fee taken on this payment (`pi_…`).'),
+});
+const feeIdParam = { id: 'The application fee (`fee_…`).' };
+exports.applicationFeeRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listApplicationFees',
+        method: 'get',
+        path: '/v1/application_fees',
+        tag: 'Application fees',
+        summary: 'List application fees',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listApplicationFeesQuery,
+        response: (0, envelopes_1.listOf)(exports.applicationFeeSchema),
+        sdk: 'applicationFees.list',
+        expandable: 'application_fee',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveApplicationFee',
+        method: 'get',
+        path: '/v1/application_fees/{id}',
+        tag: 'Application fees',
+        summary: 'Retrieve an application fee',
+        auth: 'service',
+        scope: 'payments:read',
+        params: feeIdParam,
+        query: params_1.expandOnlyQuery,
+        response: exports.applicationFeeSchema,
+        sdk: 'applicationFees.retrieve',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listApplicationFeeRefunds',
+        method: 'get',
+        path: '/v1/application_fees/{id}/refunds',
+        tag: 'Application fees',
+        summary: "List an application fee's refunds",
+        description: 'A complete set (`has_more: false`): one refund per partial refund of the payment.',
+        auth: 'service',
+        scope: 'payments:read',
+        params: feeIdParam,
+        query: params_1.emptyQuery,
+        response: (0, envelopes_1.listOf)(exports.feeRefundSchema),
+        sdk: 'applicationFees.listRefunds',
+    }),
+];

package/dist/cjs/resources/connect/balance.js

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.balanceRoutes = exports.listReconciliationMismatchesQuery = exports.listBalanceTransactionsQuery = exports.reconciliationMismatchSchema = exports.balanceTransactionSchema = exports.balanceTransactionFeeDetailSchema = exports.balanceSchema = exports.balanceAmountSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const connect_1 = require("../../vocabulary/connect");
+/**
+ * Balance and balance transactions (ADR 0015 §3–§5).
+ *
+ * MIRRORS, every one of them. The money is in the merchant's own provider
+ * account; Orbit's double-entry ledger is fed by the provider's own balance
+ * transactions and payouts for that account and reconciled against them daily.
+ * Nothing here is computed by Orbit: a figure the provider has not given is
+ * `null` with a status, never `0`.
+ *
+ * Every amount is a canonical integer STRING in the currency's smallest unit
+ * that MAY be negative (`"-1500"`): a refund or a payout takes money out of a
+ * balance.
+ */
+/** A currency as the provider reports it: upper-case ISO 4217, or `FAIR`. */
+const ledgerCurrency = zod_1.z.string().describe('Upper-case ISO 4217 code, or `FAIR`.');
+/** One currency's figure in a balance. */
+exports.balanceAmountSchema = (0, objects_1.defineComponent)('BalanceAmount', zod_1.z.object({ amount: primitives_1.signedAmount, currency: ledgerCurrency }).strict());
+/**
+ * `GET /v1/balance` — read from the ledger, per currency. A merchant without a
+ * fiat account has NO balance and is told so (404 `account_missing`), never
+ * shown zeros.
+ */
+exports.balanceSchema = (0, objects_1.defineObject)('balance', 'Balance', zod_1.z
+    .object({
+    object: zod_1.z.literal('balance'),
+    livemode: primitives_1.livemode,
+    available: zod_1.z
+        .array(exports.balanceAmountSchema)
+        .describe('Payable now: the provider has made these funds available.'),
+    pending: zod_1.z.array(exports.balanceAmountSchema).describe('Not yet available at the provider.'),
+    informational: zod_1.z
+        .array(exports.balanceAmountSchema)
+        .describe("FairCoin received straight into the merchant's own wallet (ADR 0015 §5): recorded for the books only. Orbit never held it, so it is never payable."),
+    account: zod_1.z
+        .string()
+        .nullable()
+        .describe('The account (`ca_…`) this balance mirrors; `null` for an Oxy first-party merchant.'),
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'balance',
+            livemode: false,
+            available: [{ amount: '184250', currency: 'EUR' }],
+            pending: [{ amount: '12900', currency: 'EUR' }],
+            informational: [{ amount: '250000000', currency: 'FAIR' }],
+            account: 'ca_0193b8f2c1a87d3e9f4a',
+        },
+    ],
+});
+/** One component of a transaction's fee. */
+exports.balanceTransactionFeeDetailSchema = (0, objects_1.defineComponent)('BalanceTransactionFeeDetail', zod_1.z
+    .object({
+    amount: primitives_1.signedAmount,
+    currency: ledgerCurrency,
+    type: zod_1.z.enum(connect_1.BALANCE_TRANSACTION_FEE_TYPES),
+})
+    .strict());
+exports.balanceTransactionSchema = (0, objects_1.defineObject)('balance_transaction', 'BalanceTransaction', zod_1.z
+    .object({
+    id: zod_1.z.string().describe('`txn_…`'),
+    object: zod_1.z.literal('balance_transaction'),
+    livemode: primitives_1.livemode,
+    amount: primitives_1.signedAmount.describe('Gross, signed.'),
+    fee: primitives_1.signedAmount
+        .nullable()
+        .describe('What was taken, or `null` when the source gave no figure (never `0` for unknown).'),
+    net: primitives_1.signedAmount
+        .nullable()
+        .describe('`amount - fee`, as the provider reports it, or `null` with `fee`.'),
+    currency: ledgerCurrency,
+    type: zod_1.z.enum(connect_1.BALANCE_TRANSACTION_TYPES),
+    reporting_category: zod_1.z
+        .string()
+        .describe('A coarser grouping for reports (`charge`, `refund`, `payout`, `fee`, …).'),
+    status: zod_1.z.enum(connect_1.BALANCE_TRANSACTION_STATUSES),
+    available_on: primitives_1.unixSeconds
+        .nullable()
+        .describe('When the funds became (or become) available; `null` for an informational entry.'),
+    created: primitives_1.unixSeconds.describe('When it happened at its source.'),
+    description: zod_1.z.string().nullable(),
+    exchange_rate: zod_1.z.number().nullable(),
+    fee_details: zod_1.z.array(exports.balanceTransactionFeeDetailSchema),
+    source: zod_1.z
+        .string()
+        .nullable()
+        .describe("The Orbit object that caused it (`ch_…`, `re_…`, `po_…`, `fee_…`, `tr_…`, `pi_…`), or `null` when the provider's source is not an object Orbit holds."),
+    payout: zod_1.z
+        .string()
+        .nullable()
+        .describe('The payout (`po_…`) that paid this transaction out, once known.'),
+    account: zod_1.z
+        .string()
+        .nullable()
+        .describe('The account (`ca_…`) whose balance it moved; `null` for a first-party merchant.'),
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'txn_0193b8f30a6c4e21b7d9',
+            object: 'balance_transaction',
+            livemode: false,
+            amount: '2000',
+            fee: '88',
+            net: '1912',
+            currency: 'EUR',
+            type: 'charge',
+            reporting_category: 'charge',
+            status: 'available',
+            available_on: 1794355200,
+            created: 1793750400,
+            description: 'Order 6735',
+            exchange_rate: null,
+            fee_details: [{ amount: '88', currency: 'EUR', type: 'processing_fee' }],
+            source: 'ch_0193b8f2f7c94b1d8e02',
+            payout: null,
+            account: 'ca_0193b8f2c1a87d3e9f4a',
+        },
+    ],
+});
+/**
+ * What the daily reconciliation found disagreeing with the provider (Orbit's
+ * dashboard reads them). Never auto-corrected.
+ */
+exports.reconciliationMismatchSchema = (0, objects_1.defineObject)('reconciliation_mismatch', 'ReconciliationMismatch', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('reconciliation_mismatch'),
+    livemode: primitives_1.livemode,
+    account: zod_1.z.string().nullable(),
+    kind: zod_1.z.enum(connect_1.RECONCILIATION_MISMATCH_KINDS),
+    object_id: zod_1.z
+        .string()
+        .nullable()
+        .describe('The Orbit object concerned (`txn_…`, `po_…`), when Orbit holds one.'),
+    expected: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable().describe('What the provider says.'),
+    actual: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable().describe('What the ledger holds.'),
+    detected_at: primitives_1.unixSeconds,
+    last_seen_at: primitives_1.unixSeconds,
+    resolved_at: primitives_1.unixSeconds
+        .nullable()
+        .describe('Set when a later run no longer sees the difference.'),
+})
+    .strict());
+exports.listBalanceTransactionsQuery = (0, params_1.listQuery)({
+    type: zod_1.z.enum(connect_1.BALANCE_TRANSACTION_TYPES).optional(),
+    payout: params_1.idParam.optional().describe('`po_…`: only the transactions that payout paid out.'),
+    source: params_1.idParam.optional().describe('An Orbit object id the transaction was caused by.'),
+    currency: zod_1.z
+        .string()
+        .regex(/^[A-Za-z]{3,4}$/)
+        .optional()
+        .describe('Case-insensitive.'),
+});
+/** Reconciliation findings, as Orbit's dashboard lists them (not a public route). */
+exports.listReconciliationMismatchesQuery = (0, params_1.listQuery)({
+    open: zod_1.z.enum(['true', 'false']).optional().describe('`true`: only unresolved findings.'),
+});
+exports.balanceRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveBalance',
+        method: 'get',
+        path: '/v1/balance',
+        tag: 'Balance',
+        summary: 'Retrieve the balance',
+        auth: 'service',
+        scope: 'payments:read',
+        peableAccount: true,
+        query: params_1.expandOnlyQuery,
+        response: exports.balanceSchema,
+        sdk: 'balance.retrieve',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listBalanceTransactions',
+        method: 'get',
+        path: '/v1/balance_transactions',
+        tag: 'Balance transactions',
+        summary: 'List balance transactions',
+        description: 'Newest first, filtered by `type`, `payout`, `source`, `currency` and `created`.',
+        auth: 'service',
+        scope: 'payments:read',
+        peableAccount: true,
+        query: exports.listBalanceTransactionsQuery,
+        response: (0, envelopes_1.listOf)(exports.balanceTransactionSchema),
+        sdk: 'balanceTransactions.list',
+        expandable: 'balance_transaction',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveBalanceTransaction',
+        method: 'get',
+        path: '/v1/balance_transactions/{id}',
+        tag: 'Balance transactions',
+        summary: 'Retrieve a balance transaction',
+        auth: 'service',
+        scope: 'payments:read',
+        peableAccount: true,
+        params: { id: 'The balance transaction (`txn_…`).' },
+        query: params_1.expandOnlyQuery,
+        response: exports.balanceTransactionSchema,
+        sdk: 'balanceTransactions.retrieve',
+    }),
+];