@moovio/sdk 26.10.0-dev.1 → 26.10.0-dev.3

package/src/models/components/merchantcategoryrestrictions.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  IssuingControlsRestrictionMode,
+  IssuingControlsRestrictionMode$inboundSchema,
+  IssuingControlsRestrictionMode$outboundSchema,
+} from "./issuingcontrolsrestrictionmode.js";
+import {
+  IssuingMerchantCategory,
+  IssuingMerchantCategory$inboundSchema,
+  IssuingMerchantCategory$outboundSchema,
+} from "./issuingmerchantcategory.js";
+import {
+  MerchantEntry,
+  MerchantEntry$inboundSchema,
+  MerchantEntry$Outbound,
+  MerchantEntry$outboundSchema,
+} from "./merchantentry.js";
+
+/**
+ * Restricts card usage by merchant category. When not set, all categories are allowed.
+ */
+export type MerchantCategoryRestrictions = {
+  /**
+   * Whether the listed items should be allowed (`allow`) or blocked (`block`).
+   */
+  mode: IssuingControlsRestrictionMode;
+  /**
+   * Predefined category groups to allow or block.
+   */
+  categories?: Array<IssuingMerchantCategory> | undefined;
+  /**
+   * Individual merchant category codes (MCCs) to allow or block, for codes not covered by a predefined category.
+   */
+  customMCCs?: Array<string> | undefined;
+  /**
+   * Merchants that are exempt from category restrictions regardless of their category.
+   */
+  exemptMerchants?: Array<MerchantEntry> | undefined;
+};
+
+/** @internal */
+export const MerchantCategoryRestrictions$inboundSchema: z.ZodType<
+  MerchantCategoryRestrictions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: IssuingControlsRestrictionMode$inboundSchema,
+  categories: types.optional(z.array(IssuingMerchantCategory$inboundSchema)),
+  customMCCs: types.optional(z.array(types.string())),
+  exemptMerchants: types.optional(z.array(MerchantEntry$inboundSchema)),
+});
+/** @internal */
+export type MerchantCategoryRestrictions$Outbound = {
+  mode: string;
+  categories?: Array<string> | undefined;
+  customMCCs?: Array<string> | undefined;
+  exemptMerchants?: Array<MerchantEntry$Outbound> | undefined;
+};
+
+/** @internal */
+export const MerchantCategoryRestrictions$outboundSchema: z.ZodType<
+  MerchantCategoryRestrictions$Outbound,
+  z.ZodTypeDef,
+  MerchantCategoryRestrictions
+> = z.object({
+  mode: IssuingControlsRestrictionMode$outboundSchema,
+  categories: z.array(IssuingMerchantCategory$outboundSchema).optional(),
+  customMCCs: z.array(z.string()).optional(),
+  exemptMerchants: z.array(MerchantEntry$outboundSchema).optional(),
+});
+
+export function merchantCategoryRestrictionsToJSON(
+  merchantCategoryRestrictions: MerchantCategoryRestrictions,
+): string {
+  return JSON.stringify(
+    MerchantCategoryRestrictions$outboundSchema.parse(
+      merchantCategoryRestrictions,
+    ),
+  );
+}
+export function merchantCategoryRestrictionsFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantCategoryRestrictions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantCategoryRestrictions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantCategoryRestrictions' from JSON`,
+  );
+}

