mollie-api-py 1.0.0__py3-none-any.whl

mollie/models/address.py

@@ -0,0 +1,29 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AddressTypedDict(TypedDict):
+    street_and_number: str
+    r"""A street and street number."""
+    postal_code: str
+    r"""A postal code. This field may be required if the provided country has a postal code system."""
+    city: str
+    country: str
+    r"""A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."""
+
+
+class Address(BaseModel):
+    street_and_number: Annotated[str, pydantic.Field(alias="streetAndNumber")]
+    r"""A street and street number."""
+
+    postal_code: Annotated[str, pydantic.Field(alias="postalCode")]
+    r"""A postal code. This field may be required if the provided country has a postal code system."""
+
+    city: str
+
+    country: str
+    r"""A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."""

mollie/models/amount.py

@@ -0,0 +1,25 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+from mollie.utils import FieldMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class AmountTypedDict(TypedDict):
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    currency: str
+    r"""A three-character ISO 4217 currency code."""
+    value: str
+    r"""A string containing an exact monetary amount in the given currency."""
+
+
+class Amount(BaseModel):
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    currency: Annotated[str, FieldMetadata(query=True)]
+    r"""A three-character ISO 4217 currency code."""
+
+    value: Annotated[str, FieldMetadata(query=True)]
+    r"""A string containing an exact monetary amount in the given currency."""

mollie/models/amount_nullable.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class AmountNullableTypedDict(TypedDict):
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    currency: str
+    r"""A three-character ISO 4217 currency code."""
+    value: str
+    r"""A string containing an exact monetary amount in the given currency."""
+
+
+class AmountNullable(BaseModel):
+    r"""In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field."""
+
+    currency: str
+    r"""A three-character ISO 4217 currency code."""
+
+    value: str
+    r"""A string containing an exact monetary amount in the given currency."""

mollie/models/apierror.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+from dataclasses import dataclass
+
+from mollie.models import ClientError
+
+MAX_MESSAGE_LEN = 10_000
+
+
+@dataclass(unsafe_hash=True)
+class APIError(ClientError):
+    """The fallback error class if no more specific error class is matched."""
+
+    def __init__(
+        self, message: str, raw_response: httpx.Response, body: Optional[str] = None
+    ):
+        body_display = body or raw_response.text or '""'
+
+        if message:
+            message += ": "
+        message += f"Status {raw_response.status_code}"
+
+        headers = raw_response.headers
+        content_type = headers.get("content-type", '""')
+        if content_type != "application/json":
+            if " " in content_type:
+                content_type = f'"{content_type}"'
+            message += f" Content-Type {content_type}"
+
+        if len(body_display) > MAX_MESSAGE_LEN:
+            truncated = body_display[:MAX_MESSAGE_LEN]
+            remaining = len(body_display) - MAX_MESSAGE_LEN
+            body_display = f"{truncated}...and {remaining} more chars"
+
+        message += f". Body: {body_display}"
+        message = message.strip()
+
+        super().__init__(message, raw_response, body)

mollie/models/balance_card_audience.py

@@ -0,0 +1,10 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceCardAudience(str, Enum, metaclass=utils.OpenEnumMeta):
+    CORPORATE = "corporate"
+    OTHER = "other"

mollie/models/balance_card_issuer.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceCardIssuer(str, Enum, metaclass=utils.OpenEnumMeta):
+    AMEX = "amex"
+    MAESTRO = "maestro"
+    CARTE_BANCAIRE = "carte-bancaire"
+    OTHER = "other"

mollie/models/balance_card_region.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceCardRegion(str, Enum, metaclass=utils.OpenEnumMeta):
+    INTRA_EEA = "intra-eea"
+    INTRA_EU = "intra-eu"
+    DOMESTIC = "domestic"
+    OTHER = "other"

mollie/models/balance_fee_type.py

