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

mollie/models/mandate_response.py

@@ -0,0 +1,264 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .mandate_details_card_label_response import MandateDetailsCardLabelResponse
+from .mandate_method_response import MandateMethodResponse
+from .mode import Mode
+from .url import URL, URLTypedDict
+from enum import Enum
+from mollie import utils
+from mollie.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mollie.utils import validate_open_enum
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import PlainValidator
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class MandateResponseDetailsTypedDict(TypedDict):
+    consumer_name: NotRequired[Nullable[str]]
+    r"""The customer's name. Available for SEPA Direct Debit and PayPal mandates."""
+    consumer_account: NotRequired[Nullable[str]]
+    r"""The customer's IBAN or email address. Available for SEPA Direct Debit and PayPal mandates."""
+    consumer_bic: NotRequired[Nullable[str]]
+    r"""The BIC of the customer's bank. Available for SEPA Direct Debit mandates."""
+    card_holder: NotRequired[Nullable[str]]
+    r"""The card holder's name. Available for card mandates."""
+    card_number: NotRequired[Nullable[str]]
+    r"""The last four digits of the card number. Available for card mandates."""
+    card_expiry_date: NotRequired[Nullable[str]]
+    r"""The card's expiry date in `YYYY-MM-DD` format. Available for card mandates."""
+    card_label: NotRequired[Nullable[MandateDetailsCardLabelResponse]]
+    r"""The card's label. Available for card mandates, if the card label could be detected."""
+    card_fingerprint: NotRequired[Nullable[str]]
+    r"""Unique alphanumeric representation of this specific card. Available for card mandates. Can be used to identify
+    returning customers.
+    """
+
+
+class MandateResponseDetails(BaseModel):
+    consumer_name: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerName")
+    ] = UNSET
+    r"""The customer's name. Available for SEPA Direct Debit and PayPal mandates."""
+
+    consumer_account: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerAccount")
+    ] = UNSET
+    r"""The customer's IBAN or email address. Available for SEPA Direct Debit and PayPal mandates."""
+
+    consumer_bic: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="consumerBic")
+    ] = UNSET
+    r"""The BIC of the customer's bank. Available for SEPA Direct Debit mandates."""
+
+    card_holder: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardHolder")
+    ] = UNSET
+    r"""The card holder's name. Available for card mandates."""
+
+    card_number: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardNumber")
+    ] = UNSET
+    r"""The last four digits of the card number. Available for card mandates."""
+
+    card_expiry_date: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardExpiryDate")
+    ] = UNSET
+    r"""The card's expiry date in `YYYY-MM-DD` format. Available for card mandates."""
+
+    card_label: Annotated[
+        Annotated[
+            OptionalNullable[MandateDetailsCardLabelResponse],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="cardLabel"),
+    ] = UNSET
+    r"""The card's label. Available for card mandates, if the card label could be detected."""
+
+    card_fingerprint: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="cardFingerprint")
+    ] = UNSET
+    r"""Unique alphanumeric representation of this specific card. Available for card mandates. Can be used to identify
+    returning customers.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "consumerName",
+            "consumerAccount",
+            "consumerBic",
+            "cardHolder",
+            "cardNumber",
+            "cardExpiryDate",
+            "cardLabel",
+            "cardFingerprint",
+        ]
+        nullable_fields = [
+            "consumerName",
+            "consumerAccount",
+            "consumerBic",
+            "cardHolder",
+            "cardNumber",
+            "cardExpiryDate",
+            "cardLabel",
+            "cardFingerprint",
+        ]
+        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 MandateResponseStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
+    when we did not received the IBAN yet from the first payment.
+    """
+
+    VALID = "valid"
+    PENDING = "pending"
+    INVALID = "invalid"
+
+
+class MandateResponseLinksTypedDict(TypedDict):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    customer: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+    documentation: URLTypedDict
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class MandateResponseLinks(BaseModel):
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    self_: Annotated[URL, pydantic.Field(alias="self")]
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    customer: URL
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+    documentation: URL
+    r"""In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field."""
+
+
+class MandateResponseTypedDict(TypedDict):
+    resource: str
+    r"""Indicates the response contains a mandate object. Will always contain the string `mandate` for this endpoint."""
+    id: str
+    r"""The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`."""
+    mode: Mode
+    r"""Whether this entity was created in live mode or in test mode."""
+    method: MandateMethodResponse
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+    details: MandateResponseDetailsTypedDict
+    signature_date: Nullable[str]
+    r"""The date when the mandate was signed in `YYYY-MM-DD` format."""
+    mandate_reference: Nullable[str]
+    r"""A custom mandate reference. For SEPA Direct Debit, it is vital to provide a unique reference. Some banks will
+    decline Direct Debit payments if the mandate reference is not unique.
+    """
+    status: MandateResponseStatus
+    customer_id: str
+    r"""The identifier referring to the [customer](get-customer) this mandate was linked to."""
+    created_at: str
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+    links: MandateResponseLinksTypedDict
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+
+class MandateResponse(BaseModel):
+    resource: str
+    r"""Indicates the response contains a mandate object. Will always contain the string `mandate` for this endpoint."""
+
+    id: str
+    r"""The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`."""
+
+    mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    method: Annotated[MandateMethodResponse, PlainValidator(validate_open_enum(False))]
+    r"""Payment method of the mandate.
+
+    SEPA Direct Debit and PayPal mandates can be created directly.
+    """
+
+    details: MandateResponseDetails
+
+    signature_date: Annotated[Nullable[str], pydantic.Field(alias="signatureDate")]
+    r"""The date when the mandate was signed in `YYYY-MM-DD` format."""
+
+    mandate_reference: Annotated[
+        Nullable[str], pydantic.Field(alias="mandateReference")
+    ]
+    r"""A custom mandate reference. For SEPA Direct Debit, it is vital to provide a unique reference. Some banks will
+    decline Direct Debit payments if the mandate reference is not unique.
+    """
+
+    status: Annotated[MandateResponseStatus, PlainValidator(validate_open_enum(False))]
+
+    customer_id: Annotated[str, pydantic.Field(alias="customerId")]
+    r"""The identifier referring to the [customer](get-customer) this mandate was linked to."""
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+    r"""The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."""
+
+    links: Annotated[MandateResponseLinks, pydantic.Field(alias="_links")]
+    r"""An object with several relevant URLs. Every URL object will contain an `href` and a `type` field."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["signatureDate", "mandateReference"]
+        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

mollie/models/metadata.py

@@ -0,0 +1,19 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Any, Dict, List, Union
+from typing_extensions import TypeAliasType
+
+
+MetadataTypedDict = TypeAliasType(
+    "MetadataTypedDict", Union[str, Dict[str, Any], List[str]]
+)
+r"""Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+"""
+
+
+Metadata = TypeAliasType("Metadata", Union[str, Dict[str, Any], List[str]])
+r"""Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+"""

mollie/models/method.py

@@ -0,0 +1,50 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class Method(str, Enum):
+    r"""Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
+    method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
+    parameter enables you to fully integrate the payment method selection into your website.
+
+    You can also specify the methods in an array. By doing so we will still show the payment method selection screen
+    but will only show the methods specified in the array. For example, you can use this functionality to only show
+    payment methods from a specific country to your customer `['bancontact', 'belfius']`.
+    """
+
+    ALMA = "alma"
+    APPLEPAY = "applepay"
+    BACS = "bacs"
+    BANCOMATPAY = "bancomatpay"
+    BANCONTACT = "bancontact"
+    BANKTRANSFER = "banktransfer"
+    BELFIUS = "belfius"
+    BILLIE = "billie"
+    BIZUM = "bizum"
+    BLIK = "blik"
+    CREDITCARD = "creditcard"
+    DIRECTDEBIT = "directdebit"
+    EPS = "eps"
+    GIFTCARD = "giftcard"
+    IDEAL = "ideal"
+    IN3 = "in3"
+    KBC = "kbc"
+    KLARNA = "klarna"
+    MBWAY = "mbway"
+    MOBILEPAY = "mobilepay"
+    MULTIBANCO = "multibanco"
+    MYBANK = "mybank"
+    PAYBYBANK = "paybybank"
+    PAYPAL = "paypal"
+    PAYSAFECARD = "paysafecard"
+    POINTOFSALE = "pointofsale"
+    PRZELEWY24 = "przelewy24"
+    RIVERTY = "riverty"
+    SATISPAY = "satispay"
+    SWISH = "swish"
+    TRUSTLY = "trustly"
+    TWINT = "twint"
+    VIPPS = "vipps"
+    VOUCHER = "voucher"

mollie/models/method_include_wallets_parameter.py

@@ -0,0 +1,8 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class MethodIncludeWalletsParameter(str, Enum):
+    APPLEPAY = "applepay"

mollie/models/method_resource_parameter.py

@@ -0,0 +1,9 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class MethodResourceParameter(str, Enum):
+    PAYMENTS = "payments"
+    ORDERS = "orders"

mollie/models/method_response.py

@@ -0,0 +1,59 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class MethodResponse(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
+    method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
+    parameter enables you to fully integrate the payment method selection into your website.
+
+    You can also specify the methods in an array. By doing so we will still show the payment method selection screen
+    but will only show the methods specified in the array. For example, you can use this functionality to only show
+    payment methods from a specific country to your customer `['bancontact', 'belfius']`.
+    """
+
+    ALMA = "alma"
+    APPLEPAY = "applepay"
+    BACS = "bacs"
+    BANCOMATPAY = "bancomatpay"
+    BANCONTACT = "bancontact"
+    BANKTRANSFER = "banktransfer"
+    BELFIUS = "belfius"
+    BILLIE = "billie"
+    BIZUM = "bizum"
+    BLIK = "blik"
+    CREDITCARD = "creditcard"
+    DIRECTDEBIT = "directdebit"
+    EPS = "eps"
+    GIFTCARD = "giftcard"
+    IDEAL = "ideal"
+    IN3 = "in3"
+    KBC = "kbc"
+    KLARNA = "klarna"
+    MBWAY = "mbway"
+    MOBILEPAY = "mobilepay"
+    MULTIBANCO = "multibanco"
+    MYBANK = "mybank"
+    PAYBYBANK = "paybybank"
+    PAYPAL = "paypal"
+    PAYSAFECARD = "paysafecard"
+    POINTOFSALE = "pointofsale"
+    PRZELEWY24 = "przelewy24"
+    RIVERTY = "riverty"
+    SATISPAY = "satispay"
+    SWISH = "swish"
+    TRUSTLY = "trustly"
+    TWINT = "twint"
+    VIPPS = "vipps"
+    VOUCHER = "voucher"
+    # Deprecated, use 'klarna' instead
+    KLARNAPAYLATER = "klarnapaylater"
+    # Deprecated, use 'klarna' instead
+    KLARNAPAYNOW = "klarnapaynow"
+    # Deprecated, use 'klarna' instead
+    KLARNASLICEIT = "klarnasliceit"
+    # No longer available
+    PAYCONIQ = "payconiq"