package/src/models/components/merchantcategoryrestrictionserror.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MerchantEntryError,
+  MerchantEntryError$inboundSchema,
+  MerchantEntryError$Outbound,
+  MerchantEntryError$outboundSchema,
+} from "./merchantentryerror.js";
+
+export type MerchantCategoryRestrictionsError = {
+  mode?: string | undefined;
+  categories?: { [k: string]: string } | undefined;
+  customMCCs?: { [k: string]: string } | undefined;
+  exemptMerchants?: { [k: string]: MerchantEntryError } | undefined;
+};
+
+/** @internal */
+export const MerchantCategoryRestrictionsError$inboundSchema: z.ZodType<
+  MerchantCategoryRestrictionsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: types.optional(types.string()),
+  categories: types.optional(z.record(types.string())),
+  customMCCs: types.optional(z.record(types.string())),
+  exemptMerchants: types.optional(z.record(MerchantEntryError$inboundSchema)),
+});
+/** @internal */
+export type MerchantCategoryRestrictionsError$Outbound = {
+  mode?: string | undefined;
+  categories?: { [k: string]: string } | undefined;
+  customMCCs?: { [k: string]: string } | undefined;
+  exemptMerchants?: { [k: string]: MerchantEntryError$Outbound } | undefined;
+};
+
+/** @internal */
+export const MerchantCategoryRestrictionsError$outboundSchema: z.ZodType<
+  MerchantCategoryRestrictionsError$Outbound,
+  z.ZodTypeDef,
+  MerchantCategoryRestrictionsError
+> = z.object({
+  mode: z.string().optional(),
+  categories: z.record(z.string()).optional(),
+  customMCCs: z.record(z.string()).optional(),
+  exemptMerchants: z.record(MerchantEntryError$outboundSchema).optional(),
+});
+
+export function merchantCategoryRestrictionsErrorToJSON(
+  merchantCategoryRestrictionsError: MerchantCategoryRestrictionsError,
+): string {
+  return JSON.stringify(
+    MerchantCategoryRestrictionsError$outboundSchema.parse(
+      merchantCategoryRestrictionsError,
+    ),
+  );
+}
+export function merchantCategoryRestrictionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantCategoryRestrictionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantCategoryRestrictionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantCategoryRestrictionsError' from JSON`,
+  );
+}

package/src/models/components/merchantentry.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Identifies a merchant by ID, descriptor pattern, or both. At least one of `networkID` or `descriptorPattern` must be set.
+ */
+export type MerchantEntry = {
+  /**
+   * The merchant's unique identifier (ISO 8583 DE42), matched exactly.
+   */
+  networkID?: string | undefined;
+  /**
+   * A case-insensitive RE2 regular expression matched against the merchant descriptor (ISO 8583 DE43).
+   */
+  descriptorPattern?: string | undefined;
+  /**
+   * An optional label for this entry.
+   */
+  name?: string | undefined;
+};
+
+/** @internal */
+export const MerchantEntry$inboundSchema: z.ZodType<
+  MerchantEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  networkID: types.optional(types.string()),
+  descriptorPattern: types.optional(types.string()),
+  name: types.optional(types.string()),
+});
+/** @internal */
+export type MerchantEntry$Outbound = {
+  networkID?: string | undefined;
+  descriptorPattern?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const MerchantEntry$outboundSchema: z.ZodType<
+  MerchantEntry$Outbound,
+  z.ZodTypeDef,
+  MerchantEntry
+> = z.object({
+  networkID: z.string().optional(),
+  descriptorPattern: z.string().optional(),
+  name: z.string().optional(),
+});
+
+export function merchantEntryToJSON(merchantEntry: MerchantEntry): string {
+  return JSON.stringify(MerchantEntry$outboundSchema.parse(merchantEntry));
+}
+export function merchantEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantEntry' from JSON`,
+  );
+}

package/src/models/components/merchantentryerror.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type MerchantEntryError = {
+  networkID?: string | undefined;
+  descriptorPattern?: string | undefined;
+};
+
+/** @internal */
+export const MerchantEntryError$inboundSchema: z.ZodType<
+  MerchantEntryError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  networkID: types.optional(types.string()),
+  descriptorPattern: types.optional(types.string()),
+});
+/** @internal */
+export type MerchantEntryError$Outbound = {
+  networkID?: string | undefined;
+  descriptorPattern?: string | undefined;
+};
+
+/** @internal */
+export const MerchantEntryError$outboundSchema: z.ZodType<
+  MerchantEntryError$Outbound,
+  z.ZodTypeDef,
+  MerchantEntryError
+> = z.object({
+  networkID: z.string().optional(),
+  descriptorPattern: z.string().optional(),
+});
+
+export function merchantEntryErrorToJSON(
+  merchantEntryError: MerchantEntryError,
+): string {
+  return JSON.stringify(
+    MerchantEntryError$outboundSchema.parse(merchantEntryError),
+  );
+}
+export function merchantEntryErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantEntryError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantEntryError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantEntryError' from JSON`,
+  );
+}