@@ -0,0 +1,43 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceFeeType(str, Enum, metaclass=utils.OpenEnumMeta):
+    PAYMENT_FEE = "payment-fee"
+    DIRECT_DEBIT_FAILURE_FEE = "direct-debit-failure-fee"
+    UNAUTHORIZED_DIRECT_DEBIT_FEE = "unauthorized-direct-debit-fee"
+    BANK_CHARGED_DIRECT_DEBIT_FAILURE_FEE = "bank-charged-direct-debit-failure-fee"
+    PARTNER_COMMISSION = "partner-commission"
+    APPLICATION_FEE = "application-fee"
+    CAPTURE_FEE = "capture-fee"
+    REFUND_FEE = "refund-fee"
+    CHARGEBACK_FEE = "chargeback-fee"
+    PAYMENT_NOTIFICATION_FEE = "payment-notification-fee"
+    TRANSFER_NOTIFICATION_FEE = "transfer-notification-fee"
+    PAYOUT_FEE = "payout-fee"
+    FEE_DISCOUNT = "fee-discount"
+    FEE_REIMBURSEMENT = "fee-reimbursement"
+    PLATFORM_VOLUME_FEE = "platform-volume-fee"
+    PLATFORM_CONNECTED_ORGANIZATIONS_FEE = "platform-connected-organizations-fee"
+    BALANCE_CHARGE_FEE = "balance-charge-fee"
+    THREEDS_AUTHENTICATION_ATTEMPT_FEE = "3ds-authentication-attempt-fee"
+    TERMINAL_MONTHLY_FEE = "terminal-monthly-fee"
+    ACCEPTANCE_RISK_FEE = "acceptance-risk-fee"
+    TOP_UP_FEE = "top-up-fee"
+    PAYMENT_GATEWAY_FEE = "payment-gateway-fee"
+    MASTERCARD_SPECIALTY_MERCHANT_PROGRAM_PROCESSING_FEE = (
+        "mastercard-specialty-merchant-program-processing-fee"
+    )
+    MASTERCARD_SPECIALTY_MERCHANT_PROGRAM_REGISTRATION_FEE = (
+        "mastercard-specialty-merchant-program-registration-fee"
+    )
+    VISA_INTEGRITY_RISK_PROGRAM_PROCESSING_FEE = (
+        "visa-integrity-risk-program-processing-fee"
+    )
+    VISA_INTEGRITY_RISK_PROGRAM_REGISTRATION_FEE = (
+        "visa-integrity-risk-program-registration-fee"
+    )
+    MINIMUM_INVOICE_AMOUNT_FEE = "minimum-invoice-amount-fee"

mollie/models/balance_prepayment_part_type.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalancePrepaymentPartType(str, Enum, metaclass=utils.OpenEnumMeta):
+    FEE = "fee"
+    FEE_REIMBURSEMENT = "fee-reimbursement"
+    FEE_DISCOUNT = "fee-discount"
+    FEE_VAT = "fee-vat"
+    FEE_ROUNDING_COMPENSATION = "fee-rounding-compensation"

mollie/models/balance_report_grouping.py

@@ -0,0 +1,10 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceReportGrouping(str, Enum, metaclass=utils.OpenEnumMeta):
+    STATUS_BALANCES = "status-balances"
+    TRANSACTION_CATEGORIES = "transaction-categories"

mollie/models/balance_transaction_type.py

@@ -0,0 +1,47 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceTransactionType(str, Enum, metaclass=utils.OpenEnumMeta):
+    PAYMENT = "payment"
+    SPLIT_PAYMENT = "split-payment"
+    FAILED_PAYMENT = "failed-payment"
+    FAILED_PLATFORM_SPLIT_PAYMENT = "failed-platform-split-payment"
+    FAILED_SPLIT_PAYMENT_COMPENSATION = "failed-split-payment-compensation"
+    CAPTURE = "capture"
+    SPLIT_TRANSACTION = "split-transaction"
+    REFUND = "refund"
+    PLATFORM_PAYMENT_REFUND = "platform-payment-refund"
+    RETURNED_PLATFORM_PAYMENT_REFUND = "returned-platform-payment-refund"
+    REFUND_COMPENSATION = "refund-compensation"
+    RETURNED_REFUND_COMPENSATION = "returned-refund-compensation"
+    RETURNED_REFUND = "returned-refund"
+    CHARGEBACK = "chargeback"
+    CHARGEBACK_REVERSAL = "chargeback-reversal"
+    CHARGEBACK_COMPENSATION = "chargeback-compensation"
+    REVERSED_CHARGEBACK_COMPENSATION = "reversed-chargeback-compensation"
+    PLATFORM_PAYMENT_CHARGEBACK = "platform-payment-chargeback"
+    REVERSED_PLATFORM_PAYMENT_CHARGEBACK = "reversed-platform-payment-chargeback"
+    FEE_PREPAYMENT = "fee-prepayment"
+    OUTGOING_TRANSFER = "outgoing-transfer"
+    INCOMING_TRANSFER = "incoming-transfer"
+    CANCELED_TRANSFER = "canceled-transfer"
+    RETURNED_TRANSFER = "returned-transfer"
+    BALANCE_RESERVE = "balance-reserve"
+    BALANCE_RESERVE_RETURN = "balance-reserve-return"
+    INVOICE_ROUNDING_COMPENSATION = "invoice-rounding-compensation"
+    ROLLING_RESERVE_HOLD = "rolling-reserve-hold"
+    ROLLING_RESERVE_RELEASE = "rolling-reserve-release"
+    BALANCE_CORRECTION = "balance-correction"
+    REPAYMENT = "repayment"
+    LOAN = "loan"
+    BALANCE_TOPUP = "balance-topup"
+    CASH_COLLATERAL_ISSUANCE_ = "cash-collateral-issuance';"
+    CASH_COLLATERAL_RELEASE = "cash-collateral-release"
+    PENDING_ROLLING_RESERVE = "pending-rolling-reserve"
+    TO_BE_RELEASED_ROLLING_RESERVE = "to-be-released-rolling-reserve"
+    HELD_ROLLING_RESERVE = "held-rolling-reserve"
+    RELEASED_ROLLING_RESERVE = "released-rolling-reserve"

