@moovio/sdk 26.1.9 → 26.2.1

package/src/models/components/transferdestination.ts

@@ -25,11 +25,21 @@ import {
   CardTransactionDetails$outboundSchema,
 } from "./cardtransactiondetails.js";
 import {
-  RTPTransactionDetails,
-  RTPTransactionDetails$inboundSchema,
-  RTPTransactionDetails$Outbound,
-  RTPTransactionDetails$outboundSchema,
-} from "./rtptransactiondetails.js";
+  InstantBankTransactionDetails,
+  InstantBankTransactionDetails$inboundSchema,
+  InstantBankTransactionDetails$Outbound,
+  InstantBankTransactionDetails$outboundSchema,
+} from "./instantbanktransactiondetails.js";
+import {
+  RTPFailureCode,
+  RTPFailureCode$inboundSchema,
+  RTPFailureCode$outboundSchema,
+} from "./rtpfailurecode.js";
+import {
+  RTPTransactionStatus,
+  RTPTransactionStatus$inboundSchema,
+  RTPTransactionStatus$outboundSchema,
+} from "./rtptransactionstatus.js";
 import {
   TransferAccount,
   TransferAccount$inboundSchema,
@@ -60,6 +70,30 @@ import {
   TransferPaymentMethodType$outboundSchema,
 } from "./transferpaymentmethodtype.js";
 
+/**
+ * DEPRECATED: use `InstantBankTransactionDetails` instead (v2026.04.00 or later). RTP specific details about the transaction.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export type RtpDetails = {
+  /**
+   * Status of a transaction within the RTP lifecycle.
+   */
+  status?: RTPTransactionStatus | undefined;
+  /**
+   * Response code returned by network on failure.
+   */
+  networkResponseCode?: string | undefined;
+  /**
+   * Status codes for RTP failures.
+   */
+  failureCode?: RTPFailureCode | undefined;
+  initiatedOn?: Date | undefined;
+  completedOn?: Date | undefined;
+  failedOn?: Date | undefined;
+  acceptedWithoutPostingOn?: Date | undefined;
+};
+
 export type TransferDestination = {
   paymentMethodID: string;
   /**
@@ -89,11 +123,73 @@ export type TransferDestination = {
    */
   cardDetails?: CardTransactionDetails | undefined;
   /**
-   * RTP specific details about the transaction.
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  rtpDetails?: RtpDetails | undefined;
+  /**
+   * Instant-bank specific details about the transaction.
    */
-  rtpDetails?: RTPTransactionDetails | undefined;
+  instantBankDetails?: InstantBankTransactionDetails | undefined;
 };
 
+/** @internal */
+export const RtpDetails$inboundSchema: z.ZodType<
+  RtpDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: RTPTransactionStatus$inboundSchema.optional(),
+  networkResponseCode: z.string().optional(),
+  failureCode: RTPFailureCode$inboundSchema.optional(),
+  initiatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  completedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  failedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  acceptedWithoutPostingOn: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+});
+/** @internal */
+export type RtpDetails$Outbound = {
+  status?: string | undefined;
+  networkResponseCode?: string | undefined;
+  failureCode?: string | undefined;
+  initiatedOn?: string | undefined;
+  completedOn?: string | undefined;
+  failedOn?: string | undefined;
+  acceptedWithoutPostingOn?: string | undefined;
+};
+
+/** @internal */
+export const RtpDetails$outboundSchema: z.ZodType<
+  RtpDetails$Outbound,
+  z.ZodTypeDef,
+  RtpDetails
+> = z.object({
+  status: RTPTransactionStatus$outboundSchema.optional(),
+  networkResponseCode: z.string().optional(),
+  failureCode: RTPFailureCode$outboundSchema.optional(),
+  initiatedOn: z.date().transform(v => v.toISOString()).optional(),
+  completedOn: z.date().transform(v => v.toISOString()).optional(),
+  failedOn: z.date().transform(v => v.toISOString()).optional(),
+  acceptedWithoutPostingOn: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function rtpDetailsToJSON(rtpDetails: RtpDetails): string {
+  return JSON.stringify(RtpDetails$outboundSchema.parse(rtpDetails));
+}
+export function rtpDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<RtpDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RtpDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RtpDetails' from JSON`,
+  );
+}
+
 /** @internal */
 export const TransferDestination$inboundSchema: z.ZodType<
   TransferDestination,
