@peable.to/contracts 0.4.0 → 1.1.0

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

@@ -0,0 +1,95 @@
+import { z } from 'zod';
+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
+ * link token alone is not enough without the session it names.
+ */
+export declare const connectOnboardingSchema: z.ZodObject<{
+    object: z.ZodLiteral<"connect_onboarding">;
+    account_id: z.ZodString;
+    platform: z.ZodObject<{
+        name: z.ZodString;
+        avatar_url: z.ZodNullable<z.ZodString>;
+        logo_url: z.ZodNullable<z.ZodString>;
+        description: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    network: z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>;
+    expires_at: z.ZodNumber;
+    return_url: z.ZodString;
+}, z.core.$strict>;
+export type ConnectOnboarding = Expand<z.output<typeof connectOnboardingSchema>>;
+/** The answer to a successful registration. */
+export declare const connectOnboardingCompleteSchema: z.ZodObject<{
+    object: z.ZodLiteral<"connect_onboarding">;
+    account_id: z.ZodString;
+    status: z.ZodLiteral<"active">;
+    return_url: z.ZodString;
+}, z.core.$strict>;
+export type ConnectOnboardingComplete = z.output<typeof connectOnboardingCompleteSchema>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        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>;
+export declare const connectOnboardingRoutes: readonly [{
+    readonly operationId: "retrieveConnectOnboarding";
+    readonly method: "get";
+    readonly path: "/v1/connect/onboarding/{token}";
+    readonly tag: "Connect onboarding";
+    readonly summary: "Retrieve an onboarding link";
+    readonly description: "What the seller is being asked to do. Looking consumes nothing. An expired link answers 410 `link_expired` with the platform’s `refresh_url`.";
+    readonly auth: "user";
+    readonly params: {
+        readonly token: "The onboarding link token (the last segment of its `url`).";
+    };
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"connect_onboarding">;
+        account_id: z.ZodString;
+        platform: z.ZodObject<{
+            name: z.ZodString;
+            avatar_url: z.ZodNullable<z.ZodString>;
+            logo_url: z.ZodNullable<z.ZodString>;
+            description: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>;
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+        expires_at: z.ZodNumber;
+        return_url: z.ZodString;
+    }, z.core.$strict>;
+}, {
+    readonly operationId: "registerConnectOnboardingFaircoinKey";
+    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 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 response: z.ZodObject<{
+        object: z.ZodLiteral<"connect_onboarding">;
+        account_id: z.ZodString;
+        status: z.ZodLiteral<"active">;
+        return_url: z.ZodString;
+    }, z.core.$strict>;
+}];

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

@@ -0,0 +1,527 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Payouts (`po_…`) — the provider moving the merchant's balance to the
+ * merchant's bank (ADR 0015 §4). Executed by the provider, always; Orbit
+ * instructs (a manual payout) or mirrors (a scheduled one). The bank account
+ * itself stays at the provider and is never on this object.
+ */
+export declare const payoutSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"payout">;
+    livemode: z.ZodBoolean;
+    account: z.ZodString;
+    amount: z.ZodString;
+    currency: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        canceled: "canceled";
+        paid: "paid";
+        failed: "failed";
+        in_transit: "in_transit";
+    }>;
+    arrival_date: z.ZodNullable<z.ZodNumber>;
+    automatic: z.ZodBoolean;
+    method: z.ZodEnum<{
+        standard: "standard";
+        instant: "instant";
+    }>;
+    type: z.ZodEnum<{
+        card: "card";
+        bank_account: "bank_account";
+    }>;
+    description: z.ZodNullable<z.ZodString>;
+    statement_descriptor: z.ZodNullable<z.ZodString>;
+    failure_code: z.ZodNullable<z.ZodString>;
+    balance_transaction: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type Payout = Expand<z.output<typeof payoutSchema>>;
+/**
+ * `GET /v1/reports/payout_reconciliation?payout=po_…` — the balance
+ * transactions one payout paid out, with their totals. A list page with the
+ * report's fields beside it.
+ */
+export declare const payoutReconciliationReportSchema: z.ZodObject<{
+    object: z.ZodLiteral<"list">;
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"balance_transaction">;
+        livemode: z.ZodBoolean;
+        amount: z.ZodString;
+        fee: z.ZodNullable<z.ZodString>;
+        net: z.ZodNullable<z.ZodString>;
+        currency: z.ZodString;
+        type: z.ZodEnum<{
+            application_fee: "application_fee";
+            payout: "payout";
+            transfer: "transfer";
+            charge: "charge";
+            dispute: "dispute";
+            refund: "refund";
+            adjustment: "adjustment";
+            other: "other";
+            payment: "payment";
+            payment_refund: "payment_refund";
+            application_fee_refund: "application_fee_refund";
+            payout_cancel: "payout_cancel";
+            payout_failure: "payout_failure";
+            transfer_refund: "transfer_refund";
+            dispute_reversal: "dispute_reversal";
+            processing_fee: "processing_fee";
+            faircoin_payment: "faircoin_payment";
+            faircoin_payment_reversal: "faircoin_payment_reversal";
+        }>;
+        reporting_category: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            available: "available";
+            informational: "informational";
+        }>;
+        available_on: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+        description: z.ZodNullable<z.ZodString>;
+        exchange_rate: z.ZodNullable<z.ZodNumber>;
+        fee_details: z.ZodArray<z.ZodObject<{
+            amount: z.ZodString;
+            currency: z.ZodString;
+            type: z.ZodEnum<{
+                application_fee: "application_fee";
+                tax: "tax";
+                other: "other";
+                processing_fee: "processing_fee";
+            }>;
+        }, z.core.$strict>>;
+        source: z.ZodNullable<z.ZodString>;
+        payout: z.ZodNullable<z.ZodString>;
+        account: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    has_more: z.ZodBoolean;
+    url: z.ZodString;
+    payout: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        complete: "complete";
+    }>;
+    currency: z.ZodString;
+    summary: z.ZodObject<{
+        count: z.ZodNumber;
+        amount: z.ZodString;
+        fee: z.ZodString;
+        net: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type PayoutReconciliationReport = Expand<z.output<typeof payoutReconciliationReportSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        payout: Payout;
+    }
+}
+/** `POST /v1/payouts` — a payout instruction for an account on a manual schedule. */
+export declare const createPayoutParams: z.ZodObject<{
+    amount: z.ZodString;
+    currency: z.ZodEnum<{
+        FAIR: "FAIR";
+        EUR: "EUR";
+        USD: "USD";
+        GBP: "GBP";
+        CHF: "CHF";
+        SEK: "SEK";
+        NOK: "NOK";
+        DKK: "DKK";
+        PLN: "PLN";
+        CZK: "CZK";
+        CAD: "CAD";
+        AUD: "AUD";
+        JPY: "JPY";
+    }>;
+    description: z.ZodOptional<z.ZodString>;
+    statement_descriptor: z.ZodOptional<z.ZodString>;
+    method: z.ZodOptional<z.ZodEnum<{
+        standard: "standard";
+        instant: "instant";
+    }>>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+}, z.core.$strict>;
+export type CreatePayoutParams = z.input<typeof createPayoutParams>;
+export declare const listPayoutsQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    status: z.ZodOptional<z.ZodEnum<{
+        pending: "pending";
+        canceled: "canceled";
+        paid: "paid";
+        failed: "failed";
+        in_transit: "in_transit";
+    }>>;
+}, z.core.$strict>;
+export type ListPayoutsParams = z.input<typeof listPayoutsQuery>;
+/** `POST /v1/payouts/{id}/cancel` takes no parameters. */
+export declare const cancelPayoutParams: z.ZodObject<{}, z.core.$strict>;
+export declare const payoutReconciliationQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    payout: z.ZodString;
+}, z.core.$strict>;
+export type PayoutReconciliationParams = z.input<typeof payoutReconciliationQuery>;
+export declare const payoutRoutes: readonly [{
+    readonly operationId: "listPayouts";
+    readonly method: "get";
+    readonly path: "/v1/payouts";
+    readonly tag: "Payouts";
+    readonly summary: "List payouts";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly peableAccount: true;
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        status: z.ZodOptional<z.ZodEnum<{
+            pending: "pending";
+            canceled: "canceled";
+            paid: "paid";
+            failed: "failed";
+            in_transit: "in_transit";
+        }>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"payout">;
+            livemode: z.ZodBoolean;
+            account: z.ZodString;
+            amount: z.ZodString;
+            currency: z.ZodString;
+            status: z.ZodEnum<{
+                pending: "pending";
+                canceled: "canceled";
+                paid: "paid";
+                failed: "failed";
+                in_transit: "in_transit";
+            }>;
+            arrival_date: z.ZodNullable<z.ZodNumber>;
+            automatic: z.ZodBoolean;
+            method: z.ZodEnum<{
+                standard: "standard";
+                instant: "instant";
+            }>;
+            type: z.ZodEnum<{
+                card: "card";
+                bank_account: "bank_account";
+            }>;
+            description: z.ZodNullable<z.ZodString>;
+            statement_descriptor: z.ZodNullable<z.ZodString>;
+            failure_code: z.ZodNullable<z.ZodString>;
+            balance_transaction: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "payouts.list";
+    readonly expandable: "payout";
+}, {
+    readonly operationId: "createPayout";
+    readonly method: "post";
+    readonly path: "/v1/payouts";
+    readonly tag: "Payouts";
+    readonly summary: "Create a payout";
+    readonly description: "An instruction to the provider, for an account on a `manual` payout schedule. The provider executes it; Orbit never moves the money itself.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly peableAccount: true;
+    readonly body: z.ZodObject<{
+        amount: z.ZodString;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        statement_descriptor: z.ZodOptional<z.ZodString>;
+        method: z.ZodOptional<z.ZodEnum<{
+            standard: "standard";
+            instant: "instant";
+        }>>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payout">;
+        livemode: z.ZodBoolean;
+        account: z.ZodString;
+        amount: z.ZodString;
+        currency: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            canceled: "canceled";
+            paid: "paid";
+            failed: "failed";
+            in_transit: "in_transit";
+        }>;
+        arrival_date: z.ZodNullable<z.ZodNumber>;
+        automatic: z.ZodBoolean;
+        method: z.ZodEnum<{
+            standard: "standard";
+            instant: "instant";
+        }>;
+        type: z.ZodEnum<{
+            card: "card";
+            bank_account: "bank_account";
+        }>;
+        description: z.ZodNullable<z.ZodString>;
+        statement_descriptor: z.ZodNullable<z.ZodString>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        balance_transaction: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly status: 201;
+    readonly sdk: "payouts.create";
+}, {
+    readonly operationId: "retrievePayout";
+    readonly method: "get";
+    readonly path: "/v1/payouts/{id}";
+    readonly tag: "Payouts";
+    readonly summary: "Retrieve a payout";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly peableAccount: true;
+    readonly params: {
+        readonly id: "The payout (`po_…`).";
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payout">;
+        livemode: z.ZodBoolean;
+        account: z.ZodString;
+        amount: z.ZodString;
+        currency: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            canceled: "canceled";
+            paid: "paid";
+            failed: "failed";
+            in_transit: "in_transit";
+        }>;
+        arrival_date: z.ZodNullable<z.ZodNumber>;
+        automatic: z.ZodBoolean;
+        method: z.ZodEnum<{
+            standard: "standard";
+            instant: "instant";
+        }>;
+        type: z.ZodEnum<{
+            card: "card";
+            bank_account: "bank_account";
+        }>;
+        description: z.ZodNullable<z.ZodString>;
+        statement_descriptor: z.ZodNullable<z.ZodString>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        balance_transaction: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "payouts.retrieve";
+}, {
+    readonly operationId: "cancelPayout";
+    readonly method: "post";
+    readonly path: "/v1/payouts/{id}/cancel";
+    readonly tag: "Payouts";
+    readonly summary: "Cancel a payout";
+    readonly description: "Only a manual payout the provider still allows to be canceled.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly peableAccount: true;
+    readonly params: {
+        readonly id: "The payout (`po_…`).";
+    };
+    readonly body: z.ZodObject<{}, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payout">;
+        livemode: z.ZodBoolean;
+        account: z.ZodString;
+        amount: z.ZodString;
+        currency: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            canceled: "canceled";
+            paid: "paid";
+            failed: "failed";
+            in_transit: "in_transit";
+        }>;
+        arrival_date: z.ZodNullable<z.ZodNumber>;
+        automatic: z.ZodBoolean;
+        method: z.ZodEnum<{
+            standard: "standard";
+            instant: "instant";
+        }>;
+        type: z.ZodEnum<{
+            card: "card";
+            bank_account: "bank_account";
+        }>;
+        description: z.ZodNullable<z.ZodString>;
+        statement_descriptor: z.ZodNullable<z.ZodString>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        balance_transaction: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "payouts.cancel";
+}, {
+    readonly operationId: "retrievePayoutReconciliation";
+    readonly method: "get";
+    readonly path: "/v1/reports/payout_reconciliation";
+    readonly tag: "Payouts";
+    readonly summary: "Reconcile a payout";
+    readonly description: "The balance transactions one payout paid out, a page at a time, with totals over all of them.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly peableAccount: true;
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        payout: z.ZodString;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"balance_transaction">;
+            livemode: z.ZodBoolean;
+            amount: z.ZodString;
+            fee: z.ZodNullable<z.ZodString>;
+            net: z.ZodNullable<z.ZodString>;
+            currency: z.ZodString;
+            type: z.ZodEnum<{
+                application_fee: "application_fee";
+                payout: "payout";
+                transfer: "transfer";
+                charge: "charge";
+                dispute: "dispute";
+                refund: "refund";
+                adjustment: "adjustment";
+                other: "other";
+                payment: "payment";
+                payment_refund: "payment_refund";
+                application_fee_refund: "application_fee_refund";
+                payout_cancel: "payout_cancel";
+                payout_failure: "payout_failure";
+                transfer_refund: "transfer_refund";
+                dispute_reversal: "dispute_reversal";
+                processing_fee: "processing_fee";
+                faircoin_payment: "faircoin_payment";
+                faircoin_payment_reversal: "faircoin_payment_reversal";
+            }>;
+            reporting_category: z.ZodString;
+            status: z.ZodEnum<{
+                pending: "pending";
+                available: "available";
+                informational: "informational";
+            }>;
+            available_on: z.ZodNullable<z.ZodNumber>;
+            created: z.ZodNumber;
+            description: z.ZodNullable<z.ZodString>;
+            exchange_rate: z.ZodNullable<z.ZodNumber>;
+            fee_details: z.ZodArray<z.ZodObject<{
+                amount: z.ZodString;
+                currency: z.ZodString;
+                type: z.ZodEnum<{
+                    application_fee: "application_fee";
+                    tax: "tax";
+                    other: "other";
+                    processing_fee: "processing_fee";
+                }>;
+            }, z.core.$strict>>;
+            source: z.ZodNullable<z.ZodString>;
+            payout: z.ZodNullable<z.ZodString>;
+            account: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+        payout: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            complete: "complete";
+        }>;
+        currency: z.ZodString;
+        summary: z.ZodObject<{
+            count: z.ZodNumber;
+            amount: z.ZodString;
+            fee: z.ZodString;
+            net: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>;
+    readonly sdk: "reports.payoutReconciliation";
+    readonly expandable: "balance_transaction";
+}];