mollie/models/balance_transfer_category.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class BalanceTransferCategory(str, Enum):
+    r"""The type of the transfer. Different fees may apply to different types of transfers."""
+
+    INVOICE_COLLECTION = "invoice_collection"
+    PURCHASE = "purchase"
+    CHARGEBACK = "chargeback"
+    REFUND = "refund"
+    SERVICE_PENALTY = "service_penalty"
+    DISCOUNT_COMPENSATION = "discount_compensation"
+    MANUAL_CORRECTION = "manual_correction"
+    OTHER_FEE = "other_fee"

mollie/models/balance_transfer_category_response.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceTransferCategoryResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The type of the transfer. Different fees may apply to different types of transfers."""
+
+    INVOICE_COLLECTION = "invoice_collection"
+    PURCHASE = "purchase"
+    CHARGEBACK = "chargeback"
+    REFUND = "refund"
+    SERVICE_PENALTY = "service_penalty"
+    DISCOUNT_COMPENSATION = "discount_compensation"
+    MANUAL_CORRECTION = "manual_correction"
+    OTHER_FEE = "other_fee"

mollie/models/balance_transfer_destination_type.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceTransferDestinationType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The default destination of automatic scheduled transfers. Currently only `bank-account` is supported.
+
+    * `bank-account` — Transfer the balance amount to an external bank account
+    """
+
+    BANK_ACCOUNT = "bank-account"

mollie/models/balance_transfer_party_type.py

@@ -0,0 +1,10 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class BalanceTransferPartyType(str, Enum):
+    r"""Defines the type of the party. At the moment, only `organization` is supported."""
+
+    ORGANIZATION = "organization"

mollie/models/balance_transfer_party_type_response.py

@@ -0,0 +1,11 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceTransferPartyTypeResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Defines the type of the party. At the moment, only `organization` is supported."""
+
+    ORGANIZATION = "organization"

mollie/models/balance_transfer_status.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceTransferStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The status of the transfer."""
+
+    CREATED = "created"
+    FAILED = "failed"
+    SUCCEEDED = "succeeded"

mollie/models/balance_transfer_status_reason_response.py

@@ -0,0 +1,19 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class BalanceTransferStatusReasonResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""A machine-readable code that indicates the reason for the transfer's status."""
+
+    REQUEST_CREATED = "request_created"
+    SUCCESS = "success"
+    SOURCE_NOT_ALLOWED = "source_not_allowed"
+    DESTINATION_NOT_ALLOWED = "destination_not_allowed"
+    INSUFFICIENT_FUNDS = "insufficient_funds"
+    INVALID_SOURCE_BALANCE = "invalid_source_balance"
+    INVALID_DESTINATION_BALANCE = "invalid_destination_balance"
+    TRANSFER_REQUEST_EXPIRED = "transfer_request_expired"
+    TRANSFER_LIMIT_REACHED = "transfer_limit_reached"

mollie/models/billingaddress.py