@@ -109,7 +205,8 @@ export const TransferDestination$inboundSchema: z.ZodType<
   achDetails: ACHTransactionDetails$inboundSchema.optional(),
   applePay: ApplePayResponse$inboundSchema.optional(),
   cardDetails: CardTransactionDetails$inboundSchema.optional(),
-  rtpDetails: RTPTransactionDetails$inboundSchema.optional(),
+  rtpDetails: z.lazy(() => RtpDetails$inboundSchema).optional(),
+  instantBankDetails: InstantBankTransactionDetails$inboundSchema.optional(),
 });
 /** @internal */
 export type TransferDestination$Outbound = {
@@ -122,7 +219,8 @@ export type TransferDestination$Outbound = {
   achDetails?: ACHTransactionDetails$Outbound | undefined;
   applePay?: ApplePayResponse$Outbound | undefined;
   cardDetails?: CardTransactionDetails$Outbound | undefined;
-  rtpDetails?: RTPTransactionDetails$Outbound | undefined;
+  rtpDetails?: RtpDetails$Outbound | undefined;
+  instantBankDetails?: InstantBankTransactionDetails$Outbound | undefined;
 };
 
 /** @internal */
@@ -140,7 +238,8 @@ export const TransferDestination$outboundSchema: z.ZodType<
   achDetails: ACHTransactionDetails$outboundSchema.optional(),
   applePay: ApplePayResponse$outboundSchema.optional(),
   cardDetails: CardTransactionDetails$outboundSchema.optional(),
-  rtpDetails: RTPTransactionDetails$outboundSchema.optional(),
+  rtpDetails: z.lazy(() => RtpDetails$outboundSchema).optional(),
+  instantBankDetails: InstantBankTransactionDetails$outboundSchema.optional(),
 });
 
 export function transferDestinationToJSON(

package/src/models/components/transferpaymentmethodscard.ts

@@ -91,6 +91,9 @@ export type TransferPaymentMethodsCard = {
    * The name of the cardholder as it appears on the card.
    */
   holderName?: string | undefined;
+  /**
+   * The billing address associated with the card.
+   */
   billingAddress: CardAddress;
   /**
    * The results of submitting cardholder data to a card network for verification.
@@ -108,6 +111,12 @@ export type TransferPaymentMethodsCard = {
    * Indicates cardholder has authorized card to be stored for future payments.
    */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
   /**
    * The results of the most recent card update request.

package/src/models/components/updatecard.ts

@@ -34,12 +34,39 @@ export type UpdateCard = {
    * [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).
    */
   e2ee?: E2EETokenUpdate | undefined;
+  /**
+   * Updated billing address to store on file for the card.
+   */
   billingAddress?: UpdateCardAddress | undefined;
   expiration?: UpdateCardExpiration | undefined;
+  /**
+   * The card's 3- or 4-digit card verification value. Providing this triggers a new $0 verification authorization, which performs both CVV and address verification.
+   */
   cardCvv?: string | undefined;
+  /**
+   * Indicates cardholder has authorized card to be stored for future payments (e.g., recurring payments).
+   *
+   * @remarks
+   * If true and no `merchantAccountID` is provided, the partner account's ID is automatically used as the merchant account for verification.
+   */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
+  /**
+   * If true, submits the cardholder's name to the card network for verification as part of the $0 authorization.
+   *
+   * @remarks
+   * Only supported for Visa and Mastercard; requesting name verification for American Express or Discover will return an error.
+   */
   verifyName?: boolean | undefined;
+  /**
+   * Updated name of the cardholder as it appears on the card.
+   */
   holderName?: string | undefined;
 };
 

package/src/models/components/updatecardaddress.ts

@@ -8,11 +8,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpdateCardAddress = {
+  /**
+   * Street address line 1.
+   */
   addressLine1?: string | undefined;
+  /**
+   * Street address line 2 (e.g., apartment or suite number).
+   */
   addressLine2?: string | undefined;
+  /**
+   * City name.
+   */
   city?: string | undefined;
+  /**
+   * Two-letter state or province code.
+   */
   stateOrProvince?: string | undefined;
+  /**
+   * Postal or ZIP code.
+   */
   postalCode?: string | undefined;
+  /**
+   * Two-letter ISO 3166-1 country code.
+   */
   country?: string | undefined;
 };
 

package/src/models/components/updatecardexpiration.ts

@@ -8,7 +8,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpdateCardExpiration = {
+  /**
+   * Two-digit month the card expires.
+   */
   month?: string | undefined;
+  /**
+   * Two-digit year the card expires.
+   */
   year?: string | undefined;
 };
 

package/src/models/components/webhookbillingstatementcreated.ts

@@ -8,6 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type WebhookBillingStatementCreated = {
+  accountID: string;
   statementID: string;
 };
 
@@ -17,10 +18,12 @@ export const WebhookBillingStatementCreated$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  accountID: z.string(),
   statementID: z.string(),
 });
 /** @internal */
 export type WebhookBillingStatementCreated$Outbound = {
+  accountID: string;
   statementID: string;
 };
 