package/src/models/components/merchantrestrictions.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  IssuingControlsRestrictionMode,
+  IssuingControlsRestrictionMode$inboundSchema,
+  IssuingControlsRestrictionMode$outboundSchema,
+} from "./issuingcontrolsrestrictionmode.js";
+import {
+  MerchantEntry,
+  MerchantEntry$inboundSchema,
+  MerchantEntry$Outbound,
+  MerchantEntry$outboundSchema,
+} from "./merchantentry.js";
+
+/**
+ * Restricts card usage to specific merchants, independent of merchant category.
+ */
+export type MerchantRestrictions = {
+  /**
+   * Whether the listed items should be allowed (`allow`) or blocked (`block`).
+   */
+  mode: IssuingControlsRestrictionMode;
+  /**
+   * The merchants to allow or block.
+   */
+  merchants: Array<MerchantEntry>;
+};
+
+/** @internal */
+export const MerchantRestrictions$inboundSchema: z.ZodType<
+  MerchantRestrictions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: IssuingControlsRestrictionMode$inboundSchema,
+  merchants: z.array(MerchantEntry$inboundSchema),
+});
+/** @internal */
+export type MerchantRestrictions$Outbound = {
+  mode: string;
+  merchants: Array<MerchantEntry$Outbound>;
+};
+
+/** @internal */
+export const MerchantRestrictions$outboundSchema: z.ZodType<
+  MerchantRestrictions$Outbound,
+  z.ZodTypeDef,
+  MerchantRestrictions
+> = z.object({
+  mode: IssuingControlsRestrictionMode$outboundSchema,
+  merchants: z.array(MerchantEntry$outboundSchema),
+});
+
+export function merchantRestrictionsToJSON(
+  merchantRestrictions: MerchantRestrictions,
+): string {
+  return JSON.stringify(
+    MerchantRestrictions$outboundSchema.parse(merchantRestrictions),
+  );
+}
+export function merchantRestrictionsFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantRestrictions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantRestrictions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantRestrictions' from JSON`,
+  );
+}

package/src/models/components/merchantrestrictionserror.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MerchantEntryError,
+  MerchantEntryError$inboundSchema,
+  MerchantEntryError$Outbound,
+  MerchantEntryError$outboundSchema,
+} from "./merchantentryerror.js";
+
+export type MerchantRestrictionsError = {
+  mode?: string | undefined;
+  merchants?: { [k: string]: MerchantEntryError } | undefined;
+};
+
+/** @internal */
+export const MerchantRestrictionsError$inboundSchema: z.ZodType<
+  MerchantRestrictionsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: types.optional(types.string()),
+  merchants: types.optional(z.record(MerchantEntryError$inboundSchema)),
+});
+/** @internal */
+export type MerchantRestrictionsError$Outbound = {
+  mode?: string | undefined;
+  merchants?: { [k: string]: MerchantEntryError$Outbound } | undefined;
+};
+
+/** @internal */
+export const MerchantRestrictionsError$outboundSchema: z.ZodType<
+  MerchantRestrictionsError$Outbound,
+  z.ZodTypeDef,
+  MerchantRestrictionsError
+> = z.object({
+  mode: z.string().optional(),
+  merchants: z.record(MerchantEntryError$outboundSchema).optional(),
+});
+
+export function merchantRestrictionsErrorToJSON(
+  merchantRestrictionsError: MerchantRestrictionsError,
+): string {
+  return JSON.stringify(
+    MerchantRestrictionsError$outboundSchema.parse(merchantRestrictionsError),
+  );
+}
+export function merchantRestrictionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantRestrictionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantRestrictionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantRestrictionsError' from JSON`,
+  );
+}

package/src/models/components/moovfeedetails.ts

@@ -7,6 +7,12 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
 
 /**
  * Processing and pass-through costs that add up to the moovFee.
@@ -15,19 +21,19 @@ export type MoovFeeDetails = {
   /**
    * Card scheme fees accrued during authorization and settlement. String type represents dollars with up to 9 decimal place precision.
    */
-  cardScheme?: string | undefined;
+  cardScheme?: AmountDecimal | undefined;
   /**
    * Network interchange fee for Visa, Mastercard, or Discover. String type represents dollars with up to 9 decimal place precision.
    */
-  interchange?: string | undefined;
+  interchange?: AmountDecimal | undefined;
   /**
    * Network discount fee for American Express. String type represents dollars with up to 9 decimal place precision.
    */
-  discount?: string | undefined;
+  discount?: AmountDecimal | undefined;
   /**
    * Moov processing fee. String type represents dollars with up to 9 decimal place precision.
    */
-  moovProcessing: string;
+  moovProcessing: AmountDecimal;
 };
 
 /** @internal */
