mollie-api-typescript 1.3.2 → 1.3.4

package/src/models/verificationofpayeerequest.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 081487b0aab2
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  CreditorBankAccount,
+  CreditorBankAccount$inboundSchema,
+  CreditorBankAccount$Outbound,
+  CreditorBankAccount$outboundSchema,
+} from "./creditorbankaccount.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * The request body for performing a Verification of Payee (VoP) check. VoP allows you to verify the
+ *
+ * @remarks
+ * account holder name against the records held by the receiving bank before initiating a transfer.
+ */
+export type VerificationOfPayeeRequest = {
+  /**
+   * The bank account details of the creditor (recipient) for Verification of Payee.
+   */
+  creditorBankAccount: CreditorBankAccount;
+  /**
+   * Whether to create the entity in test mode or live mode.
+   *
+   * @remarks
+   *
+   * Most API credentials are specifically created for either live mode or test mode, in which case this parameter must
+   * not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+   * `testmode` to `true`.
+   */
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const VerificationOfPayeeRequest$inboundSchema: z.ZodType<
+  VerificationOfPayeeRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  creditorBankAccount: CreditorBankAccount$inboundSchema,
+  testmode: z.nullable(z.boolean()).optional(),
+});
+/** @internal */
+export type VerificationOfPayeeRequest$Outbound = {
+  creditorBankAccount: CreditorBankAccount$Outbound;
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const VerificationOfPayeeRequest$outboundSchema: z.ZodType<
+  VerificationOfPayeeRequest$Outbound,
+  z.ZodTypeDef,
+  VerificationOfPayeeRequest
+> = z.object({
+  creditorBankAccount: CreditorBankAccount$outboundSchema,
+  testmode: z.nullable(z.boolean()).optional(),
+});
+
+export function verificationOfPayeeRequestToJSON(
+  verificationOfPayeeRequest: VerificationOfPayeeRequest,
+): string {
+  return JSON.stringify(
+    VerificationOfPayeeRequest$outboundSchema.parse(verificationOfPayeeRequest),
+  );
+}
+export function verificationOfPayeeRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationOfPayeeRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationOfPayeeRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationOfPayeeRequest' from JSON`,
+  );
+}

package/src/models/verificationofpayeeresponse.ts