@@ -30,6 +33,7 @@ export const WebhookBillingStatementCreated$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   WebhookBillingStatementCreated
 > = z.object({
+  accountID: z.string(),
   statementID: z.string(),
 });
 

package/src/models/components/webhookdata.ts

@@ -265,11 +265,11 @@ export type WebhookData =
   | WebhookDataTicketCreated
   | WebhookDataTicketMessageAdded
   | WebhookDataWalletCreated
+  | WebhookBillingStatementCreated
   | WebhookDataAccountCreated
   | WebhookDataAccountUpdated
   | WebhookDataAccountDisconnected
-  | WebhookDataNetworkIDUpdated
-  | WebhookBillingStatementCreated;
+  | WebhookDataNetworkIDUpdated;
 
 /** @internal */
 export const WebhookData$inboundSchema: z.ZodType<
@@ -309,11 +309,11 @@ export const WebhookData$inboundSchema: z.ZodType<
   WebhookDataTicketCreated$inboundSchema,
   WebhookDataTicketMessageAdded$inboundSchema,
   WebhookDataWalletCreated$inboundSchema,
+  WebhookBillingStatementCreated$inboundSchema,
   WebhookDataAccountCreated$inboundSchema,
   WebhookDataAccountUpdated$inboundSchema,
   WebhookDataAccountDisconnected$inboundSchema,
   WebhookDataNetworkIDUpdated$inboundSchema,
-  WebhookBillingStatementCreated$inboundSchema,
 ]);
 /** @internal */
 export type WebhookData$Outbound =
@@ -349,11 +349,11 @@ export type WebhookData$Outbound =
   | WebhookDataTicketCreated$Outbound
   | WebhookDataTicketMessageAdded$Outbound
   | WebhookDataWalletCreated$Outbound
+  | WebhookBillingStatementCreated$Outbound
   | WebhookDataAccountCreated$Outbound
   | WebhookDataAccountUpdated$Outbound
   | WebhookDataAccountDisconnected$Outbound
-  | WebhookDataNetworkIDUpdated$Outbound
-  | WebhookBillingStatementCreated$Outbound;
+  | WebhookDataNetworkIDUpdated$Outbound;
 
 /** @internal */
 export const WebhookData$outboundSchema: z.ZodType<