@@ -36,17 +42,17 @@ export const MoovFeeDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  cardScheme: types.optional(types.string()),
-  interchange: types.optional(types.string()),
-  discount: types.optional(types.string()),
-  moovProcessing: types.string(),
+  cardScheme: types.optional(AmountDecimal$inboundSchema),
+  interchange: types.optional(AmountDecimal$inboundSchema),
+  discount: types.optional(AmountDecimal$inboundSchema),
+  moovProcessing: AmountDecimal$inboundSchema,
 });
 /** @internal */
 export type MoovFeeDetails$Outbound = {
-  cardScheme?: string | undefined;
-  interchange?: string | undefined;
-  discount?: string | undefined;
-  moovProcessing: string;
+  cardScheme?: AmountDecimal$Outbound | undefined;
+  interchange?: AmountDecimal$Outbound | undefined;
+  discount?: AmountDecimal$Outbound | undefined;
+  moovProcessing: AmountDecimal$Outbound;
 };
 
 /** @internal */
@@ -55,10 +61,10 @@ export const MoovFeeDetails$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MoovFeeDetails
 > = z.object({
-  cardScheme: z.string().optional(),
-  interchange: z.string().optional(),
-  discount: z.string().optional(),
-  moovProcessing: z.string(),
+  cardScheme: AmountDecimal$outboundSchema.optional(),
+  interchange: AmountDecimal$outboundSchema.optional(),
+  discount: AmountDecimal$outboundSchema.optional(),
+  moovProcessing: AmountDecimal$outboundSchema,
 });
 
 export function moovFeeDetailsToJSON(moovFeeDetails: MoovFeeDetails): string {

package/src/models/components/partnerpricingagreement.ts

@@ -73,11 +73,19 @@ export type PartnerPricingAgreement = {
    */
   monthlyPlatformFee: MonthlyPlatformFee;
   /**
-   *   The decimal-formatted numerical string of the revenue split for partner.
+   * The agreement this one replaced. Only set when the agreement was created by replacing another.
+   */
+  priorAgreementID?: string | undefined;
+  /**
+   * The date and time the prior agreement was terminated.
+   */
+  priorAgreementTerminatedOn?: Date | undefined;
+  /**
+   * The decimal-formatted numerical string of the revenue split for partner.
    *
    * @remarks
    *
-   *   For example, 2.25% is '2.25'.
+   * For example, 2.25% is '2.25'.
    */
   revenueShare: string;
 };
@@ -99,6 +107,8 @@ export const PartnerPricingAgreement$inboundSchema: z.ZodType<
   billableFees: z.array(BillableFee$inboundSchema),
   minimumCommitment: MinimumCommitment$inboundSchema,
   monthlyPlatformFee: MonthlyPlatformFee$inboundSchema,
+  priorAgreementID: types.optional(types.string()),
+  priorAgreementTerminatedOn: types.optional(types.date()),
   revenueShare: types.string(),
 });
 /** @internal */
@@ -114,6 +124,8 @@ export type PartnerPricingAgreement$Outbound = {
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
   monthlyPlatformFee: MonthlyPlatformFee$Outbound;
+  priorAgreementID?: string | undefined;
+  priorAgreementTerminatedOn?: string | undefined;
   revenueShare: string;
 };
 
@@ -134,6 +146,9 @@ export const PartnerPricingAgreement$outboundSchema: z.ZodType<
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,
   monthlyPlatformFee: MonthlyPlatformFee$outboundSchema,
+  priorAgreementID: z.string().optional(),
+  priorAgreementTerminatedOn: z.date().transform(v => v.toISOString())
+    .optional(),
   revenueShare: z.string(),
 });
 

package/src/models/components/paymentlink.ts

