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/captures.py
ADDED
|
@@ -0,0 +1,677 @@
|
|
|
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 Captures(BaseSDK):
|
|
13
|
+
def create(
|
|
14
|
+
self,
|
|
15
|
+
*,
|
|
16
|
+
payment_id: str,
|
|
17
|
+
idempotency_key: Optional[str] = None,
|
|
18
|
+
entity_capture: Optional[
|
|
19
|
+
Union[models.EntityCapture, models.EntityCaptureTypedDict]
|
|
20
|
+
] = None,
|
|
21
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
22
|
+
server_url: Optional[str] = None,
|
|
23
|
+
timeout_ms: Optional[int] = None,
|
|
24
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
25
|
+
) -> models.CaptureResponse:
|
|
26
|
+
r"""Create capture
|
|
27
|
+
|
|
28
|
+
Capture an *authorized* payment.
|
|
29
|
+
|
|
30
|
+
Some payment methods allow you to first collect a customer's authorization,
|
|
31
|
+
and capture the amount at a later point.
|
|
32
|
+
|
|
33
|
+
By default, Mollie captures payments automatically. If however you
|
|
34
|
+
configured your payment with `captureMode: manual`, you can capture the payment using this endpoint after
|
|
35
|
+
having collected the customer's authorization.
|
|
36
|
+
|
|
37
|
+
:param payment_id: Provide the ID of the related payment.
|
|
38
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
39
|
+
:param entity_capture:
|
|
40
|
+
:param retries: Override the default retry configuration for this method
|
|
41
|
+
:param server_url: Override the default server URL for this method
|
|
42
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
43
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
44
|
+
"""
|
|
45
|
+
base_url = None
|
|
46
|
+
url_variables = None
|
|
47
|
+
if timeout_ms is None:
|
|
48
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
49
|
+
|
|
50
|
+
if server_url is not None:
|
|
51
|
+
base_url = server_url
|
|
52
|
+
else:
|
|
53
|
+
base_url = self._get_url(base_url, url_variables)
|
|
54
|
+
|
|
55
|
+
request = models.CreateCaptureRequest(
|
|
56
|
+
payment_id=payment_id,
|
|
57
|
+
idempotency_key=idempotency_key,
|
|
58
|
+
entity_capture=utils.get_pydantic_model(
|
|
59
|
+
entity_capture, Optional[models.EntityCapture]
|
|
60
|
+
),
|
|
61
|
+
)
|
|
62
|
+
|
|
63
|
+
req = self._build_request(
|
|
64
|
+
method="POST",
|
|
65
|
+
path="/payments/{paymentId}/captures",
|
|
66
|
+
base_url=base_url,
|
|
67
|
+
url_variables=url_variables,
|
|
68
|
+
request=request,
|
|
69
|
+
request_body_required=False,
|
|
70
|
+
request_has_path_params=True,
|
|
71
|
+
request_has_query_params=True,
|
|
72
|
+
user_agent_header="user-agent",
|
|
73
|
+
accept_header_value="application/hal+json",
|
|
74
|
+
http_headers=http_headers,
|
|
75
|
+
security=self.sdk_configuration.security,
|
|
76
|
+
get_serialized_body=lambda: utils.serialize_request_body(
|
|
77
|
+
request.entity_capture,
|
|
78
|
+
False,
|
|
79
|
+
True,
|
|
80
|
+
"json",
|
|
81
|
+
Optional[models.EntityCapture],
|
|
82
|
+
),
|
|
83
|
+
timeout_ms=timeout_ms,
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
if retries == UNSET:
|
|
87
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
88
|
+
retries = self.sdk_configuration.retry_config
|
|
89
|
+
else:
|
|
90
|
+
retries = utils.RetryConfig(
|
|
91
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
92
|
+
)
|
|
93
|
+
|
|
94
|
+
retry_config = None
|
|
95
|
+
if isinstance(retries, utils.RetryConfig):
|
|
96
|
+
retry_config = (retries, ["5xx"])
|
|
97
|
+
|
|
98
|
+
http_res = self.do_request(
|
|
99
|
+
hook_ctx=HookContext(
|
|
100
|
+
config=self.sdk_configuration,
|
|
101
|
+
base_url=base_url or "",
|
|
102
|
+
operation_id="create-capture",
|
|
103
|
+
oauth2_scopes=None,
|
|
104
|
+
security_source=get_security_from_env(
|
|
105
|
+
self.sdk_configuration.security, models.Security
|
|
106
|
+
),
|
|
107
|
+
),
|
|
108
|
+
request=req,
|
|
109
|
+
error_status_codes=["404", "422", "4XX", "5XX"],
|
|
110
|
+
retry_config=retry_config,
|
|
111
|
+
)
|
|
112
|
+
|
|
113
|
+
response_data: Any = None
|
|
114
|
+
if utils.match_response(http_res, "201", "application/hal+json"):
|
|
115
|
+
return unmarshal_json_response(models.CaptureResponse, http_res)
|
|
116
|
+
if utils.match_response(http_res, ["404", "422"], "application/hal+json"):
|
|
117
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
118
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
119
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
120
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
121
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
122
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
123
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
124
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
125
|
+
|
|
126
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
127
|
+
|
|
128
|
+
async def create_async(
|
|
129
|
+
self,
|
|
130
|
+
*,
|
|
131
|
+
payment_id: str,
|
|
132
|
+
idempotency_key: Optional[str] = None,
|
|
133
|
+
entity_capture: Optional[
|
|
134
|
+
Union[models.EntityCapture, models.EntityCaptureTypedDict]
|
|
135
|
+
] = None,
|
|
136
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
137
|
+
server_url: Optional[str] = None,
|
|
138
|
+
timeout_ms: Optional[int] = None,
|
|
139
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
140
|
+
) -> models.CaptureResponse:
|
|
141
|
+
r"""Create capture
|
|
142
|
+
|
|
143
|
+
Capture an *authorized* payment.
|
|
144
|
+
|
|
145
|
+
Some payment methods allow you to first collect a customer's authorization,
|
|
146
|
+
and capture the amount at a later point.
|
|
147
|
+
|
|
148
|
+
By default, Mollie captures payments automatically. If however you
|
|
149
|
+
configured your payment with `captureMode: manual`, you can capture the payment using this endpoint after
|
|
150
|
+
having collected the customer's authorization.
|
|
151
|
+
|
|
152
|
+
:param payment_id: Provide the ID of the related payment.
|
|
153
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
154
|
+
:param entity_capture:
|
|
155
|
+
:param retries: Override the default retry configuration for this method
|
|
156
|
+
:param server_url: Override the default server URL for this method
|
|
157
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
158
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
159
|
+
"""
|
|
160
|
+
base_url = None
|
|
161
|
+
url_variables = None
|
|
162
|
+
if timeout_ms is None:
|
|
163
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
164
|
+
|
|
165
|
+
if server_url is not None:
|
|
166
|
+
base_url = server_url
|
|
167
|
+
else:
|
|
168
|
+
base_url = self._get_url(base_url, url_variables)
|
|
169
|
+
|
|
170
|
+
request = models.CreateCaptureRequest(
|
|
171
|
+
payment_id=payment_id,
|
|
172
|
+
idempotency_key=idempotency_key,
|
|
173
|
+
entity_capture=utils.get_pydantic_model(
|
|
174
|
+
entity_capture, Optional[models.EntityCapture]
|
|
175
|
+
),
|
|
176
|
+
)
|
|
177
|
+
|
|
178
|
+
req = self._build_request_async(
|
|
179
|
+
method="POST",
|
|
180
|
+
path="/payments/{paymentId}/captures",
|
|
181
|
+
base_url=base_url,
|
|
182
|
+
url_variables=url_variables,
|
|
183
|
+
request=request,
|
|
184
|
+
request_body_required=False,
|
|
185
|
+
request_has_path_params=True,
|
|
186
|
+
request_has_query_params=True,
|
|
187
|
+
user_agent_header="user-agent",
|
|
188
|
+
accept_header_value="application/hal+json",
|
|
189
|
+
http_headers=http_headers,
|
|
190
|
+
security=self.sdk_configuration.security,
|
|
191
|
+
get_serialized_body=lambda: utils.serialize_request_body(
|
|
192
|
+
request.entity_capture,
|
|
193
|
+
False,
|
|
194
|
+
True,
|
|
195
|
+
"json",
|
|
196
|
+
Optional[models.EntityCapture],
|
|
197
|
+
),
|
|
198
|
+
timeout_ms=timeout_ms,
|
|
199
|
+
)
|
|
200
|
+
|
|
201
|
+
if retries == UNSET:
|
|
202
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
203
|
+
retries = self.sdk_configuration.retry_config
|
|
204
|
+
else:
|
|
205
|
+
retries = utils.RetryConfig(
|
|
206
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
207
|
+
)
|
|
208
|
+
|
|
209
|
+
retry_config = None
|
|
210
|
+
if isinstance(retries, utils.RetryConfig):
|
|
211
|
+
retry_config = (retries, ["5xx"])
|
|
212
|
+
|
|
213
|
+
http_res = await self.do_request_async(
|
|
214
|
+
hook_ctx=HookContext(
|
|
215
|
+
config=self.sdk_configuration,
|
|
216
|
+
base_url=base_url or "",
|
|
217
|
+
operation_id="create-capture",
|
|
218
|
+
oauth2_scopes=None,
|
|
219
|
+
security_source=get_security_from_env(
|
|
220
|
+
self.sdk_configuration.security, models.Security
|
|
221
|
+
),
|
|
222
|
+
),
|
|
223
|
+
request=req,
|
|
224
|
+
error_status_codes=["404", "422", "4XX", "5XX"],
|
|
225
|
+
retry_config=retry_config,
|
|
226
|
+
)
|
|
227
|
+
|
|
228
|
+
response_data: Any = None
|
|
229
|
+
if utils.match_response(http_res, "201", "application/hal+json"):
|
|
230
|
+
return unmarshal_json_response(models.CaptureResponse, http_res)
|
|
231
|
+
if utils.match_response(http_res, ["404", "422"], "application/hal+json"):
|
|
232
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
233
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
234
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
235
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
236
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
237
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
238
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
239
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
240
|
+
|
|
241
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
242
|
+
|
|
243
|
+
def list(
|
|
244
|
+
self,
|
|
245
|
+
*,
|
|
246
|
+
payment_id: str,
|
|
247
|
+
from_: Optional[str] = None,
|
|
248
|
+
limit: OptionalNullable[int] = UNSET,
|
|
249
|
+
embed: OptionalNullable[str] = UNSET,
|
|
250
|
+
testmode: Optional[bool] = None,
|
|
251
|
+
idempotency_key: Optional[str] = None,
|
|
252
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
253
|
+
server_url: Optional[str] = None,
|
|
254
|
+
timeout_ms: Optional[int] = None,
|
|
255
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
256
|
+
) -> models.ListCapturesResponse:
|
|
257
|
+
r"""List captures
|
|
258
|
+
|
|
259
|
+
Retrieve a list of all captures created for a specific payment.
|
|
260
|
+
|
|
261
|
+
The results are paginated.
|
|
262
|
+
|
|
263
|
+
:param payment_id: Provide the ID of the related payment.
|
|
264
|
+
:param from_: Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
|
|
265
|
+
:param limit: The maximum number of items to return. Defaults to 50 items.
|
|
266
|
+
:param embed: This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter.
|
|
267
|
+
: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.
|
|
268
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
269
|
+
:param retries: Override the default retry configuration for this method
|
|
270
|
+
:param server_url: Override the default server URL for this method
|
|
271
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
272
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
273
|
+
"""
|
|
274
|
+
base_url = None
|
|
275
|
+
url_variables = None
|
|
276
|
+
if timeout_ms is None:
|
|
277
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
278
|
+
|
|
279
|
+
if server_url is not None:
|
|
280
|
+
base_url = server_url
|
|
281
|
+
else:
|
|
282
|
+
base_url = self._get_url(base_url, url_variables)
|
|
283
|
+
|
|
284
|
+
request = models.ListCapturesRequest(
|
|
285
|
+
payment_id=payment_id,
|
|
286
|
+
from_=from_,
|
|
287
|
+
limit=limit,
|
|
288
|
+
embed=embed,
|
|
289
|
+
testmode=testmode,
|
|
290
|
+
idempotency_key=idempotency_key,
|
|
291
|
+
)
|
|
292
|
+
|
|
293
|
+
req = self._build_request(
|
|
294
|
+
method="GET",
|
|
295
|
+
path="/payments/{paymentId}/captures",
|
|
296
|
+
base_url=base_url,
|
|
297
|
+
url_variables=url_variables,
|
|
298
|
+
request=request,
|
|
299
|
+
request_body_required=False,
|
|
300
|
+
request_has_path_params=True,
|
|
301
|
+
request_has_query_params=True,
|
|
302
|
+
user_agent_header="user-agent",
|
|
303
|
+
accept_header_value="application/hal+json",
|
|
304
|
+
http_headers=http_headers,
|
|
305
|
+
_globals=models.ListCapturesGlobals(
|
|
306
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
307
|
+
),
|
|
308
|
+
security=self.sdk_configuration.security,
|
|
309
|
+
timeout_ms=timeout_ms,
|
|
310
|
+
)
|
|
311
|
+
|
|
312
|
+
if retries == UNSET:
|
|
313
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
314
|
+
retries = self.sdk_configuration.retry_config
|
|
315
|
+
else:
|
|
316
|
+
retries = utils.RetryConfig(
|
|
317
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
318
|
+
)
|
|
319
|
+
|
|
320
|
+
retry_config = None
|
|
321
|
+
if isinstance(retries, utils.RetryConfig):
|
|
322
|
+
retry_config = (retries, ["5xx"])
|
|
323
|
+
|
|
324
|
+
http_res = self.do_request(
|
|
325
|
+
hook_ctx=HookContext(
|
|
326
|
+
config=self.sdk_configuration,
|
|
327
|
+
base_url=base_url or "",
|
|
328
|
+
operation_id="list-captures",
|
|
329
|
+
oauth2_scopes=None,
|
|
330
|
+
security_source=get_security_from_env(
|
|
331
|
+
self.sdk_configuration.security, models.Security
|
|
332
|
+
),
|
|
333
|
+
),
|
|
334
|
+
request=req,
|
|
335
|
+
error_status_codes=["400", "404", "4XX", "5XX"],
|
|
336
|
+
retry_config=retry_config,
|
|
337
|
+
)
|
|
338
|
+
|
|
339
|
+
response_data: Any = None
|
|
340
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
341
|
+
return unmarshal_json_response(models.ListCapturesResponse, http_res)
|
|
342
|
+
if utils.match_response(http_res, ["400", "404"], "application/hal+json"):
|
|
343
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
344
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
345
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
346
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
347
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
348
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
349
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
350
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
351
|
+
|
|
352
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
353
|
+
|
|
354
|
+
async def list_async(
|
|
355
|
+
self,
|
|
356
|
+
*,
|
|
357
|
+
payment_id: str,
|
|
358
|
+
from_: Optional[str] = None,
|
|
359
|
+
limit: OptionalNullable[int] = UNSET,
|
|
360
|
+
embed: OptionalNullable[str] = UNSET,
|
|
361
|
+
testmode: Optional[bool] = None,
|
|
362
|
+
idempotency_key: Optional[str] = None,
|
|
363
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
364
|
+
server_url: Optional[str] = None,
|
|
365
|
+
timeout_ms: Optional[int] = None,
|
|
366
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
367
|
+
) -> models.ListCapturesResponse:
|
|
368
|
+
r"""List captures
|
|
369
|
+
|
|
370
|
+
Retrieve a list of all captures created for a specific payment.
|
|
371
|
+
|
|
372
|
+
The results are paginated.
|
|
373
|
+
|
|
374
|
+
:param payment_id: Provide the ID of the related payment.
|
|
375
|
+
:param from_: Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
|
|
376
|
+
:param limit: The maximum number of items to return. Defaults to 50 items.
|
|
377
|
+
:param embed: This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter.
|
|
378
|
+
: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.
|
|
379
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
380
|
+
:param retries: Override the default retry configuration for this method
|
|
381
|
+
:param server_url: Override the default server URL for this method
|
|
382
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
383
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
384
|
+
"""
|
|
385
|
+
base_url = None
|
|
386
|
+
url_variables = None
|
|
387
|
+
if timeout_ms is None:
|
|
388
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
389
|
+
|
|
390
|
+
if server_url is not None:
|
|
391
|
+
base_url = server_url
|
|
392
|
+
else:
|
|
393
|
+
base_url = self._get_url(base_url, url_variables)
|
|
394
|
+
|
|
395
|
+
request = models.ListCapturesRequest(
|
|
396
|
+
payment_id=payment_id,
|
|
397
|
+
from_=from_,
|
|
398
|
+
limit=limit,
|
|
399
|
+
embed=embed,
|
|
400
|
+
testmode=testmode,
|
|
401
|
+
idempotency_key=idempotency_key,
|
|
402
|
+
)
|
|
403
|
+
|
|
404
|
+
req = self._build_request_async(
|
|
405
|
+
method="GET",
|
|
406
|
+
path="/payments/{paymentId}/captures",
|
|
407
|
+
base_url=base_url,
|
|
408
|
+
url_variables=url_variables,
|
|
409
|
+
request=request,
|
|
410
|
+
request_body_required=False,
|
|
411
|
+
request_has_path_params=True,
|
|
412
|
+
request_has_query_params=True,
|
|
413
|
+
user_agent_header="user-agent",
|
|
414
|
+
accept_header_value="application/hal+json",
|
|
415
|
+
http_headers=http_headers,
|
|
416
|
+
_globals=models.ListCapturesGlobals(
|
|
417
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
418
|
+
),
|
|
419
|
+
security=self.sdk_configuration.security,
|
|
420
|
+
timeout_ms=timeout_ms,
|
|
421
|
+
)
|
|
422
|
+
|
|
423
|
+
if retries == UNSET:
|
|
424
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
425
|
+
retries = self.sdk_configuration.retry_config
|
|
426
|
+
else:
|
|
427
|
+
retries = utils.RetryConfig(
|
|
428
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
429
|
+
)
|
|
430
|
+
|
|
431
|
+
retry_config = None
|
|
432
|
+
if isinstance(retries, utils.RetryConfig):
|
|
433
|
+
retry_config = (retries, ["5xx"])
|
|
434
|
+
|
|
435
|
+
http_res = await self.do_request_async(
|
|
436
|
+
hook_ctx=HookContext(
|
|
437
|
+
config=self.sdk_configuration,
|
|
438
|
+
base_url=base_url or "",
|
|
439
|
+
operation_id="list-captures",
|
|
440
|
+
oauth2_scopes=None,
|
|
441
|
+
security_source=get_security_from_env(
|
|
442
|
+
self.sdk_configuration.security, models.Security
|
|
443
|
+
),
|
|
444
|
+
),
|
|
445
|
+
request=req,
|
|
446
|
+
error_status_codes=["400", "404", "4XX", "5XX"],
|
|
447
|
+
retry_config=retry_config,
|
|
448
|
+
)
|
|
449
|
+
|
|
450
|
+
response_data: Any = None
|
|
451
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
452
|
+
return unmarshal_json_response(models.ListCapturesResponse, http_res)
|
|
453
|
+
if utils.match_response(http_res, ["400", "404"], "application/hal+json"):
|
|
454
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
455
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
456
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
457
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
458
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
459
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
460
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
461
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
462
|
+
|
|
463
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
464
|
+
|
|
465
|
+
def get(
|
|
466
|
+
self,
|
|
467
|
+
*,
|
|
468
|
+
payment_id: str,
|
|
469
|
+
capture_id: str,
|
|
470
|
+
embed: OptionalNullable[str] = UNSET,
|
|
471
|
+
testmode: Optional[bool] = None,
|
|
472
|
+
idempotency_key: Optional[str] = None,
|
|
473
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
474
|
+
server_url: Optional[str] = None,
|
|
475
|
+
timeout_ms: Optional[int] = None,
|
|
476
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
477
|
+
) -> models.CaptureResponse:
|
|
478
|
+
r"""Get capture
|
|
479
|
+
|
|
480
|
+
Retrieve a single payment capture by its ID and the ID of its parent
|
|
481
|
+
payment.
|
|
482
|
+
|
|
483
|
+
:param payment_id: Provide the ID of the related payment.
|
|
484
|
+
:param capture_id: Provide the ID of the related capture.
|
|
485
|
+
:param embed: This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter.
|
|
486
|
+
: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.
|
|
487
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
488
|
+
:param retries: Override the default retry configuration for this method
|
|
489
|
+
:param server_url: Override the default server URL for this method
|
|
490
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
491
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
492
|
+
"""
|
|
493
|
+
base_url = None
|
|
494
|
+
url_variables = None
|
|
495
|
+
if timeout_ms is None:
|
|
496
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
497
|
+
|
|
498
|
+
if server_url is not None:
|
|
499
|
+
base_url = server_url
|
|
500
|
+
else:
|
|
501
|
+
base_url = self._get_url(base_url, url_variables)
|
|
502
|
+
|
|
503
|
+
request = models.GetCaptureRequest(
|
|
504
|
+
payment_id=payment_id,
|
|
505
|
+
capture_id=capture_id,
|
|
506
|
+
embed=embed,
|
|
507
|
+
testmode=testmode,
|
|
508
|
+
idempotency_key=idempotency_key,
|
|
509
|
+
)
|
|
510
|
+
|
|
511
|
+
req = self._build_request(
|
|
512
|
+
method="GET",
|
|
513
|
+
path="/payments/{paymentId}/captures/{captureId}",
|
|
514
|
+
base_url=base_url,
|
|
515
|
+
url_variables=url_variables,
|
|
516
|
+
request=request,
|
|
517
|
+
request_body_required=False,
|
|
518
|
+
request_has_path_params=True,
|
|
519
|
+
request_has_query_params=True,
|
|
520
|
+
user_agent_header="user-agent",
|
|
521
|
+
accept_header_value="application/hal+json",
|
|
522
|
+
http_headers=http_headers,
|
|
523
|
+
_globals=models.GetCaptureGlobals(
|
|
524
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
525
|
+
),
|
|
526
|
+
security=self.sdk_configuration.security,
|
|
527
|
+
timeout_ms=timeout_ms,
|
|
528
|
+
)
|
|
529
|
+
|
|
530
|
+
if retries == UNSET:
|
|
531
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
532
|
+
retries = self.sdk_configuration.retry_config
|
|
533
|
+
else:
|
|
534
|
+
retries = utils.RetryConfig(
|
|
535
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
536
|
+
)
|
|
537
|
+
|
|
538
|
+
retry_config = None
|
|
539
|
+
if isinstance(retries, utils.RetryConfig):
|
|
540
|
+
retry_config = (retries, ["5xx"])
|
|
541
|
+
|
|
542
|
+
http_res = self.do_request(
|
|
543
|
+
hook_ctx=HookContext(
|
|
544
|
+
config=self.sdk_configuration,
|
|
545
|
+
base_url=base_url or "",
|
|
546
|
+
operation_id="get-capture",
|
|
547
|
+
oauth2_scopes=None,
|
|
548
|
+
security_source=get_security_from_env(
|
|
549
|
+
self.sdk_configuration.security, models.Security
|
|
550
|
+
),
|
|
551
|
+
),
|
|
552
|
+
request=req,
|
|
553
|
+
error_status_codes=["404", "4XX", "5XX"],
|
|
554
|
+
retry_config=retry_config,
|
|
555
|
+
)
|
|
556
|
+
|
|
557
|
+
response_data: Any = None
|
|
558
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
559
|
+
return unmarshal_json_response(models.CaptureResponse, http_res)
|
|
560
|
+
if utils.match_response(http_res, "404", "application/hal+json"):
|
|
561
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
562
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
563
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
564
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
565
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
566
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
567
|
+
http_res_text = utils.stream_to_text(http_res)
|
|
568
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
569
|
+
|
|
570
|
+
raise models.APIError("Unexpected response received", http_res)
|
|
571
|
+
|
|
572
|
+
async def get_async(
|
|
573
|
+
self,
|
|
574
|
+
*,
|
|
575
|
+
payment_id: str,
|
|
576
|
+
capture_id: str,
|
|
577
|
+
embed: OptionalNullable[str] = UNSET,
|
|
578
|
+
testmode: Optional[bool] = None,
|
|
579
|
+
idempotency_key: Optional[str] = None,
|
|
580
|
+
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
581
|
+
server_url: Optional[str] = None,
|
|
582
|
+
timeout_ms: Optional[int] = None,
|
|
583
|
+
http_headers: Optional[Mapping[str, str]] = None,
|
|
584
|
+
) -> models.CaptureResponse:
|
|
585
|
+
r"""Get capture
|
|
586
|
+
|
|
587
|
+
Retrieve a single payment capture by its ID and the ID of its parent
|
|
588
|
+
payment.
|
|
589
|
+
|
|
590
|
+
:param payment_id: Provide the ID of the related payment.
|
|
591
|
+
:param capture_id: Provide the ID of the related capture.
|
|
592
|
+
:param embed: This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter.
|
|
593
|
+
: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.
|
|
594
|
+
:param idempotency_key: A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
595
|
+
:param retries: Override the default retry configuration for this method
|
|
596
|
+
:param server_url: Override the default server URL for this method
|
|
597
|
+
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
598
|
+
:param http_headers: Additional headers to set or replace on requests.
|
|
599
|
+
"""
|
|
600
|
+
base_url = None
|
|
601
|
+
url_variables = None
|
|
602
|
+
if timeout_ms is None:
|
|
603
|
+
timeout_ms = self.sdk_configuration.timeout_ms
|
|
604
|
+
|
|
605
|
+
if server_url is not None:
|
|
606
|
+
base_url = server_url
|
|
607
|
+
else:
|
|
608
|
+
base_url = self._get_url(base_url, url_variables)
|
|
609
|
+
|
|
610
|
+
request = models.GetCaptureRequest(
|
|
611
|
+
payment_id=payment_id,
|
|
612
|
+
capture_id=capture_id,
|
|
613
|
+
embed=embed,
|
|
614
|
+
testmode=testmode,
|
|
615
|
+
idempotency_key=idempotency_key,
|
|
616
|
+
)
|
|
617
|
+
|
|
618
|
+
req = self._build_request_async(
|
|
619
|
+
method="GET",
|
|
620
|
+
path="/payments/{paymentId}/captures/{captureId}",
|
|
621
|
+
base_url=base_url,
|
|
622
|
+
url_variables=url_variables,
|
|
623
|
+
request=request,
|
|
624
|
+
request_body_required=False,
|
|
625
|
+
request_has_path_params=True,
|
|
626
|
+
request_has_query_params=True,
|
|
627
|
+
user_agent_header="user-agent",
|
|
628
|
+
accept_header_value="application/hal+json",
|
|
629
|
+
http_headers=http_headers,
|
|
630
|
+
_globals=models.GetCaptureGlobals(
|
|
631
|
+
testmode=self.sdk_configuration.globals.testmode,
|
|
632
|
+
),
|
|
633
|
+
security=self.sdk_configuration.security,
|
|
634
|
+
timeout_ms=timeout_ms,
|
|
635
|
+
)
|
|
636
|
+
|
|
637
|
+
if retries == UNSET:
|
|
638
|
+
if self.sdk_configuration.retry_config is not UNSET:
|
|
639
|
+
retries = self.sdk_configuration.retry_config
|
|
640
|
+
else:
|
|
641
|
+
retries = utils.RetryConfig(
|
|
642
|
+
"backoff", utils.BackoffStrategy(500, 5000, 2, 7500), True
|
|
643
|
+
)
|
|
644
|
+
|
|
645
|
+
retry_config = None
|
|
646
|
+
if isinstance(retries, utils.RetryConfig):
|
|
647
|
+
retry_config = (retries, ["5xx"])
|
|
648
|
+
|
|
649
|
+
http_res = await self.do_request_async(
|
|
650
|
+
hook_ctx=HookContext(
|
|
651
|
+
config=self.sdk_configuration,
|
|
652
|
+
base_url=base_url or "",
|
|
653
|
+
operation_id="get-capture",
|
|
654
|
+
oauth2_scopes=None,
|
|
655
|
+
security_source=get_security_from_env(
|
|
656
|
+
self.sdk_configuration.security, models.Security
|
|
657
|
+
),
|
|
658
|
+
),
|
|
659
|
+
request=req,
|
|
660
|
+
error_status_codes=["404", "4XX", "5XX"],
|
|
661
|
+
retry_config=retry_config,
|
|
662
|
+
)
|
|
663
|
+
|
|
664
|
+
response_data: Any = None
|
|
665
|
+
if utils.match_response(http_res, "200", "application/hal+json"):
|
|
666
|
+
return unmarshal_json_response(models.CaptureResponse, http_res)
|
|
667
|
+
if utils.match_response(http_res, "404", "application/hal+json"):
|
|
668
|
+
response_data = unmarshal_json_response(models.ErrorResponseData, http_res)
|
|
669
|
+
raise models.ErrorResponse(response_data, http_res)
|
|
670
|
+
if utils.match_response(http_res, "4XX", "*"):
|
|
671
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
672
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
673
|
+
if utils.match_response(http_res, "5XX", "*"):
|
|
674
|
+
http_res_text = await utils.stream_to_text_async(http_res)
|
|
675
|
+
raise models.APIError("API error occurred", http_res, http_res_text)
|
|
676
|
+
|
|
677
|
+
raise models.APIError("Unexpected response received", http_res)
|