@@ -393,11 +393,11 @@ export const WebhookData$outboundSchema: z.ZodType<
   WebhookDataTicketCreated$outboundSchema,
   WebhookDataTicketMessageAdded$outboundSchema,
   WebhookDataWalletCreated$outboundSchema,
+  WebhookBillingStatementCreated$outboundSchema,
   WebhookDataAccountCreated$outboundSchema,
   WebhookDataAccountUpdated$outboundSchema,
   WebhookDataAccountDisconnected$outboundSchema,
   WebhookDataNetworkIDUpdated$outboundSchema,
-  WebhookBillingStatementCreated$outboundSchema,
 ]);
 
 export function webhookDataToJSON(webhookData: WebhookData): string {

package/src/models/operations/acceptdispute.ts

@@ -9,24 +9,6 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type AcceptDisputeGlobals = {
-  /**
-   * Specify an API version.
-   *
-   * @remarks
-   *
-   * API versioning follows the format `vYYYY.QQ.BB`, where
-   *   - `YYYY` is the year
-   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
-   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
-   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
-   *
-   * The `dev` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
-   * When no version is specified, the API defaults to `v2024.01.00`.
-   */
-  xMoovVersion?: string | undefined;
-};
-
 export type AcceptDisputeRequest = {
   accountID: string;
   disputeID: string;
@@ -37,53 +19,6 @@ export type AcceptDisputeResponse = {
   result: components.Dispute;
 };
 
-/** @internal */
-export const AcceptDisputeGlobals$inboundSchema: z.ZodType<
-  AcceptDisputeGlobals,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  "X-Moov-Version": z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "X-Moov-Version": "xMoovVersion",
-  });
-});
-/** @internal */
-export type AcceptDisputeGlobals$Outbound = {
-  "X-Moov-Version"?: string | undefined;
-};
-
-/** @internal */
-export const AcceptDisputeGlobals$outboundSchema: z.ZodType<
-  AcceptDisputeGlobals$Outbound,
-  z.ZodTypeDef,
-  AcceptDisputeGlobals
-> = z.object({
-  xMoovVersion: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    xMoovVersion: "X-Moov-Version",
-  });
-});
-
-export function acceptDisputeGlobalsToJSON(
-  acceptDisputeGlobals: AcceptDisputeGlobals,
-): string {
-  return JSON.stringify(
-    AcceptDisputeGlobals$outboundSchema.parse(acceptDisputeGlobals),
-  );
-}
-export function acceptDisputeGlobalsFromJSON(
-  jsonString: string,
-): SafeParseResult<AcceptDisputeGlobals, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AcceptDisputeGlobals$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AcceptDisputeGlobals' from JSON`,
-  );
-}
-
 /** @internal */
 export const AcceptDisputeRequest$inboundSchema: z.ZodType<
   AcceptDisputeRequest,

package/src/models/operations/assignaccountcountries.ts

