mollie-api-typescript 1.6.10 → 1.7.1

package/src/models/payoutrequest.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 39795b6f75e2
+ */
+
+import * as z from "zod/v3";
+import {
+  AmountNullable,
+  AmountNullable$Outbound,
+  AmountNullable$outboundSchema,
+} from "./amountnullable.js";
+
+export type PayoutRequest = {
+  /**
+   * The identifier of the balance that will be paid out. Example: `bal_gVMhHKqSSRYJyPsuoPNFH`.
+   */
+  balanceId: string;
+  /**
+   * The amount to pay out. When omitted from the request, the full available balance minus any configured
+   *
+   * @remarks
+   * balance reserve is paid out.
+   *
+   * Merchants registered in the United Kingdom cannot specify a custom amount — omit this field to pay out
+   * the full available balance.
+   *
+   * The value in the response reflects the amount paid out, excluding any applicable fees.
+   */
+  amount?: AmountNullable | null | undefined;
+  /**
+   * The description that will appear on the bank statement for this payout.
+   */
+  description?: string | undefined;
+  /**
+   * 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 type PayoutRequest$Outbound = {
+  balanceId: string;
+  amount?: AmountNullable$Outbound | null | undefined;
+  description?: string | undefined;
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const PayoutRequest$outboundSchema: z.ZodType<
+  PayoutRequest$Outbound,
+  z.ZodTypeDef,
+  PayoutRequest
+> = z.object({
+  balanceId: z.string(),
+  amount: z.nullable(AmountNullable$outboundSchema).optional(),
+  description: z.string().optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+});
+
+export function payoutRequestToJSON(payoutRequest: PayoutRequest): string {
+  return JSON.stringify(PayoutRequest$outboundSchema.parse(payoutRequest));
+}

package/src/models/payoutstatus.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c35fe9ae063d
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * The status of the payout.
+ */
+export const PayoutStatus = {
+  Requested: "requested",
+  Initiated: "initiated",
+  ProcessingAtBank: "processing-at-bank",
+  Completed: "completed",
+  Failed: "failed",
+  Canceled: "canceled",
+} as const;
+/**
+ * The status of the payout.
+ */
+export type PayoutStatus = OpenEnum<typeof PayoutStatus>;
+
+/** @internal */
+export const PayoutStatus$inboundSchema: z.ZodType<
+  PayoutStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PayoutStatus);

package/src/models/payoutstatusreason.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c4c4247c41f9
+ */
+
+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 {
+  PayoutStatusReasonCode,
+  PayoutStatusReasonCode$inboundSchema,
+} from "./payoutstatusreasoncode.js";
+
+/**
+ * The reason for the payout's current status.
+ */
+export type PayoutStatusReason = {
+  /**
+   * A machine-readable code describing the reason for the payout's current status.
+   */
+  code: PayoutStatusReasonCode;
+  /**
+   * A human-readable description of the status reason.
+   */
+  message: string;
+};
+
+/** @internal */
+export const PayoutStatusReason$inboundSchema: z.ZodType<
+  PayoutStatusReason,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: PayoutStatusReasonCode$inboundSchema,
+  message: z.string(),
+});
+
+export function payoutStatusReasonFromJSON(
+  jsonString: string,
+): SafeParseResult<PayoutStatusReason, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PayoutStatusReason$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PayoutStatusReason' from JSON`,
+  );
+}

package/src/models/payoutstatusreasoncode.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1ee305eaa864
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * A machine-readable code describing the reason for the payout's current status.
+ */
+export const PayoutStatusReasonCode = {
+  Requested: "requested",
+  Initiated: "initiated",
+  ProcessingAtBank: "processing_at_bank",
+  Completed: "completed",
+  Canceled: "canceled",
+  Failed: "failed",
+  InsufficientFunds: "insufficient_funds",
+  Returned: "returned",
+  InvalidRequest: "invalid_request",
+  OrganizationInactive: "organization_inactive",
+  PayoutsBlocked: "payouts_blocked",
+  BankProcessingFailed: "bank_processing_failed",
+  BalanceNotFound: "balance_not_found",
+  Expired: "expired",
+} as const;
+/**
+ * A machine-readable code describing the reason for the payout's current status.
+ */
+export type PayoutStatusReasonCode = OpenEnum<typeof PayoutStatusReasonCode>;
+
+/** @internal */
+export const PayoutStatusReasonCode$inboundSchema: z.ZodType<
+  PayoutStatusReasonCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PayoutStatusReasonCode);

package/src/models/webhookeventtypes.ts