@@ -138,13 +138,14 @@ export type PaymentLink = {
    * Options for payment links used to collect payment.
    */
   payment?: PaymentLinkPaymentDetails | undefined;
+  /**
+   * Options for payout links used to send a payout.
+   */
   payout?: PaymentLinkPayoutDetails | undefined;
   /**
-   * Options for custom amount payment links.
+   * A custom amount payment link shares all the options of a `payment` link, but the payor chooses how much to
    *
    * @remarks
-   *
-   * A custom amount payment link shares all the options of a `payment` link, but the payor chooses how much to
    * pay rather than the merchant fixing the amount. The amount may optionally be constrained to a range.
    */
   customAmountPayment?: PaymentLinkCustomAmountPaymentDetails | undefined;

package/src/models/components/paymentlinkcustomamountpaymentdetails.ts

@@ -38,11 +38,9 @@ import {
 } from "./collectionpaymentmethodtype.js";
 
 /**
- * Options for custom amount payment links.
+ * A custom amount payment link shares all the options of a `payment` link, but the payor chooses how much to
  *
  * @remarks
- *
- * A custom amount payment link shares all the options of a `payment` link, but the payor chooses how much to
  * pay rather than the merchant fixing the amount. The amount may optionally be constrained to a range.
  */
 export type PaymentLinkCustomAmountPaymentDetails = {

package/src/models/components/paymentlinkcustomamountpaymentdetailsupdate.ts

@@ -38,11 +38,9 @@ import {
 } from "./collectionpaymentmethodtype.js";
 
 /**
- * Options for custom amount payment links.
+ * A custom amount payment link shares all the options of a `payment` link, but the payor chooses how much to
  *
  * @remarks
- *
- * A custom amount payment link shares all the options of a `payment` link, but the payor chooses how much to
  * pay rather than the merchant fixing the amount. The amount may optionally be constrained to a range.
  */
 export type PaymentLinkCustomAmountPaymentDetailsUpdate = {

package/src/models/components/paymentlinkpayoutdetails.ts

@@ -30,6 +30,9 @@ import {
   PushOptions$outboundSchema,
 } from "./pushoptions.js";
 
+/**
+ * Options for payout links used to send a payout.
+ */
 export type PaymentLinkPayoutDetails = {
   /**
    * A list of payment methods that should be supported for this payment link.
@@ -49,20 +52,16 @@ export type PaymentLinkPayoutDetails = {
    */
   metadata?: { [k: string]: string } | undefined;
   /**
-   * Delivery options for push-to-card payouts. Only applies when `allowedMethods` includes `push-to-card`.
-   *
-   * @remarks
-   *
-   * The `deferred` speed and `deferredBy` apply to `push-to-card` only. Other push methods
-   * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
+   * Delivery options for `push-to-card` and `push-to-apple-pay` payouts.
    */
   pushOptions?: PushOptions | undefined;
   /**
-   * Indicates which party bears the fee, keyed by disbursement payment method (`DisbursementPaymentMethodType`).
+   * Indicates which party pays the fee, keyed by `PayoutFeePaidByKey`. If keys are not set,
    *
    * @remarks
+   * the default is `source`.
    *
-   * Sparse — include only the methods you want to attribute. Any method left unset defaults to `source`.
+   * Possible `PayoutFeePaidByKey` keys: `instant-push-to-card`, `deferred-push-to-card`, `instant-push-to-apple-pay`, `deferred-push-to-apple-pay`, `instant-bank-credit` (API v2026.01.00 and later), `rtp-credit`, `ach-credit-same-day`, `ach-credit-standard`, `push-to-google-pay`
    */
   feePaidBy?: { [k: string]: FeePaidBy } | undefined;
 };

package/src/models/components/paymentlinkpayoutdetailsupdate.ts

@@ -30,6 +30,9 @@ import {
   PushOptionsUpdate$outboundSchema,
 } from "./pushoptionsupdate.js";
 
+/**
+ * Options for payout links used to send a payout.
+ */
 export type PaymentLinkPayoutDetailsUpdate = {
   /**
    * A list of payment methods that should be supported for this payment link.
@@ -49,20 +52,16 @@ export type PaymentLinkPayoutDetailsUpdate = {
    */
   metadata?: { [k: string]: string } | undefined;
   /**
-   * Delivery options for push-to-card payouts. Only applies when `allowedMethods` includes `push-to-card`.
-   *
-   * @remarks
-   *
-   * The `deferred` speed and `deferredBy` apply to `push-to-card` only. Other push methods
-   * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
+   * Delivery options for `push-to-card` and `push-to-apple-pay` payouts.
    */
   pushOptions?: PushOptionsUpdate | undefined;
   /**
-   * Indicates which party bears the fee, keyed by disbursement payment method (`DisbursementPaymentMethodType`).
+   * Indicates which party pays the fee, keyed by `PayoutFeePaidByKey`. If keys are not set,
    *
    * @remarks
+   * the default is `source`.
    *
-   * Sparse — include only the methods you want to attribute. Any method left unset defaults to `source`.
+   * Possible `PayoutFeePaidByKey` keys: `instant-push-to-card`, `deferred-push-to-card`, `instant-push-to-apple-pay`, `deferred-push-to-apple-pay`, `rtp-credit`, `ach-credit-same-day`, `ach-credit-standard`, `push-to-google-pay`
    */
   feePaidBy?: { [k: string]: FeePaidBy } | undefined;
 };