@@ -9,24 +9,6 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type AssignAccountCountriesGlobals = {
-  /**
-   * Specify an API version.
-   *
-   * @remarks
-   *
-   * API versioning follows the format `vYYYY.QQ.BB`, where
-   *   - `YYYY` is the year
-   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
-   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
-   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
-   *
-   * The `dev` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
-   * When no version is specified, the API defaults to `v2024.01.00`.
-   */
-  xMoovVersion?: string | undefined;
-};
-
 export type AssignAccountCountriesRequest = {
   accountID: string;
   accountCountries: components.AccountCountries;
@@ -37,55 +19,6 @@ export type AssignAccountCountriesResponse = {
   result: components.AccountCountries;
 };
 
-/** @internal */
-export const AssignAccountCountriesGlobals$inboundSchema: z.ZodType<
-  AssignAccountCountriesGlobals,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  "X-Moov-Version": z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "X-Moov-Version": "xMoovVersion",
-  });
-});
-/** @internal */
-export type AssignAccountCountriesGlobals$Outbound = {
-  "X-Moov-Version"?: string | undefined;
-};
-
-/** @internal */
-export const AssignAccountCountriesGlobals$outboundSchema: z.ZodType<
-  AssignAccountCountriesGlobals$Outbound,
-  z.ZodTypeDef,
-  AssignAccountCountriesGlobals
-> = z.object({
-  xMoovVersion: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    xMoovVersion: "X-Moov-Version",
-  });
-});
-
-export function assignAccountCountriesGlobalsToJSON(
-  assignAccountCountriesGlobals: AssignAccountCountriesGlobals,
-): string {
-  return JSON.stringify(
-    AssignAccountCountriesGlobals$outboundSchema.parse(
-      assignAccountCountriesGlobals,
-    ),
-  );
-}
-export function assignAccountCountriesGlobalsFromJSON(
-  jsonString: string,
-): SafeParseResult<AssignAccountCountriesGlobals, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AssignAccountCountriesGlobals$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AssignAccountCountriesGlobals' from JSON`,
-  );
-}
-
 /** @internal */
 export const AssignAccountCountriesRequest$inboundSchema: z.ZodType<
   AssignAccountCountriesRequest,

package/src/models/operations/batchgettransfers.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type BatchGetTransfersRequest = {
+  accountID: string;
+  batchGetTransfersRequest: components.BatchGetTransfersRequest;
+};
+
+export type BatchGetTransfersResponse = {
+  headers: { [k: string]: Array<string> };
+  result: { [k: string]: components.Transfer };
+};
+
+/** @internal */
+export const BatchGetTransfersRequest$inboundSchema: z.ZodType<
+  BatchGetTransfersRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  BatchGetTransfersRequest: components.BatchGetTransfersRequest$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "BatchGetTransfersRequest": "batchGetTransfersRequest",
+  });
+});
+/** @internal */
+export type BatchGetTransfersRequest$Outbound = {
+  accountID: string;
+  BatchGetTransfersRequest: components.BatchGetTransfersRequest$Outbound;
+};
+
+/** @internal */
+export const BatchGetTransfersRequest$outboundSchema: z.ZodType<
+  BatchGetTransfersRequest$Outbound,
+  z.ZodTypeDef,
+  BatchGetTransfersRequest
+> = z.object({
+  accountID: z.string(),
+  batchGetTransfersRequest: components.BatchGetTransfersRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    batchGetTransfersRequest: "BatchGetTransfersRequest",
+  });
+});
+
+export function batchGetTransfersRequestToJSON(
+  batchGetTransfersRequest: BatchGetTransfersRequest,
+): string {
+  return JSON.stringify(
+    BatchGetTransfersRequest$outboundSchema.parse(batchGetTransfersRequest),
+  );
+}
+export function batchGetTransfersRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<BatchGetTransfersRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BatchGetTransfersRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BatchGetTransfersRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const BatchGetTransfersResponse$inboundSchema: z.ZodType<
+  BatchGetTransfersResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: z.record(components.Transfer$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type BatchGetTransfersResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: { [k: string]: components.Transfer$Outbound };
+};
+
+/** @internal */
+export const BatchGetTransfersResponse$outboundSchema: z.ZodType<
+  BatchGetTransfersResponse$Outbound,
+  z.ZodTypeDef,
+  BatchGetTransfersResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.record(components.Transfer$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function batchGetTransfersResponseToJSON(
+  batchGetTransfersResponse: BatchGetTransfersResponse,
+): string {
+  return JSON.stringify(
+    BatchGetTransfersResponse$outboundSchema.parse(batchGetTransfersResponse),
+  );
+}
+export function batchGetTransfersResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<BatchGetTransfersResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BatchGetTransfersResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BatchGetTransfersResponse' from JSON`,
+  );
+}