@@ -0,0 +1,163 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 66511ce91f9f
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  CreditorBankAccountResponse,
+  CreditorBankAccountResponse$inboundSchema,
+  CreditorBankAccountResponse$Outbound,
+  CreditorBankAccountResponse$outboundSchema,
+} from "./creditorbankaccountresponse.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  VerificationResultEnum,
+  VerificationResultEnum$inboundSchema,
+  VerificationResultEnum$outboundSchema,
+} from "./verificationresultenum.js";
+
+export type VerificationOfPayeeResponseVerificationResult = {
+  /**
+   * The result of the Verification of Payee check.
+   */
+  outcome: VerificationResultEnum;
+  /**
+   * The corrected name if the verification result is `close_match`.
+   */
+  accountHolderName?: string | undefined;
+};
+
+/**
+ * The Verification of Payee response object. Contains the result of verifying the creditor's
+ *
+ * @remarks
+ * account holder name against the records held by the receiving bank.
+ */
+export type VerificationOfPayeeResponse = {
+  /**
+   * Indicates the response contains a payee verification object. Will always contain the string
+   *
+   * @remarks
+   * `business-account-payee-verification` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The bank account details of the creditor (recipient) for Verification of Payee.
+   */
+  creditorBankAccount: CreditorBankAccountResponse;
+  verificationResult: VerificationOfPayeeResponseVerificationResult;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+};
+
+/** @internal */
+export const VerificationOfPayeeResponseVerificationResult$inboundSchema:
+  z.ZodType<
+    VerificationOfPayeeResponseVerificationResult,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    outcome: VerificationResultEnum$inboundSchema,
+    accountHolderName: z.string().optional(),
+  });
+/** @internal */
+export type VerificationOfPayeeResponseVerificationResult$Outbound = {
+  outcome: string;
+  accountHolderName?: string | undefined;
+};
+
+/** @internal */
+export const VerificationOfPayeeResponseVerificationResult$outboundSchema:
+  z.ZodType<
+    VerificationOfPayeeResponseVerificationResult$Outbound,
+    z.ZodTypeDef,
+    VerificationOfPayeeResponseVerificationResult
+  > = z.object({
+    outcome: VerificationResultEnum$outboundSchema,
+    accountHolderName: z.string().optional(),
+  });
+
+export function verificationOfPayeeResponseVerificationResultToJSON(
+  verificationOfPayeeResponseVerificationResult:
+    VerificationOfPayeeResponseVerificationResult,
+): string {
+  return JSON.stringify(
+    VerificationOfPayeeResponseVerificationResult$outboundSchema.parse(
+      verificationOfPayeeResponseVerificationResult,
+    ),
+  );
+}
+export function verificationOfPayeeResponseVerificationResultFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  VerificationOfPayeeResponseVerificationResult,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VerificationOfPayeeResponseVerificationResult$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'VerificationOfPayeeResponseVerificationResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const VerificationOfPayeeResponse$inboundSchema: z.ZodType<
+  VerificationOfPayeeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  creditorBankAccount: CreditorBankAccountResponse$inboundSchema,
+  verificationResult: z.lazy(() =>
+    VerificationOfPayeeResponseVerificationResult$inboundSchema
+  ),
+  createdAt: z.string(),
+});
+/** @internal */
+export type VerificationOfPayeeResponse$Outbound = {
+  resource: string;
+  creditorBankAccount: CreditorBankAccountResponse$Outbound;
+  verificationResult: VerificationOfPayeeResponseVerificationResult$Outbound;
+  createdAt: string;
+};
+
+/** @internal */
+export const VerificationOfPayeeResponse$outboundSchema: z.ZodType<
+  VerificationOfPayeeResponse$Outbound,
+  z.ZodTypeDef,
+  VerificationOfPayeeResponse
+> = z.object({
+  resource: z.string(),
+  creditorBankAccount: CreditorBankAccountResponse$outboundSchema,
+  verificationResult: z.lazy(() =>
+    VerificationOfPayeeResponseVerificationResult$outboundSchema
+  ),
+  createdAt: z.string(),
+});
+
+export function verificationOfPayeeResponseToJSON(
+  verificationOfPayeeResponse: VerificationOfPayeeResponse,
+): string {
+  return JSON.stringify(
+    VerificationOfPayeeResponse$outboundSchema.parse(
+      verificationOfPayeeResponse,
+    ),
+  );
+}
+export function verificationOfPayeeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationOfPayeeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationOfPayeeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationOfPayeeResponse' from JSON`,
+  );
+}

package/src/models/verificationresultenum.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5cf78f047cb8
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * The result of the Verification of Payee check.
+ */
+export const VerificationResultEnum = {
+  Match: "match",
+  NoMatch: "no-match",
+  CloseMatch: "close-match",
+  NotAvailable: "not-available",
+} as const;
+/**
+ * The result of the Verification of Payee check.
+ */
+export type VerificationResultEnum = OpenEnum<typeof VerificationResultEnum>;
+
+/** @internal */
+export const VerificationResultEnum$inboundSchema: z.ZodType<
+  VerificationResultEnum,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(VerificationResultEnum);
+/** @internal */
+export const VerificationResultEnum$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  VerificationResultEnum
+> = openEnums.outboundSchema(VerificationResultEnum);

package/src/sdk/sdk.ts

@@ -28,6 +28,8 @@ import { Sessions } from "./sessions.js";
 import { Settlements } from "./settlements.js";
 import { Subscriptions } from "./subscriptions.js";
 import { Terminals } from "./terminals.js";
+import { Transfers } from "./transfers.js";
+import { VerifyPayees } from "./verifypayees.js";
 import { Wallets } from "./wallets.js";
 import { WebhookEvents } from "./webhookevents.js";
 import { Webhooks } from "./webhooks.js";