@@ -0,0 +1,154 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+import pydantic
+from typing import Any, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class BillingAddressTypedDict(TypedDict):
+    r"""The customer's billing address details. We advise to provide these details to improve fraud protection and
+    conversion.
+
+    Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and
+    `country`.
+
+    Required for payment method `in3`, `klarna`, `billie` and `riverty`.
+    """
+
+    title: NotRequired[str]
+    r"""The title of the person, for example *Mr.* or *Mrs.*."""
+    given_name: NotRequired[str]
+    r"""The given name (first name) of the person should be at least two characters and cannot contain only
+    numbers.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+    family_name: NotRequired[str]
+    r"""The given family name (surname) of the person should be at least two characters and cannot contain only
+    numbers.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+    organization_name: NotRequired[Any]
+    r"""The name of the organization, in case the addressee is an organization.
+
+    Required for payment method `billie`.
+    """
+    street_and_number: NotRequired[str]
+    r"""A street and street number.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+    street_additional: NotRequired[str]
+    r"""Any additional addressing details, for example an apartment number."""
+    postal_code: NotRequired[str]
+    r"""A postal code. This field may be required if the provided country has a postal code system.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+    email: NotRequired[str]
+    r"""A valid e-mail address.
+
+    If you provide the email address for a `banktransfer` payment, we will automatically send the instructions
+    email upon payment creation. The language of the email will follow the locale parameter of the payment.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+    phone: NotRequired[str]
+    r"""If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070."""
+    city: NotRequired[str]
+    r"""A city name.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+    region: NotRequired[str]
+    r"""The top-level administrative subdivision of the country. For example: Noord-Holland."""
+    country: NotRequired[str]
+    r"""A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+
+
+class BillingAddress(BaseModel):
+    r"""The customer's billing address details. We advise to provide these details to improve fraud protection and
+    conversion.
+
+    Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and
+    `country`.
+
+    Required for payment method `in3`, `klarna`, `billie` and `riverty`.
+    """
+
+    title: Optional[str] = None
+    r"""The title of the person, for example *Mr.* or *Mrs.*."""
+
+    given_name: Annotated[Optional[str], pydantic.Field(alias="givenName")] = None
+    r"""The given name (first name) of the person should be at least two characters and cannot contain only
+    numbers.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+
+    family_name: Annotated[Optional[str], pydantic.Field(alias="familyName")] = None
+    r"""The given family name (surname) of the person should be at least two characters and cannot contain only
+    numbers.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+
+    organization_name: Annotated[
+        Optional[Any], pydantic.Field(alias="organizationName")
+    ] = None
+    r"""The name of the organization, in case the addressee is an organization.
+
+    Required for payment method `billie`.
+    """
+
+    street_and_number: Annotated[
+        Optional[str], pydantic.Field(alias="streetAndNumber")
+    ] = None
+    r"""A street and street number.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+
+    street_additional: Annotated[
+        Optional[str], pydantic.Field(alias="streetAdditional")
+    ] = None
+    r"""Any additional addressing details, for example an apartment number."""
+
+    postal_code: Annotated[Optional[str], pydantic.Field(alias="postalCode")] = None
+    r"""A postal code. This field may be required if the provided country has a postal code system.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+
+    email: Optional[str] = None
+    r"""A valid e-mail address.
+
+    If you provide the email address for a `banktransfer` payment, we will automatically send the instructions
+    email upon payment creation. The language of the email will follow the locale parameter of the payment.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+
+    phone: Optional[str] = None
+    r"""If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070."""
+
+    city: Optional[str] = None
+    r"""A city name.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """
+
+    region: Optional[str] = None
+    r"""The top-level administrative subdivision of the country. For example: Noord-Holland."""
+
+    country: Optional[str] = None
+    r"""A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+
+    Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
+    """

mollie/models/cancel_paymentop.py

@@ -0,0 +1,93 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CancelPaymentRequestBodyTypedDict(TypedDict):
+    testmode: NotRequired[Nullable[bool]]
+    r"""Whether to create the entity in test mode or live mode.
+
+    Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
+    omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+    `testmode` to `true`.
+    """
+
+
+class CancelPaymentRequestBody(BaseModel):
+    testmode: OptionalNullable[bool] = UNSET
+    r"""Whether to create the entity in test mode or live mode.
+
+    Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
+    omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+    `testmode` to `true`.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["testmode"]
+        nullable_fields = ["testmode"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m
+
+
+class CancelPaymentRequestTypedDict(TypedDict):
+    payment_id: str
+    r"""Provide the ID of the related payment."""
+    idempotency_key: NotRequired[str]
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+    request_body: NotRequired[CancelPaymentRequestBodyTypedDict]
+
+
+class CancelPaymentRequest(BaseModel):
+    payment_id: Annotated[
+        str,
+        pydantic.Field(alias="paymentId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Provide the ID of the related payment."""
+
+    idempotency_key: Annotated[
+        Optional[str],
+        pydantic.Field(alias="idempotency-key"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""A unique key to ensure idempotent requests. This key should be a UUID v4 string."""
+
+    request_body: Annotated[
+        Optional[CancelPaymentRequestBody],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None