@peable.to/contracts 0.4.0 → 1.0.0

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

@@ -0,0 +1,684 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Refunds (`re_…`) and a payment's settlement figures. The provider's own
+ * refund id never appears: a merchant integrates against Peable and never
+ * learns which acquirer sat behind it (ADR 0001 D3).
+ */
+export declare const refundSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"refund">;
+    livemode: z.ZodBoolean;
+    external_ref: z.ZodNullable<z.ZodString>;
+    origin: z.ZodEnum<{
+        merchant: "merchant";
+        provider: "provider";
+    }>;
+    payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+    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";
+    }>;
+    status: z.ZodEnum<{
+        succeeded: "succeeded";
+        pending: "pending";
+        canceled: "canceled";
+        failed: "failed";
+    }>;
+    reason: z.ZodNullable<z.ZodEnum<{
+        duplicate: "duplicate";
+        fraudulent: "fraudulent";
+        requested_by_customer: "requested_by_customer";
+    }>>;
+    failure_code: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+    updated_at: z.ZodNumber;
+}, z.core.$strict>;
+export type Refund = Expand<z.output<typeof refundSchema>>;
+/**
+ * What a payment actually came to, as the PROVIDER reports it. Every figure is
+ * nullable and that is the contract: "the fee was zero" and "the fee is not
+ * known yet" are different facts, and `status` says which produced the nulls.
+ * It reports what the provider took; it attributes that cost to nobody.
+ */
+export declare const settlementSchema: z.ZodObject<{
+    object: z.ZodLiteral<"settlement">;
+    livemode: z.ZodBoolean;
+    payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+    status: z.ZodEnum<{
+        unknown: "unknown";
+        pending: "pending";
+        available: "available";
+    }>;
+    gross: z.ZodNullable<z.ZodString>;
+    fee: z.ZodNullable<z.ZodString>;
+    net: z.ZodNullable<z.ZodString>;
+    currency: z.ZodNullable<z.ZodString>;
+    available_on: z.ZodNullable<z.ZodNumber>;
+    exchange_rate: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type Settlement = Expand<z.output<typeof settlementSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        refund: Refund;
+        settlement: Settlement;
+    }
+}
+export declare const createRefundParams: z.ZodObject<{
+    payment_intent: z.ZodString;
+    external_ref: z.ZodString;
+    amount: z.ZodString;
+    reason: z.ZodOptional<z.ZodEnum<{
+        duplicate: "duplicate";
+        fraudulent: "fraudulent";
+        requested_by_customer: "requested_by_customer";
+    }>>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+    refund_application_fee: z.ZodOptional<z.ZodBoolean>;
+    reverse_transfer: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type CreateRefundParams = z.input<typeof createRefundParams>;
+/** The merchant's own bookkeeping on a refund: `metadata`, a patch. */
+export declare const updateRefundParams: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
+}, z.core.$strict>;
+export type UpdateRefundParams = z.input<typeof updateRefundParams>;
+export declare const cancelRefundParams: z.ZodObject<{}, z.core.$strict>;
+export declare const listRefundsQuery: 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>>>;
+    payment_intent: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ListRefundsParams = z.input<typeof listRefundsQuery>;
+/** The per-payment sub-list: the payment is in the path. */
+export declare const listPaymentIntentRefundsQuery: 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>>>;
+}, z.core.$strict>;
+/**
+ * A payment's refunds, with what is still refundable beside the envelope — the
+ * figure every merchant would otherwise compute by summing the list, and get
+ * wrong by counting a `pending` or `failed` refund.
+ */
+export declare const paymentIntentRefundListSchema: z.ZodObject<{
+    object: z.ZodLiteral<"list">;
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"refund">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodNullable<z.ZodString>;
+        origin: z.ZodEnum<{
+            merchant: "merchant";
+            provider: "provider";
+        }>;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        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";
+        }>;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            pending: "pending";
+            canceled: "canceled";
+            failed: "failed";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>>;
+    has_more: z.ZodBoolean;
+    url: z.ZodString;
+    remaining_refundable: z.ZodString;
+}, z.core.$strict>;
+export type PaymentIntentRefundList = Expand<z.output<typeof paymentIntentRefundListSchema>>;
+export declare const refundRoutes: readonly [{
+    readonly operationId: "createRefund";
+    readonly method: "post";
+    readonly path: "/v1/refunds";
+    readonly tag: "Refunds";
+    readonly summary: "Create a refund";
+    readonly description: "`external_ref` decides whether money moves twice: a retry with the same ref answers the refund it made (200) whatever is still refundable.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        payment_intent: z.ZodString;
+        external_ref: z.ZodString;
+        amount: z.ZodString;
+        reason: z.ZodOptional<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+        refund_application_fee: z.ZodOptional<z.ZodBoolean>;
+        reverse_transfer: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"refund">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodNullable<z.ZodString>;
+        origin: z.ZodEnum<{
+            merchant: "merchant";
+            provider: "provider";
+        }>;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        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";
+        }>;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            pending: "pending";
+            canceled: "canceled";
+            failed: "failed";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly status: 201;
+    readonly sdk: "refunds.create";
+}, {
+    readonly operationId: "listRefunds";
+    readonly method: "get";
+    readonly path: "/v1/refunds";
+    readonly tag: "Refunds";
+    readonly summary: "List refunds";
+    readonly description: "Every refund of the merchant, or of one payment — including those made outside Peable (`origin: 'provider'`).";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    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>>>;
+        payment_intent: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"refund">;
+            livemode: z.ZodBoolean;
+            external_ref: z.ZodNullable<z.ZodString>;
+            origin: z.ZodEnum<{
+                merchant: "merchant";
+                provider: "provider";
+            }>;
+            payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+            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";
+            }>;
+            status: z.ZodEnum<{
+                succeeded: "succeeded";
+                pending: "pending";
+                canceled: "canceled";
+                failed: "failed";
+            }>;
+            reason: z.ZodNullable<z.ZodEnum<{
+                duplicate: "duplicate";
+                fraudulent: "fraudulent";
+                requested_by_customer: "requested_by_customer";
+            }>>;
+            failure_code: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+            updated_at: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.list";
+    readonly expandable: "refund";
+}, {
+    readonly operationId: "retrieveRefund";
+    readonly method: "get";
+    readonly path: "/v1/refunds/{id}";
+    readonly tag: "Refunds";
+    readonly summary: "Retrieve a refund";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        id: string;
+    };
+    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<"refund">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodNullable<z.ZodString>;
+        origin: z.ZodEnum<{
+            merchant: "merchant";
+            provider: "provider";
+        }>;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        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";
+        }>;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            pending: "pending";
+            canceled: "canceled";
+            failed: "failed";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.retrieve";
+    readonly expandable: "refund";
+}, {
+    readonly operationId: "updateRefund";
+    readonly method: "post";
+    readonly path: "/v1/refunds/{id}";
+    readonly tag: "Refunds";
+    readonly summary: "Update a refund";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        id: string;
+    };
+    readonly body: z.ZodObject<{
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"refund">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodNullable<z.ZodString>;
+        origin: z.ZodEnum<{
+            merchant: "merchant";
+            provider: "provider";
+        }>;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        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";
+        }>;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            pending: "pending";
+            canceled: "canceled";
+            failed: "failed";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.update";
+}, {
+    readonly operationId: "cancelRefund";
+    readonly method: "post";
+    readonly path: "/v1/refunds/{id}/cancel";
+    readonly tag: "Refunds";
+    readonly summary: "Cancel a refund";
+    readonly description: "Only while the provider still holds it; otherwise 400 `refund_not_cancelable`.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        id: string;
+    };
+    readonly body: z.ZodObject<{}, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"refund">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodNullable<z.ZodString>;
+        origin: z.ZodEnum<{
+            merchant: "merchant";
+            provider: "provider";
+        }>;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        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";
+        }>;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            pending: "pending";
+            canceled: "canceled";
+            failed: "failed";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        failure_code: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.cancel";
+}, {
+    readonly operationId: "listPaymentIntentRefunds";
+    readonly method: "get";
+    readonly path: "/v1/payment_intents/{intentId}/refunds";
+    readonly tag: "Refunds";
+    readonly summary: "List a payment's refunds";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        intentId: string;
+    };
+    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>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"refund">;
+            livemode: z.ZodBoolean;
+            external_ref: z.ZodNullable<z.ZodString>;
+            origin: z.ZodEnum<{
+                merchant: "merchant";
+                provider: "provider";
+            }>;
+            payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+            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";
+            }>;
+            status: z.ZodEnum<{
+                succeeded: "succeeded";
+                pending: "pending";
+                canceled: "canceled";
+                failed: "failed";
+            }>;
+            reason: z.ZodNullable<z.ZodEnum<{
+                duplicate: "duplicate";
+                fraudulent: "fraudulent";
+                requested_by_customer: "requested_by_customer";
+            }>>;
+            failure_code: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+            updated_at: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+        remaining_refundable: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.listForPaymentIntent";
+    readonly expandable: "refund";
+}, {
+    readonly operationId: "retrievePaymentIntentSettlement";
+    readonly method: "get";
+    readonly path: "/v1/payment_intents/{intentId}/settlement";
+    readonly tag: "Refunds";
+    readonly summary: "Retrieve a payment's settlement";
+    readonly description: "Gross, fee and net, read live from the provider. A missing figure is `null` with a `status`, never `0`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        intentId: string;
+    };
+    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<{
+        object: z.ZodLiteral<"settlement">;
+        livemode: z.ZodBoolean;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        status: z.ZodEnum<{
+            unknown: "unknown";
+            pending: "pending";
+            available: "available";
+        }>;
+        gross: z.ZodNullable<z.ZodString>;
+        fee: z.ZodNullable<z.ZodString>;
+        net: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<z.ZodString>;
+        available_on: z.ZodNullable<z.ZodNumber>;
+        exchange_rate: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.settlement";
+    readonly expandable: "settlement";
+}, {
+    readonly operationId: "searchRefunds";
+    readonly method: "get";
+    readonly path: "/v1/refunds/search";
+    readonly tag: "Refunds";
+    readonly summary: "Search refunds";
+    readonly description: "Stripe's query language over `amount`, `currency`, `status`, `reason`, `payment_intent`, `created` and `metadata['key']`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        query: z.ZodString;
+        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>>;
+        page: z.ZodOptional<z.ZodString>;
+        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<{
+        object: z.ZodLiteral<"search_result">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"refund">;
+            livemode: z.ZodBoolean;
+            external_ref: z.ZodNullable<z.ZodString>;
+            origin: z.ZodEnum<{
+                merchant: "merchant";
+                provider: "provider";
+            }>;
+            payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+            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";
+            }>;
+            status: z.ZodEnum<{
+                succeeded: "succeeded";
+                pending: "pending";
+                canceled: "canceled";
+                failed: "failed";
+            }>;
+            reason: z.ZodNullable<z.ZodEnum<{
+                duplicate: "duplicate";
+                fraudulent: "fraudulent";
+                requested_by_customer: "requested_by_customer";
+            }>>;
+            failure_code: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+            updated_at: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        next_page: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        total_count: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.search";
+    readonly expandable: "refund";
+}];