mollie/models/method_status.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class MethodStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The payment method's activation status for this profile."""
+
+    ACTIVATED = "activated"
+    PENDING_BOARDING = "pending-boarding"
+    PENDING_REVIEW = "pending-review"
+    PENDING_EXTERNAL = "pending-external"
+    REJECTED = "rejected"

mollie/models/mode.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 Mode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Whether this entity was created in live mode or in test mode."""
+
+    LIVE = "live"
+    TEST = "test"

mollie/models/no_response_error.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from dataclasses import dataclass
+
+
+@dataclass(unsafe_hash=True)
+class NoResponseError(Exception):
+    """Error raised when no HTTP response is received from the server."""
+
+    message: str
+
+    def __init__(self, message: str = "No response received"):
+        object.__setattr__(self, "message", message)
+        super().__init__(message)
+
+    def __str__(self):
+        return self.message

mollie/models/onboarding_vat_regulation.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class OnboardingVatRegulation(str, Enum):
+    r"""Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in
+    The United Kingdom, and shifted VAT for merchants in the European Union.
+
+    The field can be omitted for merchants residing in other countries.
+    """
+
+    DUTCH = "dutch"
+    BRITISH = "british"
+    SHIFTED = "shifted"

mollie/models/organization_vat_regulation.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mollie import utils
+
+
+class OrganizationVatRegulation(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United
+    Kingdom, and shifted VAT for merchants in the European Union.
+
+    The field is not present for merchants residing in other countries.
+    """
+
+    DUTCH = "dutch"
+    BRITISH = "british"
+    SHIFTED = "shifted"

mollie/models/payment_address.py

@@ -0,0 +1,130 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mollie.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PaymentAddressTypedDict(TypedDict):
+    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[str]
+    r"""The name of the organization, in case the addressee is an organization."""
+    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 PaymentAddress(BaseModel):
+    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[str], pydantic.Field(alias="organizationName")
+    ] = None
+    r"""The name of the organization, in case the addressee is an organization."""
+
+    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/payment_create_routeop.py

@@ -0,0 +1,43 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .entity_route import EntityRoute, EntityRouteTypedDict
+from mollie.types import BaseModel
+from mollie.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PaymentCreateRouteRequestTypedDict(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."""
+    entity_route: NotRequired[EntityRouteTypedDict]
+
+
+class PaymentCreateRouteRequest(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."""
+
+    entity_route: Annotated[
+        Optional[EntityRoute],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None