mollie-api-py 1.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mollie/__init__.py +18 -0
- mollie/_hooks/__init__.py +5 -0
- mollie/_hooks/mollie_hooks.py +165 -0
- mollie/_hooks/registration.py +18 -0
- mollie/_hooks/sdkhooks.py +76 -0
- mollie/_hooks/types.py +113 -0
- mollie/_version.py +15 -0
- mollie/balance_transfers.py +651 -0
- mollie/balances.py +1105 -0
- mollie/basesdk.py +360 -0
- mollie/capabilities.py +209 -0
- mollie/captures.py +677 -0
- mollie/chargebacks_sdk.py +675 -0
- mollie/client_links.py +325 -0
- mollie/clients.py +409 -0
- mollie/customers.py +1563 -0
- mollie/delayed_routing.py +421 -0
- mollie/httpclient.py +125 -0
- mollie/invoices.py +429 -0
- mollie/mandates.py +895 -0
- mollie/methods.py +789 -0
- mollie/models/__init__.py +4002 -0
- mollie/models/address.py +29 -0
- mollie/models/amount.py +25 -0
- mollie/models/amount_nullable.py +24 -0
- mollie/models/apierror.py +40 -0
- mollie/models/balance_card_audience.py +10 -0
- mollie/models/balance_card_issuer.py +12 -0
- mollie/models/balance_card_region.py +12 -0
- mollie/models/balance_fee_type.py +43 -0
- mollie/models/balance_prepayment_part_type.py +13 -0
- mollie/models/balance_report_grouping.py +10 -0
- mollie/models/balance_transaction_type.py +47 -0
- mollie/models/balance_transfer_category.py +17 -0
- mollie/models/balance_transfer_category_response.py +18 -0
- mollie/models/balance_transfer_destination_type.py +14 -0
- mollie/models/balance_transfer_party_type.py +10 -0
- mollie/models/balance_transfer_party_type_response.py +11 -0
- mollie/models/balance_transfer_status.py +13 -0
- mollie/models/balance_transfer_status_reason_response.py +19 -0
- mollie/models/billingaddress.py +154 -0
- mollie/models/cancel_paymentop.py +93 -0
- mollie/models/cancel_refundop.py +86 -0
- mollie/models/cancel_subscriptionop.py +100 -0
- mollie/models/capability_requirement_status.py +15 -0
- mollie/models/capability_status.py +12 -0
- mollie/models/capability_status_reason.py +10 -0
- mollie/models/capture_mode.py +15 -0
- mollie/models/capture_mode_response.py +16 -0
- mollie/models/capture_response.py +265 -0
- mollie/models/client_link_request.py +210 -0
- mollie/models/client_link_response.py +56 -0
- mollie/models/clienterror.py +30 -0
- mollie/models/components_sub_totals.py +127 -0
- mollie/models/create_captureop.py +43 -0
- mollie/models/create_client_linkop.py +29 -0
- mollie/models/create_connect_balance_transferop.py +32 -0
- mollie/models/create_customer_paymentop.py +43 -0
- mollie/models/create_customerop.py +29 -0
- mollie/models/create_mandateop.py +43 -0
- mollie/models/create_payment_linkop.py +325 -0
- mollie/models/create_paymentop.py +73 -0
- mollie/models/create_profileop.py +29 -0
- mollie/models/create_refundop.py +43 -0
- mollie/models/create_sales_invoiceop.py +29 -0
- mollie/models/create_subscriptionop.py +43 -0
- mollie/models/create_webhook.py +123 -0
- mollie/models/create_webhookop.py +69 -0
- mollie/models/currencies.py +20 -0
- mollie/models/customer_response.py +169 -0
- mollie/models/delete_customerop.py +91 -0
- mollie/models/delete_payment_linkop.py +91 -0
- mollie/models/delete_profileop.py +29 -0
- mollie/models/delete_sales_invoiceop.py +44 -0
- mollie/models/delete_values_sales_invoice.py +54 -0
- mollie/models/delete_webhookop.py +56 -0
- mollie/models/entity_balance.py +325 -0
- mollie/models/entity_balance_report.py +541 -0
- mollie/models/entity_balance_transaction.py +1068 -0
- mollie/models/entity_balance_transfer.py +62 -0
- mollie/models/entity_balance_transfer_party.py +28 -0
- mollie/models/entity_balance_transfer_party_response.py +32 -0
- mollie/models/entity_balance_transfer_response.py +159 -0
- mollie/models/entity_capability.py +75 -0
- mollie/models/entity_capability_requirement.py +87 -0
- mollie/models/entity_capture.py +63 -0
- mollie/models/entity_chargeback.py +247 -0
- mollie/models/entity_customer.py +86 -0
- mollie/models/entity_event.py +46 -0
- mollie/models/entity_invoice.py +247 -0
- mollie/models/entity_method_get.py +329 -0
- mollie/models/entity_onboarding_status.py +95 -0
- mollie/models/entity_organization.py +178 -0
- mollie/models/entity_payment_route.py +111 -0
- mollie/models/entity_payment_route_response.py +140 -0
- mollie/models/entity_permission.py +61 -0
- mollie/models/entity_refund_response.py +361 -0
- mollie/models/entity_route.py +96 -0
- mollie/models/entity_settlement.py +467 -0
- mollie/models/entity_terminal.py +160 -0
- mollie/models/entity_webhook.py +122 -0
- mollie/models/entity_webhook_event.py +149 -0
- mollie/models/error_response.py +70 -0
- mollie/models/get_balance_reportop.py +126 -0
- mollie/models/get_balanceop.py +71 -0
- mollie/models/get_captureop.py +129 -0
- mollie/models/get_chargebackop.py +129 -0
- mollie/models/get_clientop.py +216 -0
- mollie/models/get_connect_balance_transferop.py +71 -0
- mollie/models/get_current_organizationop.py +22 -0
- mollie/models/get_current_profileop.py +22 -0
- mollie/models/get_customerop.py +286 -0
- mollie/models/get_invoiceop.py +29 -0
- mollie/models/get_mandateop.py +86 -0
- mollie/models/get_methodop.py +199 -0
- mollie/models/get_next_settlementop.py +22 -0
- mollie/models/get_onboarding_statusop.py +22 -0
- mollie/models/get_open_settlementop.py +22 -0
- mollie/models/get_organizationop.py +71 -0
- mollie/models/get_partner_statusop.py +231 -0
- mollie/models/get_payment_link_paymentsop.py +188 -0
- mollie/models/get_payment_linkop.py +77 -0
- mollie/models/get_paymentop.py +128 -0
- mollie/models/get_permissionop.py +73 -0
- mollie/models/get_primary_balanceop.py +22 -0
- mollie/models/get_profileop.py +71 -0
- mollie/models/get_refundop.py +129 -0
- mollie/models/get_sales_invoiceop.py +75 -0
- mollie/models/get_settlementop.py +29 -0
- mollie/models/get_subscriptionop.py +86 -0
- mollie/models/get_terminalop.py +77 -0
- mollie/models/get_webhook_eventop.py +71 -0
- mollie/models/get_webhookop.py +71 -0
- mollie/models/internal/__init__.py +54 -0
- mollie/models/internal/globals.py +59 -0
- mollie/models/line_categories.py +13 -0
- mollie/models/line_categories_response.py +14 -0
- mollie/models/list_all_chargebacksop.py +236 -0
- mollie/models/list_all_methodsop.py +249 -0
- mollie/models/list_all_refundsop.py +230 -0
- mollie/models/list_all_subscriptionsop.py +202 -0
- mollie/models/list_balance_transactionsop.py +174 -0
- mollie/models/list_balancesop.py +171 -0
- mollie/models/list_capabilitiesop.py +62 -0
- mollie/models/list_capture_response.py +264 -0
- mollie/models/list_capturesop.py +185 -0
- mollie/models/list_chargebacksop.py +185 -0
- mollie/models/list_clientsop.py +269 -0
- mollie/models/list_connect_balance_transfersop.py +177 -0
- mollie/models/list_customer_paymentsop.py +231 -0
- mollie/models/list_customer_response.py +164 -0
- mollie/models/list_customersop.py +172 -0
- mollie/models/list_entity_balance.py +322 -0
- mollie/models/list_entity_chargeback.py +244 -0
- mollie/models/list_entity_invoice.py +244 -0
- mollie/models/list_entity_method.py +315 -0
- mollie/models/list_entity_method_all.py +391 -0
- mollie/models/list_entity_permission.py +56 -0
- mollie/models/list_entity_refund.py +352 -0
- mollie/models/list_entity_settlement.py +457 -0
- mollie/models/list_entity_terminal.py +157 -0
- mollie/models/list_entity_webhook.py +117 -0
- mollie/models/list_invoicesop.py +175 -0
- mollie/models/list_links.py +68 -0
- mollie/models/list_mandate_response.py +261 -0
- mollie/models/list_mandatesop.py +186 -0
- mollie/models/list_methodsop.py +332 -0
- mollie/models/list_payment_linksop.py +159 -0
- mollie/models/list_payment_response.py +1953 -0
- mollie/models/list_paymentsop.py +217 -0
- mollie/models/list_permissionsop.py +85 -0
- mollie/models/list_profile_response.py +194 -0
- mollie/models/list_profilesop.py +118 -0
- mollie/models/list_refundsop.py +189 -0
- mollie/models/list_route_get_response.py +97 -0
- mollie/models/list_sales_invoice_response.py +505 -0
- mollie/models/list_sales_invoicesop.py +172 -0
- mollie/models/list_settlement_capturesop.py +187 -0
- mollie/models/list_settlement_chargebacksop.py +187 -0
- mollie/models/list_settlement_paymentsop.py +233 -0
- mollie/models/list_settlement_refundsop.py +191 -0
- mollie/models/list_settlementsop.py +178 -0
- mollie/models/list_subscription_paymentsop.py +242 -0
- mollie/models/list_subscription_response.py +344 -0
- mollie/models/list_subscriptionsop.py +189 -0
- mollie/models/list_terminalsop.py +172 -0
- mollie/models/list_webhooksop.py +189 -0
- mollie/models/locale.py +32 -0
- mollie/models/locale_response.py +33 -0
- mollie/models/mandate_details_card_label_response.py +22 -0
- mollie/models/mandate_method.py +15 -0
- mollie/models/mandate_method_response.py +16 -0
- mollie/models/mandate_request.py +160 -0
- mollie/models/mandate_response.py +264 -0
- mollie/models/metadata.py +19 -0
- mollie/models/method.py +50 -0
- mollie/models/method_include_wallets_parameter.py +8 -0
- mollie/models/method_resource_parameter.py +9 -0
- mollie/models/method_response.py +59 -0
- mollie/models/method_status.py +15 -0
- mollie/models/mode.py +12 -0
- mollie/models/no_response_error.py +17 -0
- mollie/models/onboarding_vat_regulation.py +16 -0
- mollie/models/organization_vat_regulation.py +17 -0
- mollie/models/payment_address.py +130 -0
- mollie/models/payment_create_routeop.py +43 -0
- mollie/models/payment_details_card_audition_response.py +12 -0
- mollie/models/payment_details_card_funding_response.py +14 -0
- mollie/models/payment_details_card_label_response.py +23 -0
- mollie/models/payment_details_card_security_response.py +12 -0
- mollie/models/payment_details_failure_reason_response.py +25 -0
- mollie/models/payment_details_fee_region_response.py +20 -0
- mollie/models/payment_details_receipt_card_read_method_response.py +17 -0
- mollie/models/payment_details_receipt_card_verification_method_response.py +21 -0
- mollie/models/payment_details_seller_protection_response.py +20 -0
- mollie/models/payment_details_wallet_response.py +11 -0
- mollie/models/payment_line_item.py +96 -0
- mollie/models/payment_line_item_response.py +104 -0
- mollie/models/payment_line_type.py +20 -0
- mollie/models/payment_line_type_response.py +21 -0
- mollie/models/payment_link_method.py +36 -0
- mollie/models/payment_link_method_response.py +37 -0
- mollie/models/payment_link_response.py +348 -0
- mollie/models/payment_link_sequence_type.py +9 -0
- mollie/models/payment_link_sequence_type_response.py +10 -0
- mollie/models/payment_list_routesop.py +140 -0
- mollie/models/payment_method.py +53 -0
- mollie/models/payment_request.py +919 -0
- mollie/models/payment_response.py +1953 -0
- mollie/models/profile_request.py +67 -0
- mollie/models/profile_response.py +197 -0
- mollie/models/profile_review_status_response.py +12 -0
- mollie/models/recurring_line_item.py +77 -0
- mollie/models/refund_external_reference_type.py +10 -0
- mollie/models/refund_external_reference_type_response.py +11 -0
- mollie/models/refund_request.py +200 -0
- mollie/models/release_authorizationop.py +108 -0
- mollie/models/request_apple_pay_payment_sessionop.py +76 -0
- mollie/models/responsevalidationerror.py +27 -0
- mollie/models/revoke_mandateop.py +100 -0
- mollie/models/route_create_response.py +97 -0
- mollie/models/route_destination_type.py +10 -0
- mollie/models/route_destination_type_response.py +11 -0
- mollie/models/sales_invoice_discount.py +21 -0
- mollie/models/sales_invoice_discount_response.py +25 -0
- mollie/models/sales_invoice_discount_type.py +11 -0
- mollie/models/sales_invoice_discount_type_response.py +12 -0
- mollie/models/sales_invoice_email_details.py +20 -0
- mollie/models/sales_invoice_line_item.py +67 -0
- mollie/models/sales_invoice_line_item_response.py +70 -0
- mollie/models/sales_invoice_payment_details.py +59 -0
- mollie/models/sales_invoice_payment_details_response.py +66 -0
- mollie/models/sales_invoice_payment_details_source.py +12 -0
- mollie/models/sales_invoice_payment_details_source_response.py +13 -0
- mollie/models/sales_invoice_payment_term.py +16 -0
- mollie/models/sales_invoice_payment_term_response.py +17 -0
- mollie/models/sales_invoice_recipient.py +176 -0
- mollie/models/sales_invoice_recipient_locale.py +18 -0
- mollie/models/sales_invoice_recipient_locale_response.py +19 -0
- mollie/models/sales_invoice_recipient_response.py +182 -0
- mollie/models/sales_invoice_recipient_type.py +13 -0
- mollie/models/sales_invoice_recipient_type_response.py +14 -0
- mollie/models/sales_invoice_request.py +256 -0
- mollie/models/sales_invoice_response.py +509 -0
- mollie/models/sales_invoice_status.py +25 -0
- mollie/models/sales_invoice_status_response.py +26 -0
- mollie/models/sales_invoice_vat_mode.py +13 -0
- mollie/models/sales_invoice_vat_mode_response.py +14 -0
- mollie/models/sales_invoice_vat_scheme.py +11 -0
- mollie/models/sales_invoice_vat_scheme_response.py +12 -0
- mollie/models/security.py +35 -0
- mollie/models/sequence_type.py +10 -0
- mollie/models/sequence_type_response.py +11 -0
- mollie/models/sorting.py +9 -0
- mollie/models/status_reason.py +168 -0
- mollie/models/sub_group.py +52 -0
- mollie/models/sub_totals.py +120 -0
- mollie/models/submit_onboarding_dataop.py +214 -0
- mollie/models/subscription_method.py +12 -0
- mollie/models/subscription_method_response.py +13 -0
- mollie/models/subscription_request.py +213 -0
- mollie/models/subscription_response.py +349 -0
- mollie/models/terminal_brand.py +12 -0
- mollie/models/terminal_model.py +16 -0
- mollie/models/test_webhookop.py +64 -0
- mollie/models/update_customerop.py +43 -0
- mollie/models/update_payment_linkop.py +172 -0
- mollie/models/update_paymentop.py +332 -0
- mollie/models/update_profileop.py +147 -0
- mollie/models/update_sales_invoiceop.py +44 -0
- mollie/models/update_subscriptionop.py +188 -0
- mollie/models/update_values_sales_invoice.py +176 -0
- mollie/models/update_webhookop.py +83 -0
- mollie/models/url.py +24 -0
- mollie/models/url_nullable.py +25 -0
- mollie/models/webhook_event_types.py +18 -0
- mollie/models/webhook_status.py +14 -0
- mollie/onboarding.py +403 -0
- mollie/organizations.py +579 -0
- mollie/payment_links.py +1323 -0
- mollie/payments_sdk.py +1385 -0
- mollie/permissions.py +397 -0
- mollie/profiles.py +1209 -0
- mollie/py.typed +1 -0
- mollie/refunds_sdk.py +1111 -0
- mollie/sales_invoices.py +1121 -0
- mollie/sdk.py +265 -0
- mollie/sdkconfiguration.py +50 -0
- mollie/settlements.py +1735 -0
- mollie/subscriptions.py +1617 -0
- mollie/terminals.py +427 -0
- mollie/types/__init__.py +21 -0
- mollie/types/basemodel.py +39 -0
- mollie/utils/__init__.py +200 -0
- mollie/utils/annotations.py +79 -0
- mollie/utils/datetimes.py +23 -0
- mollie/utils/enums.py +74 -0
- mollie/utils/eventstreaming.py +248 -0
- mollie/utils/forms.py +223 -0
- mollie/utils/headers.py +136 -0
- mollie/utils/logger.py +27 -0
- mollie/utils/metadata.py +118 -0
- mollie/utils/queryparams.py +205 -0
- mollie/utils/requestbodies.py +66 -0
- mollie/utils/retries.py +217 -0
- mollie/utils/security.py +195 -0
- mollie/utils/serializers.py +249 -0
- mollie/utils/unmarshal_json_response.py +24 -0
- mollie/utils/url.py +155 -0
- mollie/utils/values.py +137 -0
- mollie/wallets.py +263 -0
- mollie/webhook_events.py +211 -0
- mollie/webhooks.py +1305 -0
- mollie_api_py-1.0.0.dist-info/METADATA +834 -0
- mollie_api_py-1.0.0.dist-info/RECORD +337 -0
- mollie_api_py-1.0.0.dist-info/WHEEL +4 -0
- mollie_api_py-1.0.0.dist-info/licenses/LICENSE.md +24 -0
mollie/methods.py
ADDED
|
@@ -0,0 +1,789 @@
|
|
|
1
|
+
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
|
+
|
|
3
|
+
from .basesdk import BaseSDK
|
|
4
|
+
from mollie import models, utils
|
|
5
|
+
from mollie._hooks import HookContext
|
|
6
|
+
from mollie.types import OptionalNullable, UNSET
|
|
7
|
+
from mollie.utils import get_security_from_env
|
|
8
|
+
from mollie.utils.unmarshal_json_response import unmarshal_json_response
|
|
9
|
+
from typing import Any, Mapping, Optional, Union
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class Methods(BaseSDK):
|
|
13
|
+
def list(
|
|
14
|
+
self,
|
|
15
|
+
*,
|
|
16
|
+
sequence_type: Optional[models.SequenceType] = None,
|
|
17
|
+
locale: OptionalNullable[models.Locale] = UNSET,
|
|
18
|
+
amount: Optional[Union[models.Amount, models.AmountTypedDict]] = None,
|
|
19
|
+
resource: Optional[models.MethodResourceParameter] = None,
|
|
20
|
+
billing_country: Optional[str] = None,
|
|
21
|
+
include_wallets: Optional[models.MethodIncludeWalletsParameter] = None,
|
|
22
|
+
order_line_categories: Optional[models.LineCategories] = None,
|
|
23
|
+
profile_id: Optional[str] = None,
|
|
24
|
+
include: OptionalNullable[str] = UNSET,
|
|
25
|
+
testmode: Optional[bool] = None,
|
|
26
|
+
idempotency_key: Optional[str] = None,
|
|
27
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
28
|
+
server_url: Optional[str] = None,
|
|
29
|
+
timeout_ms: Optional[int] = None,
|
|
30
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
31
|
+
) -> models.ListMethodsResponse:
|
|
32
|
+
r"""List payment methods
|
|
33
|
+
|
|
34
|
+
Retrieve all enabled payment methods. The results of this endpoint are
|
|
35
|
+
**not** paginated — unlike most other list endpoints in our API.
|
|
36
|
+
|
|
37
|
+
For test mode, all pending and enabled payment methods are returned. If no
|
|
38
|
+
payment methods are requested yet, the most popular payment methods are returned in the test mode. For live
|
|
39
|
+
mode, only fully enabled payment methods are returned.
|
|
40
|
+
|
|
41
|
+
Payment methods can be requested and enabled via the Mollie Dashboard, or
|
|
42
|
+
via the [Enable payment method endpoint](enable-method) of the Profiles API.
|
|
43
|
+
|
|
44
|
+
The list can optionally be filtered using a number of parameters described
|
|
45
|
+
below.
|
|
46
|
+
|
|
47
|
+
By default, only payment methods for the Euro currency are returned. If you
|
|
48
|
+
wish to retrieve payment methods which exclusively support other currencies (e.g. Twint), you need to use the
|
|
49
|
+
`amount` parameters.
|
|
50
|
+
|
|
51
|
+
ℹ️ **Note:** This endpoint only returns **online** payment methods. If you wish to retrieve the information about
|
|
52
|
+
a non-online payment method, you can use the [Get payment method endpoint](get-method).
|
|
53
|
+
|
|
54
|
+
:param sequence_type: Set this parameter to `first` to only return the enabled methods that can be used for the first payment of a recurring sequence. Set it to `recurring` to only return enabled methods that can be used for recurring payments or subscriptions.
|
|
55
|
+
:param locale: Response language
|
|
56
|
+
:param amount: If supplied, only payment methods that support the amount and currency are returned. Example: `/v2/methods?amount[value]=100.00&amount[currency]=USD`
|
|
57
|
+
:param resource: **⚠️ We no longer recommend using the Orders API. Please refer to the [Payments API](payments-api) instead.** Indicate if you will use the result for the [Create order](create-order) or the [Create payment](create-payment) endpoint. When passing the value `orders`, the result will include payment methods that are only available for payments created via the Orders API.
|
|
58
|
+
:param billing_country: The country taken from your customer's billing address in ISO 3166-1 alpha-2 format. This parameter can be used to check whether your customer is eligible for certain payment methods, for example for Klarna. Example: `/v2/methods?resource=orders&billingCountry=DE`
|
|
59
|
+
:param include_wallets: A comma-separated list of the wallets you support in your checkout. Wallets often require wallet specific code to check if they are available on the shoppers device, hence the need to indicate your support.
|
|
60
|
+
:param order_line_categories: A comma-separated list of the line categories you support in your checkout. Example: `/v2/methods?orderLineCategories=eco,meal`
|
|
61
|
+
:param profile_id: The identifier referring to the [profile](get-profile) you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
62
|
+
:param include: This endpoint allows you to include additional information via the `include` query string parameter.
|
|
63
|
+
:param testmode: Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
64
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
65
|
+
:param retries: Override the default retry configuration for this method
|
|
66
|
+
:param server_url: Override the default server URL for this method
|
|
67
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
68
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
69
|
+
"""
|
|
70
|
+
base_url = None
|
|
71
|
+
url_variables = None
|
|
72
|
+
if timeout_ms is None:
|
|
73
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
74
|
+
|
|
75
|
+
if server_url is not None:
|
|
76
|
+
base_url = server_url
|
|
77
|
+
else:
|
|
78
|
+
base_url = self._get_url(base_url, url_variables)
|
|
79
|
+
|
|
80
|
+
request = models.ListMethodsRequest(
|
|
81
|
+
sequence_type=sequence_type,
|
|
82
|
+
locale=locale,
|
|
83
|
+
amount=utils.get_pydantic_model(amount, Optional[models.Amount]),
|
|
84
|
+
resource=resource,
|
|
85
|
+
billing_country=billing_country,
|
|
86
|
+
include_wallets=include_wallets,
|
|
87
|
+
order_line_categories=order_line_categories,
|
|
88
|
+
profile_id=profile_id,
|
|
89
|
+
include=include,
|
|
90
|
+
testmode=testmode,
|
|
91
|
+
idempotency_key=idempotency_key,
|
|
92
|
+
)
|
|
93
|
+
|
|
94
|
+
req = self._build_request(
|
|
95
|
+
method="GET",
|
|
96
|
+
path="/methods",
|
|
97
|
+
base_url=base_url,
|
|
98
|
+
url_variables=url_variables,
|
|
99
|
+
request=request,
|
|
100
|
+
request_body_required=False,
|
|
101
|
+
request_has_path_params=False,
|
|
102
|
+
request_has_query_params=True,
|
|
103
|
+
user_agent_header="user-agent",
|
|
104
|
+
accept_header_value="application/hal+json",
|
|
105
|
+
http_headers=http_headers,
|
|
106
|
+
_globals=models.ListMethodsGlobals(
|
|
107
|
+
profile_id=self.sdk_configuration.globals.profile_id,
|
|
108
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
109
|
+
),
|
|
110
|
+
security=self.sdk_configuration.security,
|
|
111
|
+
timeout_ms=timeout_ms,
|
|
112
|
+
)
|
|
113
|
+
|
|
114
|
+
if retries == UNSET:
|
|
115
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
116
|
+
retries = self.sdk_configuration.retry_config
|
|
117
|
+
else:
|
|
118
|
+
retries = utils.RetryConfig(
|
|
119
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
120
|
+
)
|
|
121
|
+
|
|
122
|
+
retry_config = None
|
|
123
|
+
if isinstance(retries, utils.RetryConfig):
|
|
124
|
+
retry_config = (retries, ["5xx"])
|
|
125
|
+
|
|
126
|
+
http_res = self.do_request(
|
|
127
|
+
hook_ctx=HookContext(
|
|
128
|
+
config=self.sdk_configuration,
|
|
129
|
+
base_url=base_url or "",
|
|
130
|
+
operation_id="list-methods",
|
|
131
|
+
oauth2_scopes=None,
|
|
132
|
+
security_source=get_security_from_env(
|
|
133
|
+
self.sdk_configuration.security, models.Security
|
|
134
|
+
),
|
|
135
|
+
),
|
|
136
|
+
request=req,
|
|
137
|
+
error_status_codes=["400", "4XX", "5XX"],
|
|
138
|
+
retry_config=retry_config,
|
|
139
|
+
)
|
|
140
|
+
|
|
141
|
+
response_data: Any = None
|
|
142
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
143
|
+
return unmarshal_json_response(models.ListMethodsResponse, http_res)
|
|
144
|
+
if utils.match_response(http_res, "400", "application/hal+json"):
|
|
145
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
146
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
147
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
148
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
149
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
150
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
151
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
152
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
153
|
+
|
|
154
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
155
|
+
|
|
156
|
+
async def list_async(
|
|
157
|
+
self,
|
|
158
|
+
*,
|
|
159
|
+
sequence_type: Optional[models.SequenceType] = None,
|
|
160
|
+
locale: OptionalNullable[models.Locale] = UNSET,
|
|
161
|
+
amount: Optional[Union[models.Amount, models.AmountTypedDict]] = None,
|
|
162
|
+
resource: Optional[models.MethodResourceParameter] = None,
|
|
163
|
+
billing_country: Optional[str] = None,
|
|
164
|
+
include_wallets: Optional[models.MethodIncludeWalletsParameter] = None,
|
|
165
|
+
order_line_categories: Optional[models.LineCategories] = None,
|
|
166
|
+
profile_id: Optional[str] = None,
|
|
167
|
+
include: OptionalNullable[str] = UNSET,
|
|
168
|
+
testmode: Optional[bool] = None,
|
|
169
|
+
idempotency_key: Optional[str] = None,
|
|
170
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
171
|
+
server_url: Optional[str] = None,
|
|
172
|
+
timeout_ms: Optional[int] = None,
|
|
173
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
174
|
+
) -> models.ListMethodsResponse:
|
|
175
|
+
r"""List payment methods
|
|
176
|
+
|
|
177
|
+
Retrieve all enabled payment methods. The results of this endpoint are
|
|
178
|
+
**not** paginated — unlike most other list endpoints in our API.
|
|
179
|
+
|
|
180
|
+
For test mode, all pending and enabled payment methods are returned. If no
|
|
181
|
+
payment methods are requested yet, the most popular payment methods are returned in the test mode. For live
|
|
182
|
+
mode, only fully enabled payment methods are returned.
|
|
183
|
+
|
|
184
|
+
Payment methods can be requested and enabled via the Mollie Dashboard, or
|
|
185
|
+
via the [Enable payment method endpoint](enable-method) of the Profiles API.
|
|
186
|
+
|
|
187
|
+
The list can optionally be filtered using a number of parameters described
|
|
188
|
+
below.
|
|
189
|
+
|
|
190
|
+
By default, only payment methods for the Euro currency are returned. If you
|
|
191
|
+
wish to retrieve payment methods which exclusively support other currencies (e.g. Twint), you need to use the
|
|
192
|
+
`amount` parameters.
|
|
193
|
+
|
|
194
|
+
ℹ️ **Note:** This endpoint only returns **online** payment methods. If you wish to retrieve the information about
|
|
195
|
+
a non-online payment method, you can use the [Get payment method endpoint](get-method).
|
|
196
|
+
|
|
197
|
+
:param sequence_type: Set this parameter to `first` to only return the enabled methods that can be used for the first payment of a recurring sequence. Set it to `recurring` to only return enabled methods that can be used for recurring payments or subscriptions.
|
|
198
|
+
:param locale: Response language
|
|
199
|
+
:param amount: If supplied, only payment methods that support the amount and currency are returned. Example: `/v2/methods?amount[value]=100.00&amount[currency]=USD`
|
|
200
|
+
:param resource: **⚠️ We no longer recommend using the Orders API. Please refer to the [Payments API](payments-api) instead.** Indicate if you will use the result for the [Create order](create-order) or the [Create payment](create-payment) endpoint. When passing the value `orders`, the result will include payment methods that are only available for payments created via the Orders API.
|
|
201
|
+
:param billing_country: The country taken from your customer's billing address in ISO 3166-1 alpha-2 format. This parameter can be used to check whether your customer is eligible for certain payment methods, for example for Klarna. Example: `/v2/methods?resource=orders&billingCountry=DE`
|
|
202
|
+
:param include_wallets: A comma-separated list of the wallets you support in your checkout. Wallets often require wallet specific code to check if they are available on the shoppers device, hence the need to indicate your support.
|
|
203
|
+
:param order_line_categories: A comma-separated list of the line categories you support in your checkout. Example: `/v2/methods?orderLineCategories=eco,meal`
|
|
204
|
+
:param profile_id: The identifier referring to the [profile](get-profile) you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
205
|
+
:param include: This endpoint allows you to include additional information via the `include` query string parameter.
|
|
206
|
+
:param testmode: Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
207
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
208
|
+
:param retries: Override the default retry configuration for this method
|
|
209
|
+
:param server_url: Override the default server URL for this method
|
|
210
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
211
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
212
|
+
"""
|
|
213
|
+
base_url = None
|
|
214
|
+
url_variables = None
|
|
215
|
+
if timeout_ms is None:
|
|
216
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
217
|
+
|
|
218
|
+
if server_url is not None:
|
|
219
|
+
base_url = server_url
|
|
220
|
+
else:
|
|
221
|
+
base_url = self._get_url(base_url, url_variables)
|
|
222
|
+
|
|
223
|
+
request = models.ListMethodsRequest(
|
|
224
|
+
sequence_type=sequence_type,
|
|
225
|
+
locale=locale,
|
|
226
|
+
amount=utils.get_pydantic_model(amount, Optional[models.Amount]),
|
|
227
|
+
resource=resource,
|
|
228
|
+
billing_country=billing_country,
|
|
229
|
+
include_wallets=include_wallets,
|
|
230
|
+
order_line_categories=order_line_categories,
|
|
231
|
+
profile_id=profile_id,
|
|
232
|
+
include=include,
|
|
233
|
+
testmode=testmode,
|
|
234
|
+
idempotency_key=idempotency_key,
|
|
235
|
+
)
|
|
236
|
+
|
|
237
|
+
req = self._build_request_async(
|
|
238
|
+
method="GET",
|
|
239
|
+
path="/methods",
|
|
240
|
+
base_url=base_url,
|
|
241
|
+
url_variables=url_variables,
|
|
242
|
+
request=request,
|
|
243
|
+
request_body_required=False,
|
|
244
|
+
request_has_path_params=False,
|
|
245
|
+
request_has_query_params=True,
|
|
246
|
+
user_agent_header="user-agent",
|
|
247
|
+
accept_header_value="application/hal+json",
|
|
248
|
+
http_headers=http_headers,
|
|
249
|
+
_globals=models.ListMethodsGlobals(
|
|
250
|
+
profile_id=self.sdk_configuration.globals.profile_id,
|
|
251
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
252
|
+
),
|
|
253
|
+
security=self.sdk_configuration.security,
|
|
254
|
+
timeout_ms=timeout_ms,
|
|
255
|
+
)
|
|
256
|
+
|
|
257
|
+
if retries == UNSET:
|
|
258
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
259
|
+
retries = self.sdk_configuration.retry_config
|
|
260
|
+
else:
|
|
261
|
+
retries = utils.RetryConfig(
|
|
262
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
263
|
+
)
|
|
264
|
+
|
|
265
|
+
retry_config = None
|
|
266
|
+
if isinstance(retries, utils.RetryConfig):
|
|
267
|
+
retry_config = (retries, ["5xx"])
|
|
268
|
+
|
|
269
|
+
http_res = await self.do_request_async(
|
|
270
|
+
hook_ctx=HookContext(
|
|
271
|
+
config=self.sdk_configuration,
|
|
272
|
+
base_url=base_url or "",
|
|
273
|
+
operation_id="list-methods",
|
|
274
|
+
oauth2_scopes=None,
|
|
275
|
+
security_source=get_security_from_env(
|
|
276
|
+
self.sdk_configuration.security, models.Security
|
|
277
|
+
),
|
|
278
|
+
),
|
|
279
|
+
request=req,
|
|
280
|
+
error_status_codes=["400", "4XX", "5XX"],
|
|
281
|
+
retry_config=retry_config,
|
|
282
|
+
)
|
|
283
|
+
|
|
284
|
+
response_data: Any = None
|
|
285
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
286
|
+
return unmarshal_json_response(models.ListMethodsResponse, http_res)
|
|
287
|
+
if utils.match_response(http_res, "400", "application/hal+json"):
|
|
288
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
289
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
290
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
291
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
292
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
293
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
294
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
295
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
296
|
+
|
|
297
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
298
|
+
|
|
299
|
+
def all(
|
|
300
|
+
self,
|
|
301
|
+
*,
|
|
302
|
+
locale: OptionalNullable[models.Locale] = UNSET,
|
|
303
|
+
amount: Optional[Union[models.Amount, models.AmountTypedDict]] = None,
|
|
304
|
+
include: OptionalNullable[str] = UNSET,
|
|
305
|
+
sequence_type: Optional[models.SequenceType] = None,
|
|
306
|
+
profile_id: Optional[str] = None,
|
|
307
|
+
testmode: Optional[bool] = None,
|
|
308
|
+
idempotency_key: Optional[str] = None,
|
|
309
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
310
|
+
server_url: Optional[str] = None,
|
|
311
|
+
timeout_ms: Optional[int] = None,
|
|
312
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
313
|
+
) -> models.ListAllMethodsResponse:
|
|
314
|
+
r"""List all payment methods
|
|
315
|
+
|
|
316
|
+
Retrieve all payment methods that Mollie offers, regardless of the eligibility of the organization for the specific
|
|
317
|
+
method. The results of this endpoint are **not** paginated — unlike most other list endpoints in our API.
|
|
318
|
+
|
|
319
|
+
The list can optionally be filtered using a number of parameters described below.
|
|
320
|
+
|
|
321
|
+
ℹ️ **Note:** This endpoint only returns **online** payment methods. If you wish to retrieve the information about
|
|
322
|
+
a non-online payment method, you can use the [Get payment method endpoint](get-method).
|
|
323
|
+
|
|
324
|
+
:param locale: Response language
|
|
325
|
+
:param amount: If supplied, only payment methods that support the amount and currency are returned. Example: `/v2/methods/all?amount[value]=100.00&amount[currency]=USD`
|
|
326
|
+
:param include: This endpoint allows you to include additional information via the `include` query string parameter.
|
|
327
|
+
:param sequence_type: Set this parameter to `first` to only return the methods that can be used for the first payment of a recurring sequence. Set it to `recurring` to only return methods that can be used for recurring payments or subscriptions.
|
|
328
|
+
:param profile_id: The identifier referring to the [profile](get-profile) you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
329
|
+
:param testmode: Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
330
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
331
|
+
:param retries: Override the default retry configuration for this method
|
|
332
|
+
:param server_url: Override the default server URL for this method
|
|
333
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
334
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
335
|
+
"""
|
|
336
|
+
base_url = None
|
|
337
|
+
url_variables = None
|
|
338
|
+
if timeout_ms is None:
|
|
339
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
340
|
+
|
|
341
|
+
if server_url is not None:
|
|
342
|
+
base_url = server_url
|
|
343
|
+
else:
|
|
344
|
+
base_url = self._get_url(base_url, url_variables)
|
|
345
|
+
|
|
346
|
+
request = models.ListAllMethodsRequest(
|
|
347
|
+
locale=locale,
|
|
348
|
+
amount=utils.get_pydantic_model(amount, Optional[models.Amount]),
|
|
349
|
+
include=include,
|
|
350
|
+
sequence_type=sequence_type,
|
|
351
|
+
profile_id=profile_id,
|
|
352
|
+
testmode=testmode,
|
|
353
|
+
idempotency_key=idempotency_key,
|
|
354
|
+
)
|
|
355
|
+
|
|
356
|
+
req = self._build_request(
|
|
357
|
+
method="GET",
|
|
358
|
+
path="/methods/all",
|
|
359
|
+
base_url=base_url,
|
|
360
|
+
url_variables=url_variables,
|
|
361
|
+
request=request,
|
|
362
|
+
request_body_required=False,
|
|
363
|
+
request_has_path_params=False,
|
|
364
|
+
request_has_query_params=True,
|
|
365
|
+
user_agent_header="user-agent",
|
|
366
|
+
accept_header_value="application/hal+json",
|
|
367
|
+
http_headers=http_headers,
|
|
368
|
+
_globals=models.ListAllMethodsGlobals(
|
|
369
|
+
profile_id=self.sdk_configuration.globals.profile_id,
|
|
370
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
371
|
+
),
|
|
372
|
+
security=self.sdk_configuration.security,
|
|
373
|
+
timeout_ms=timeout_ms,
|
|
374
|
+
)
|
|
375
|
+
|
|
376
|
+
if retries == UNSET:
|
|
377
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
378
|
+
retries = self.sdk_configuration.retry_config
|
|
379
|
+
else:
|
|
380
|
+
retries = utils.RetryConfig(
|
|
381
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
382
|
+
)
|
|
383
|
+
|
|
384
|
+
retry_config = None
|
|
385
|
+
if isinstance(retries, utils.RetryConfig):
|
|
386
|
+
retry_config = (retries, ["5xx"])
|
|
387
|
+
|
|
388
|
+
http_res = self.do_request(
|
|
389
|
+
hook_ctx=HookContext(
|
|
390
|
+
config=self.sdk_configuration,
|
|
391
|
+
base_url=base_url or "",
|
|
392
|
+
operation_id="list-all-methods",
|
|
393
|
+
oauth2_scopes=None,
|
|
394
|
+
security_source=get_security_from_env(
|
|
395
|
+
self.sdk_configuration.security, models.Security
|
|
396
|
+
),
|
|
397
|
+
),
|
|
398
|
+
request=req,
|
|
399
|
+
error_status_codes=["400", "4XX", "5XX"],
|
|
400
|
+
retry_config=retry_config,
|
|
401
|
+
)
|
|
402
|
+
|
|
403
|
+
response_data: Any = None
|
|
404
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
405
|
+
return unmarshal_json_response(models.ListAllMethodsResponse, http_res)
|
|
406
|
+
if utils.match_response(http_res, "400", "application/hal+json"):
|
|
407
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
408
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
409
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
410
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
411
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
412
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
413
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
414
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
415
|
+
|
|
416
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
417
|
+
|
|
418
|
+
async def all_async(
|
|
419
|
+
self,
|
|
420
|
+
*,
|
|
421
|
+
locale: OptionalNullable[models.Locale] = UNSET,
|
|
422
|
+
amount: Optional[Union[models.Amount, models.AmountTypedDict]] = None,
|
|
423
|
+
include: OptionalNullable[str] = UNSET,
|
|
424
|
+
sequence_type: Optional[models.SequenceType] = None,
|
|
425
|
+
profile_id: Optional[str] = None,
|
|
426
|
+
testmode: Optional[bool] = None,
|
|
427
|
+
idempotency_key: Optional[str] = None,
|
|
428
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
429
|
+
server_url: Optional[str] = None,
|
|
430
|
+
timeout_ms: Optional[int] = None,
|
|
431
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
432
|
+
) -> models.ListAllMethodsResponse:
|
|
433
|
+
r"""List all payment methods
|
|
434
|
+
|
|
435
|
+
Retrieve all payment methods that Mollie offers, regardless of the eligibility of the organization for the specific
|
|
436
|
+
method. The results of this endpoint are **not** paginated — unlike most other list endpoints in our API.
|
|
437
|
+
|
|
438
|
+
The list can optionally be filtered using a number of parameters described below.
|
|
439
|
+
|
|
440
|
+
ℹ️ **Note:** This endpoint only returns **online** payment methods. If you wish to retrieve the information about
|
|
441
|
+
a non-online payment method, you can use the [Get payment method endpoint](get-method).
|
|
442
|
+
|
|
443
|
+
:param locale: Response language
|
|
444
|
+
:param amount: If supplied, only payment methods that support the amount and currency are returned. Example: `/v2/methods/all?amount[value]=100.00&amount[currency]=USD`
|
|
445
|
+
:param include: This endpoint allows you to include additional information via the `include` query string parameter.
|
|
446
|
+
:param sequence_type: Set this parameter to `first` to only return the methods that can be used for the first payment of a recurring sequence. Set it to `recurring` to only return methods that can be used for recurring payments or subscriptions.
|
|
447
|
+
:param profile_id: The identifier referring to the [profile](get-profile) you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
448
|
+
:param testmode: Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
449
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
450
|
+
:param retries: Override the default retry configuration for this method
|
|
451
|
+
:param server_url: Override the default server URL for this method
|
|
452
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
453
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
454
|
+
"""
|
|
455
|
+
base_url = None
|
|
456
|
+
url_variables = None
|
|
457
|
+
if timeout_ms is None:
|
|
458
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
459
|
+
|
|
460
|
+
if server_url is not None:
|
|
461
|
+
base_url = server_url
|
|
462
|
+
else:
|
|
463
|
+
base_url = self._get_url(base_url, url_variables)
|
|
464
|
+
|
|
465
|
+
request = models.ListAllMethodsRequest(
|
|
466
|
+
locale=locale,
|
|
467
|
+
amount=utils.get_pydantic_model(amount, Optional[models.Amount]),
|
|
468
|
+
include=include,
|
|
469
|
+
sequence_type=sequence_type,
|
|
470
|
+
profile_id=profile_id,
|
|
471
|
+
testmode=testmode,
|
|
472
|
+
idempotency_key=idempotency_key,
|
|
473
|
+
)
|
|
474
|
+
|
|
475
|
+
req = self._build_request_async(
|
|
476
|
+
method="GET",
|
|
477
|
+
path="/methods/all",
|
|
478
|
+
base_url=base_url,
|
|
479
|
+
url_variables=url_variables,
|
|
480
|
+
request=request,
|
|
481
|
+
request_body_required=False,
|
|
482
|
+
request_has_path_params=False,
|
|
483
|
+
request_has_query_params=True,
|
|
484
|
+
user_agent_header="user-agent",
|
|
485
|
+
accept_header_value="application/hal+json",
|
|
486
|
+
http_headers=http_headers,
|
|
487
|
+
_globals=models.ListAllMethodsGlobals(
|
|
488
|
+
profile_id=self.sdk_configuration.globals.profile_id,
|
|
489
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
490
|
+
),
|
|
491
|
+
security=self.sdk_configuration.security,
|
|
492
|
+
timeout_ms=timeout_ms,
|
|
493
|
+
)
|
|
494
|
+
|
|
495
|
+
if retries == UNSET:
|
|
496
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
497
|
+
retries = self.sdk_configuration.retry_config
|
|
498
|
+
else:
|
|
499
|
+
retries = utils.RetryConfig(
|
|
500
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
501
|
+
)
|
|
502
|
+
|
|
503
|
+
retry_config = None
|
|
504
|
+
if isinstance(retries, utils.RetryConfig):
|
|
505
|
+
retry_config = (retries, ["5xx"])
|
|
506
|
+
|
|
507
|
+
http_res = await self.do_request_async(
|
|
508
|
+
hook_ctx=HookContext(
|
|
509
|
+
config=self.sdk_configuration,
|
|
510
|
+
base_url=base_url or "",
|
|
511
|
+
operation_id="list-all-methods",
|
|
512
|
+
oauth2_scopes=None,
|
|
513
|
+
security_source=get_security_from_env(
|
|
514
|
+
self.sdk_configuration.security, models.Security
|
|
515
|
+
),
|
|
516
|
+
),
|
|
517
|
+
request=req,
|
|
518
|
+
error_status_codes=["400", "4XX", "5XX"],
|
|
519
|
+
retry_config=retry_config,
|
|
520
|
+
)
|
|
521
|
+
|
|
522
|
+
response_data: Any = None
|
|
523
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
524
|
+
return unmarshal_json_response(models.ListAllMethodsResponse, http_res)
|
|
525
|
+
if utils.match_response(http_res, "400", "application/hal+json"):
|
|
526
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
527
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
528
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
529
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
530
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
531
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
532
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
533
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
534
|
+
|
|
535
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
536
|
+
|
|
537
|
+
def get(
|
|
538
|
+
self,
|
|
539
|
+
*,
|
|
540
|
+
id: str,
|
|
541
|
+
locale: OptionalNullable[models.Locale] = UNSET,
|
|
542
|
+
currency: Optional[str] = None,
|
|
543
|
+
profile_id: Optional[str] = None,
|
|
544
|
+
include: OptionalNullable[str] = UNSET,
|
|
545
|
+
sequence_type: Optional[models.SequenceType] = None,
|
|
546
|
+
testmode: Optional[bool] = None,
|
|
547
|
+
idempotency_key: Optional[str] = None,
|
|
548
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
549
|
+
server_url: Optional[str] = None,
|
|
550
|
+
timeout_ms: Optional[int] = None,
|
|
551
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
552
|
+
) -> models.EntityMethodGet:
|
|
553
|
+
r"""Get payment method
|
|
554
|
+
|
|
555
|
+
Retrieve a single payment method by its ID.
|
|
556
|
+
|
|
557
|
+
If a method is not available on this profile, a `404 Not Found` response is
|
|
558
|
+
returned. If the method is available but not enabled yet, a status `403 Forbidden` is returned. You can enable
|
|
559
|
+
payments methods via the [Enable payment method endpoint](enable-method) of the Profiles API, or via
|
|
560
|
+
the Mollie Dashboard.
|
|
561
|
+
|
|
562
|
+
If you do not know the method's ID, you can use the [methods list
|
|
563
|
+
endpoint](list-methods) to retrieve all payment methods that are available.
|
|
564
|
+
|
|
565
|
+
Additionally, it is possible to check if wallet methods such as Apple Pay
|
|
566
|
+
are enabled by passing the wallet ID (`applepay`) as the method ID.
|
|
567
|
+
|
|
568
|
+
:param id: Provide the ID of the item you want to perform this operation on.
|
|
569
|
+
:param locale: Response language
|
|
570
|
+
:param currency: If provided, the `minimumAmount` and `maximumAmount` will be converted to the given currency. An error is returned if the currency is not supported by the payment method.
|
|
571
|
+
:param profile_id: The identifier referring to the [profile](get-profile) you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
572
|
+
:param include: This endpoint allows you to include additional information via the `include` query string parameter.
|
|
573
|
+
:param sequence_type: Set this parameter to `first` to only return the methods that can be used for the first payment of a recurring sequence. Set it to `recurring` to only return methods that can be used for recurring payments or subscriptions.
|
|
574
|
+
:param testmode: Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
575
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
576
|
+
:param retries: Override the default retry configuration for this method
|
|
577
|
+
:param server_url: Override the default server URL for this method
|
|
578
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
579
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
580
|
+
"""
|
|
581
|
+
base_url = None
|
|
582
|
+
url_variables = None
|
|
583
|
+
if timeout_ms is None:
|
|
584
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
585
|
+
|
|
586
|
+
if server_url is not None:
|
|
587
|
+
base_url = server_url
|
|
588
|
+
else:
|
|
589
|
+
base_url = self._get_url(base_url, url_variables)
|
|
590
|
+
|
|
591
|
+
request = models.GetMethodRequest(
|
|
592
|
+
id=id,
|
|
593
|
+
locale=locale,
|
|
594
|
+
currency=currency,
|
|
595
|
+
profile_id=profile_id,
|
|
596
|
+
include=include,
|
|
597
|
+
sequence_type=sequence_type,
|
|
598
|
+
testmode=testmode,
|
|
599
|
+
idempotency_key=idempotency_key,
|
|
600
|
+
)
|
|
601
|
+
|
|
602
|
+
req = self._build_request(
|
|
603
|
+
method="GET",
|
|
604
|
+
path="/methods/{id}",
|
|
605
|
+
base_url=base_url,
|
|
606
|
+
url_variables=url_variables,
|
|
607
|
+
request=request,
|
|
608
|
+
request_body_required=False,
|
|
609
|
+
request_has_path_params=True,
|
|
610
|
+
request_has_query_params=True,
|
|
611
|
+
user_agent_header="user-agent",
|
|
612
|
+
accept_header_value="application/hal+json",
|
|
613
|
+
http_headers=http_headers,
|
|
614
|
+
_globals=models.GetMethodGlobals(
|
|
615
|
+
profile_id=self.sdk_configuration.globals.profile_id,
|
|
616
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
617
|
+
),
|
|
618
|
+
security=self.sdk_configuration.security,
|
|
619
|
+
timeout_ms=timeout_ms,
|
|
620
|
+
)
|
|
621
|
+
|
|
622
|
+
if retries == UNSET:
|
|
623
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
624
|
+
retries = self.sdk_configuration.retry_config
|
|
625
|
+
else:
|
|
626
|
+
retries = utils.RetryConfig(
|
|
627
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
628
|
+
)
|
|
629
|
+
|
|
630
|
+
retry_config = None
|
|
631
|
+
if isinstance(retries, utils.RetryConfig):
|
|
632
|
+
retry_config = (retries, ["5xx"])
|
|
633
|
+
|
|
634
|
+
http_res = self.do_request(
|
|
635
|
+
hook_ctx=HookContext(
|
|
636
|
+
config=self.sdk_configuration,
|
|
637
|
+
base_url=base_url or "",
|
|
638
|
+
operation_id="get-method",
|
|
639
|
+
oauth2_scopes=None,
|
|
640
|
+
security_source=get_security_from_env(
|
|
641
|
+
self.sdk_configuration.security, models.Security
|
|
642
|
+
),
|
|
643
|
+
),
|
|
644
|
+
request=req,
|
|
645
|
+
error_status_codes=["400", "404", "4XX", "5XX"],
|
|
646
|
+
retry_config=retry_config,
|
|
647
|
+
)
|
|
648
|
+
|
|
649
|
+
response_data: Any = None
|
|
650
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
651
|
+
return unmarshal_json_response(models.EntityMethodGet, http_res)
|
|
652
|
+
if utils.match_response(http_res, ["400", "404"], "application/hal+json"):
|
|
653
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
654
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
655
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
656
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
657
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
658
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
659
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
660
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
661
|
+
|
|
662
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
663
|
+
|
|
664
|
+
async def get_async(
|
|
665
|
+
self,
|
|
666
|
+
*,
|
|
667
|
+
id: str,
|
|
668
|
+
locale: OptionalNullable[models.Locale] = UNSET,
|
|
669
|
+
currency: Optional[str] = None,
|
|
670
|
+
profile_id: Optional[str] = None,
|
|
671
|
+
include: OptionalNullable[str] = UNSET,
|
|
672
|
+
sequence_type: Optional[models.SequenceType] = None,
|
|
673
|
+
testmode: Optional[bool] = None,
|
|
674
|
+
idempotency_key: Optional[str] = None,
|
|
675
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
676
|
+
server_url: Optional[str] = None,
|
|
677
|
+
timeout_ms: Optional[int] = None,
|
|
678
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
679
|
+
) -> models.EntityMethodGet:
|
|
680
|
+
r"""Get payment method
|
|
681
|
+
|
|
682
|
+
Retrieve a single payment method by its ID.
|
|
683
|
+
|
|
684
|
+
If a method is not available on this profile, a `404 Not Found` response is
|
|
685
|
+
returned. If the method is available but not enabled yet, a status `403 Forbidden` is returned. You can enable
|
|
686
|
+
payments methods via the [Enable payment method endpoint](enable-method) of the Profiles API, or via
|
|
687
|
+
the Mollie Dashboard.
|
|
688
|
+
|
|
689
|
+
If you do not know the method's ID, you can use the [methods list
|
|
690
|
+
endpoint](list-methods) to retrieve all payment methods that are available.
|
|
691
|
+
|
|
692
|
+
Additionally, it is possible to check if wallet methods such as Apple Pay
|
|
693
|
+
are enabled by passing the wallet ID (`applepay`) as the method ID.
|
|
694
|
+
|
|
695
|
+
:param id: Provide the ID of the item you want to perform this operation on.
|
|
696
|
+
:param locale: Response language
|
|
697
|
+
:param currency: If provided, the `minimumAmount` and `maximumAmount` will be converted to the given currency. An error is returned if the currency is not supported by the payment method.
|
|
698
|
+
:param profile_id: The identifier referring to the [profile](get-profile) you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
|
|
699
|
+
:param include: This endpoint allows you to include additional information via the `include` query string parameter.
|
|
700
|
+
:param sequence_type: Set this parameter to `first` to only return the methods that can be used for the first payment of a recurring sequence. Set it to `recurring` to only return methods that can be used for recurring payments or subscriptions.
|
|
701
|
+
:param testmode: Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
702
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
703
|
+
:param retries: Override the default retry configuration for this method
|
|
704
|
+
:param server_url: Override the default server URL for this method
|
|
705
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
706
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
707
|
+
"""
|
|
708
|
+
base_url = None
|
|
709
|
+
url_variables = None
|
|
710
|
+
if timeout_ms is None:
|
|
711
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
712
|
+
|
|
713
|
+
if server_url is not None:
|
|
714
|
+
base_url = server_url
|
|
715
|
+
else:
|
|
716
|
+
base_url = self._get_url(base_url, url_variables)
|
|
717
|
+
|
|
718
|
+
request = models.GetMethodRequest(
|
|
719
|
+
id=id,
|
|
720
|
+
locale=locale,
|
|
721
|
+
currency=currency,
|
|
722
|
+
profile_id=profile_id,
|
|
723
|
+
include=include,
|
|
724
|
+
sequence_type=sequence_type,
|
|
725
|
+
testmode=testmode,
|
|
726
|
+
idempotency_key=idempotency_key,
|
|
727
|
+
)
|
|
728
|
+
|
|
729
|
+
req = self._build_request_async(
|
|
730
|
+
method="GET",
|
|
731
|
+
path="/methods/{id}",
|
|
732
|
+
base_url=base_url,
|
|
733
|
+
url_variables=url_variables,
|
|
734
|
+
request=request,
|
|
735
|
+
request_body_required=False,
|
|
736
|
+
request_has_path_params=True,
|
|
737
|
+
request_has_query_params=True,
|
|
738
|
+
user_agent_header="user-agent",
|
|
739
|
+
accept_header_value="application/hal+json",
|
|
740
|
+
http_headers=http_headers,
|
|
741
|
+
_globals=models.GetMethodGlobals(
|
|
742
|
+
profile_id=self.sdk_configuration.globals.profile_id,
|
|
743
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
744
|
+
),
|
|
745
|
+
security=self.sdk_configuration.security,
|
|
746
|
+
timeout_ms=timeout_ms,
|
|
747
|
+
)
|
|
748
|
+
|
|
749
|
+
if retries == UNSET:
|
|
750
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
751
|
+
retries = self.sdk_configuration.retry_config
|
|
752
|
+
else:
|
|
753
|
+
retries = utils.RetryConfig(
|
|
754
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
755
|
+
)
|
|
756
|
+
|
|
757
|
+
retry_config = None
|
|
758
|
+
if isinstance(retries, utils.RetryConfig):
|
|
759
|
+
retry_config = (retries, ["5xx"])
|
|
760
|
+
|
|
761
|
+
http_res = await self.do_request_async(
|
|
762
|
+
hook_ctx=HookContext(
|
|
763
|
+
config=self.sdk_configuration,
|
|
764
|
+
base_url=base_url or "",
|
|
765
|
+
operation_id="get-method",
|
|
766
|
+
oauth2_scopes=None,
|
|
767
|
+
security_source=get_security_from_env(
|
|
768
|
+
self.sdk_configuration.security, models.Security
|
|
769
|
+
),
|
|
770
|
+
),
|
|
771
|
+
request=req,
|
|
772
|
+
error_status_codes=["400", "404", "4XX", "5XX"],
|
|
773
|
+
retry_config=retry_config,
|
|
774
|
+
)
|
|
775
|
+
|
|
776
|
+
response_data: Any = None
|
|
777
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
778
|
+
return unmarshal_json_response(models.EntityMethodGet, http_res)
|
|
779
|
+
if utils.match_response(http_res, ["400", "404"], "application/hal+json"):
|
|
780
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
781
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
782
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
783
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
784
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
785
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
786
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
787
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
788
|
+
|
|
789
|
+
raise models.APIError("Unexpected response received", http_res)
|