@@ -15,6 +15,11 @@ import { ClosedEnum } from "../types/enums.js";
 export const WebhookEventTypes = {
   PaymentLinkPaid: "payment-link.paid",
   BalanceTransactionCreated: "balance-transaction.created",
+  PayoutInitiated: "payout.initiated",
+  PayoutProcessingAtBank: "payout.processing-at-bank",
+  PayoutCompleted: "payout.completed",
+  PayoutCanceled: "payout.canceled",
+  PayoutFailed: "payout.failed",
   SalesInvoiceCreated: "sales-invoice.created",
   SalesInvoiceIssued: "sales-invoice.issued",
   SalesInvoiceCanceled: "sales-invoice.canceled",

package/src/sdk/payouts.ts

@@ -0,0 +1,128 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9d174eba7124
+ */
+
+import { payoutsCancel } from "../funcs/payoutsCancel.js";
+import { payoutsCreate } from "../funcs/payoutsCreate.js";
+import { payoutsGet } from "../funcs/payoutsGet.js";
+import { payoutsList } from "../funcs/payoutsList.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Payouts extends ClientSDK {
+  /**
+   * Create payout
+   *
+   * @remarks
+   * Request a payout from one of your balances to the balance's configured bank account.
+   *
+   * The payout will be executed on the next scheduled business day. If no `amount` is specified, the full available
+   * balance minus any configured balance reserve is paid out.
+   *
+   * Once the payout is created with status `requested`, you can cancel it via the
+   * [Cancel payout](cancel-payout) endpoint, up until the payout moves to `initiated`.
+   *
+   * Creating a payout via the API automatically sets the balance's `transferFrequency` to `never`,
+   * pausing any previously configured automatic settlement schedule. To resume automatic settlements,
+   * update the transfer frequency via the dashboard.
+   *
+   * ### Webhooks
+   *
+   * Subscribe to the following webhook events to track payout status changes. See the
+   * [Webhook Subscriptions API](list-webhooks) for details on subscribing.
+   *
+   * | Event | Description |
+   * |---|---|
+   * | `payout.initiated` | The payout is being executed and funds are reserved. |
+   * | `payout.processing-at-bank` | The payout has been submitted to the bank. |
+   * | `payout.completed` | The payout has been sent to the destination bank account. |
+   * | `payout.canceled` | The payout was canceled via the API before being submitted to the bank. |
+   * | `payout.failed` | The payout failed after creation, including bank rejections and post-submission cancellations. |
+   *
+   * ### Payout failure reasons
+   *
+   * A payout request may fail immediately if one of the following conditions applies:
+   *
+   * - A payout is already scheduled for the next business day for this balance.
+   * - The balance has insufficient funds.
+   * - The balance is not active.
+   * - Payouts are blocked for this organization.
+   * - The balance has queued refunds.
+   * - One of the organization's balances is below the negative balance threshold.
+   * - The payout destination (bank account) is invalid or not configured.
+   */
+  async create(
+    request: operations.CreatePayoutRequest,
+    options?: RequestOptions,
+  ): Promise<models.EntityPayoutResponse> {
+    return unwrapAsync(payoutsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List payouts
+   *
+   * @remarks
+   * Retrieve a list of all payouts for your organization, including payouts initiated automatically by the
+   * balance's payout schedule and payouts requested via the API or dashboard.
+   *
+   * Only payouts created on or after April 1st, 2026 are returned.
+   *
+   * The results are paginated. Use the `from` query parameter together with `_links.next` to iterate through
+   * the full result set.
+   */
+  async list(
+    request?: operations.ListPayoutsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<PageIterator<operations.ListPayoutsResponse, { url: string }>> {
+    return unwrapResultIterator(payoutsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get payout
+   *
+   * @remarks
+   * Retrieve a single payout by its ID.
+   */
+  async get(
+    request: operations.GetPayoutRequest,
+    options?: RequestOptions,
+  ): Promise<models.EntityPayoutResponse> {
+    return unwrapAsync(payoutsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Cancel payout
+   *
+   * @remarks
+   * Cancel a payout. A payout can only be canceled while it has the status `requested`. Once the payout moves
+   * to `initiated`, it is too late to cancel.
+   *
+   * The canceled payout object is returned with the status set to `canceled`.
+   */
+  async cancel(
+    request: operations.CancelPayoutRequest,
+    options?: RequestOptions,
+  ): Promise<models.EntityPayoutResponse> {
+    return unwrapAsync(payoutsCancel(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -22,6 +22,7 @@ import { Onboarding } from "./onboarding.js";
 import { Organizations } from "./organizations.js";
 import { PaymentLinks } from "./paymentlinks.js";
 import { Payments } from "./payments.js";
+import { Payouts } from "./payouts.js";
 import { Permissions } from "./permissions.js";
 import { Profiles } from "./profiles.js";
 import { Refunds } from "./refunds.js";
@@ -199,4 +200,9 @@ export class Client extends ClientSDK {
   get verifyPayee(): VerifyPayee {
     return (this._verifyPayee ??= new VerifyPayee(this._options));
   }
+
+  private _payouts?: Payouts;
+  get payouts(): Payouts {
+    return (this._payouts ??= new Payouts(this._options));
+  }
 }