@@ -167,4 +169,14 @@ export class Client extends ClientSDK {
   get salesInvoices(): SalesInvoices {
     return (this._salesInvoices ??= new SalesInvoices(this._options));
   }
+
+  private _transfers?: Transfers;
+  get transfers(): Transfers {
+    return (this._transfers ??= new Transfers(this._options));
+  }
+
+  private _verifyPayees?: VerifyPayees;
+  get verifyPayees(): VerifyPayees {
+    return (this._verifyPayees ??= new VerifyPayees(this._options));
+  }
 }

package/src/sdk/transfers.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1e842c518280
+ */
+
+import { transfersCreate } from "../funcs/transfersCreate.js";
+import { transfersGet } from "../funcs/transfersGet.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Transfers extends ClientSDK {
+  /**
+   * Create transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in beta testing, and the final specification may still change.
+   *
+   * Create a SEPA Credit Transfer from your Mollie Business Account.
+   *
+   * To initiate a transfer, you must provide the transfer scheme, the amount, the debtor IBAN (your Mollie Business
+   * Account IBAN), and the creditor (recipient) details.
+   *
+   * Each request must include an `Idempotency-Key` header to prevent duplicate transfers, and must be signed using the
+   * `X-Client-Signature` and `X-Client-Signed-At` headers.
+   *
+   * ### Simulating transfer scenarios in test mode
+   *
+   * In test mode, you can simulate various transfer scenarios by adjusting the transfer amount. This allows you to
+   * mimic the typical status progression of a real-world transfer. Note that a transfer's progression will stop once
+   * it reaches a final status: `blocked`, `failed`, or `processed`.
+   *
+   * | Amount  | Scenario                                           | Webhook sequence                                                                                                                                                   |
+   * |---------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+   * | `11.00` | Transfer initiated, pending review by Mollie       | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.pending-review`                                         |
+   * | `12.00` | Transfer initiated, blocked by Mollie              | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.pending-review` → `business-account-transfer.blocked`   |
+   * | `13.00` | Transfer initiated, failed on scheme submission    | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.failed`                                                 |
+   * | Other   | Default: transfer is processed                     | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.processed`                                              |
+   */
+  async create(
+    request: operations.CreateTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.TransferResponse> {
+    return unwrapAsync(transfersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in beta testing, and the final specification may still change.
+   *
+   * Retrieve a single transfer object by its transfer ID. This allows you to check the current status
+   * and details of a previously created transfer.
+   */
+  async get(
+    request: operations.GetTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.TransferResponse> {
+    return unwrapAsync(transfersGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/verifypayees.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: efebd3014f53
+ */
+
+import { verifyPayeesCreate } from "../funcs/verifyPayeesCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class VerifyPayees extends ClientSDK {
+  /**
+   * Verify Payee
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in beta testing, and the final specification may still change.
+   *
+   * Perform a Verification of Payee (VoP) check. This allows you to verify the account holder name against the
+   * records held by the receiving bank before initiating a transfer.
+   *
+   * The verification result indicates whether the provided name matches, closely matches, or does not match the
+   * name on file at the receiving bank. This helps prevent misdirected payments.
+   *
+   * ### Simulating verification scenarios in test mode
+   *
+   * In test mode, you can simulate various verification outcomes by adjusting the creditor name in the
+   * `creditorBankAccount.accountHolderName` property. This allows you to test all possible Verification of Payee
+   * results without needing special properties. The names are case insensitive.
+   *
+   * | Account holder name                    | Scenario                                      | Verification result | Suggested name |
+   * |----------------------------------------|-----------------------------------------------|---------------------|----------------|
+   * | `John Close Match`                     | Name closely matches the bank records          | `close-match`       | `John Match`   |
+   * | `John No Match`                        | Name does not match the bank records           | `no-match`          | —              |
+   * | `John Unavailable`                     | Verification is not available                  | `not-available`     | —              |
+   * | Any other name                         | Default: name matches the bank records         | `match`             | —              |
+   */
+  async create(
+    request?: operations.VerifyPayeeRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.VerificationOfPayeeResponse> {
+    return unwrapAsync(verifyPayeesCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}