hexpay 0.0.2__tar.gz → 0.0.3__tar.gz

{hexpay-0.0.2 → hexpay-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: hexpay
-Version: 0.0.2
+Version: 0.0.3
 Summary: Official Python SDK for the HexPay Merchant API (TON cryptocurrency payments).
 Project-URL: Homepage, https://hexpay.io
 Project-URL: Documentation, https://docs.hexpay.io
@@ -86,7 +86,7 @@ from environment variables, a secrets manager, or your config layer.
 
 ## Idempotency
 
-Every `POST` request requires a UUID v4 `X-Idempotency-Key`. The SDK exposes it as
+`POST` requests accept an optional `X-Idempotency-Key` (UUID). The SDK exposes it as
 the `x_idempotency_key` argument on every mutating operation.
 
 **Reuse the same key when retrying** a failed request — the server returns the

{hexpay-0.0.2 → hexpay-0.0.3}/README.md

@@ -60,7 +60,7 @@ from environment variables, a secrets manager, or your config layer.
 
 ## Idempotency
 
-Every `POST` request requires a UUID v4 `X-Idempotency-Key`. The SDK exposes it as
+`POST` requests accept an optional `X-Idempotency-Key` (UUID). The SDK exposes it as
 the `x_idempotency_key` argument on every mutating operation.
 
 **Reuse the same key when retrying** a failed request — the server returns the

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/api/payment_methods/list_payment_methods.py

@@ -64,11 +64,15 @@ def sync_detailed(
 ) -> Response[ErrorResponse | PaymentMethodListResponse]:
     """List payment methods
 
-     Retrieves all payment methods enabled for your store. Each entry represents
-    a unique coin + chain combination that your store accepts.
+     Retrieves the payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts. Use it, for example,
+    to show available payment options on your website.
+
+    Only your store's enabled methods are returned, not every coin supported by
+    HexPay.
 
     Use `coin.symbol` and `chain.symbol` values from this response as inputs for
-    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+    the `coin` and `chain` fields in `paymentOptions.methods` when creating a payment.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -93,11 +97,15 @@ def sync(
 ) -> ErrorResponse | PaymentMethodListResponse | None:
     """List payment methods
 
-     Retrieves all payment methods enabled for your store. Each entry represents
-    a unique coin + chain combination that your store accepts.
+     Retrieves the payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts. Use it, for example,
+    to show available payment options on your website.
+
+    Only your store's enabled methods are returned, not every coin supported by
+    HexPay.
 
     Use `coin.symbol` and `chain.symbol` values from this response as inputs for
-    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+    the `coin` and `chain` fields in `paymentOptions.methods` when creating a payment.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -118,11 +126,15 @@ async def asyncio_detailed(
 ) -> Response[ErrorResponse | PaymentMethodListResponse]:
     """List payment methods
 
-     Retrieves all payment methods enabled for your store. Each entry represents
-    a unique coin + chain combination that your store accepts.
+     Retrieves the payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts. Use it, for example,
+    to show available payment options on your website.
+
+    Only your store's enabled methods are returned, not every coin supported by
+    HexPay.
 
     Use `coin.symbol` and `chain.symbol` values from this response as inputs for
-    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+    the `coin` and `chain` fields in `paymentOptions.methods` when creating a payment.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -145,11 +157,15 @@ async def asyncio(
 ) -> ErrorResponse | PaymentMethodListResponse | None:
     """List payment methods
 
-     Retrieves all payment methods enabled for your store. Each entry represents
-    a unique coin + chain combination that your store accepts.
+     Retrieves the payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts. Use it, for example,
+    to show available payment options on your website.
+
+    Only your store's enabled methods are returned, not every coin supported by
+    HexPay.
 
     Use `coin.symbol` and `chain.symbol` values from this response as inputs for
-    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+    the `coin` and `chain` fields in `paymentOptions.methods` when creating a payment.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/api/payments/cancel_payment.py

@@ -88,7 +88,8 @@ def sync_detailed(
 ) -> Response[ErrorResponse | PaymentCancelResponse]:
     """Cancel a payment
 
-     Cancels a payment and returns the updated status `cancelled`.
+     Cancels a payment. The response contains only the new status, `cancelled`.
+    Use `GET /v1/payments/{paymentId}` if you need the full payment object.
 
     Cancellation is permitted from `created` or `pending` status only. Payments
     already in a terminal state (`completed`, `expired`, or `cancelled`) cannot
@@ -126,7 +127,8 @@ def sync(
 ) -> ErrorResponse | PaymentCancelResponse | None:
     """Cancel a payment
 
-     Cancels a payment and returns the updated status `cancelled`.
+     Cancels a payment. The response contains only the new status, `cancelled`.
+    Use `GET /v1/payments/{paymentId}` if you need the full payment object.
 
     Cancellation is permitted from `created` or `pending` status only. Payments
     already in a terminal state (`completed`, `expired`, or `cancelled`) cannot
@@ -159,7 +161,8 @@ async def asyncio_detailed(
 ) -> Response[ErrorResponse | PaymentCancelResponse]:
     """Cancel a payment
 
-     Cancels a payment and returns the updated status `cancelled`.
+     Cancels a payment. The response contains only the new status, `cancelled`.
+    Use `GET /v1/payments/{paymentId}` if you need the full payment object.
 
     Cancellation is permitted from `created` or `pending` status only. Payments
     already in a terminal state (`completed`, `expired`, or `cancelled`) cannot
@@ -195,7 +198,8 @@ async def asyncio(
 ) -> ErrorResponse | PaymentCancelResponse | None:
     """Cancel a payment
 
-     Cancels a payment and returns the updated status `cancelled`.
+     Cancels a payment. The response contains only the new status, `cancelled`.
+    Use `GET /v1/payments/{paymentId}` if you need the full payment object.
 
     Cancellation is permitted from `created` or `pending` status only. Payments
     already in a terminal state (`completed`, `expired`, or `cancelled`) cannot

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/api/payments/create_payment.py

@@ -105,19 +105,20 @@ def sync_detailed(
     ---
 
     ### Preselected
-    Pass `payment_options.methods` with **exactly one entry** containing **both** `coin`
-    and `chain`. The server resolves the address immediately and returns the payment in
-    `pending` status with `paymentDetails` populated. The customer proceeds straight to
-    the deposit screen without any method selection step.
+    Pass `paymentOptions.methods` with **exactly one entry** containing **both** `coin`
+    and `chain`. HexPay selects this method on behalf of the customer, resolves the
+    address immediately and returns the payment in `pending` status with
+    `paymentDetails` populated. The customer proceeds straight to the deposit screen
+    without any method selection step.
 
     ### Customer Choice
-    Omit `payment_options`. All store-enabled payment methods are offered to the customer
+    Omit `paymentOptions`. All store-enabled payment methods are offered to the customer
     at checkout. The payment starts in `created` status.
 
     ---
 
     ### Supported combinations
-    | `currency` | `payment_options.methods`          | Initial status | `paymentDetails` |
+    | `currency` | `paymentOptions.methods`           | Initial status | `paymentDetails` |
     |------------|------------------------------------|----------------|------------------|
     | `USD`      | *(omitted)*                        | `created`      | absent           |
     | `TON`      | *(omitted)*                        | `created`      | absent           |
@@ -130,8 +131,8 @@ def sync_detailed(
         body (CreatePaymentRequest): Request body for creating a new payment. The body is
             intentionally flat:
             `amount`, `currency`, and all optional fields are top-level. The only nested
-            structure is `payment_options.methods`, which describes an allowlist of
-            acceptable payment methods.
+            structure is `paymentOptions.methods`, which restricts the payment methods
+            offered to the customer.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -170,19 +171,20 @@ def sync(
     ---
 
     ### Preselected
-    Pass `payment_options.methods` with **exactly one entry** containing **both** `coin`
-    and `chain`. The server resolves the address immediately and returns the payment in
-    `pending` status with `paymentDetails` populated. The customer proceeds straight to
-    the deposit screen without any method selection step.
+    Pass `paymentOptions.methods` with **exactly one entry** containing **both** `coin`
+    and `chain`. HexPay selects this method on behalf of the customer, resolves the
+    address immediately and returns the payment in `pending` status with
+    `paymentDetails` populated. The customer proceeds straight to the deposit screen
+    without any method selection step.
 
     ### Customer Choice
-    Omit `payment_options`. All store-enabled payment methods are offered to the customer
+    Omit `paymentOptions`. All store-enabled payment methods are offered to the customer
     at checkout. The payment starts in `created` status.
 
     ---
 
     ### Supported combinations
-    | `currency` | `payment_options.methods`          | Initial status | `paymentDetails` |
+    | `currency` | `paymentOptions.methods`           | Initial status | `paymentDetails` |
     |------------|------------------------------------|----------------|------------------|
     | `USD`      | *(omitted)*                        | `created`      | absent           |
     | `TON`      | *(omitted)*                        | `created`      | absent           |
@@ -195,8 +197,8 @@ def sync(
         body (CreatePaymentRequest): Request body for creating a new payment. The body is
             intentionally flat:
             `amount`, `currency`, and all optional fields are top-level. The only nested
-            structure is `payment_options.methods`, which describes an allowlist of
-            acceptable payment methods.
+            structure is `paymentOptions.methods`, which restricts the payment methods
+            offered to the customer.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -230,19 +232,20 @@ async def asyncio_detailed(
     ---
 
     ### Preselected
-    Pass `payment_options.methods` with **exactly one entry** containing **both** `coin`
-    and `chain`. The server resolves the address immediately and returns the payment in
-    `pending` status with `paymentDetails` populated. The customer proceeds straight to
-    the deposit screen without any method selection step.
+    Pass `paymentOptions.methods` with **exactly one entry** containing **both** `coin`
+    and `chain`. HexPay selects this method on behalf of the customer, resolves the
+    address immediately and returns the payment in `pending` status with
+    `paymentDetails` populated. The customer proceeds straight to the deposit screen
+    without any method selection step.
 
     ### Customer Choice
-    Omit `payment_options`. All store-enabled payment methods are offered to the customer
+    Omit `paymentOptions`. All store-enabled payment methods are offered to the customer
     at checkout. The payment starts in `created` status.
 
     ---
 
     ### Supported combinations
-    | `currency` | `payment_options.methods`          | Initial status | `paymentDetails` |
+    | `currency` | `paymentOptions.methods`           | Initial status | `paymentDetails` |
     |------------|------------------------------------|----------------|------------------|
     | `USD`      | *(omitted)*                        | `created`      | absent           |
     | `TON`      | *(omitted)*                        | `created`      | absent           |
@@ -255,8 +258,8 @@ async def asyncio_detailed(
         body (CreatePaymentRequest): Request body for creating a new payment. The body is
             intentionally flat:
             `amount`, `currency`, and all optional fields are top-level. The only nested
-            structure is `payment_options.methods`, which describes an allowlist of
-            acceptable payment methods.
+            structure is `paymentOptions.methods`, which restricts the payment methods
+            offered to the customer.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -293,19 +296,20 @@ async def asyncio(
     ---
 
     ### Preselected
-    Pass `payment_options.methods` with **exactly one entry** containing **both** `coin`
-    and `chain`. The server resolves the address immediately and returns the payment in
-    `pending` status with `paymentDetails` populated. The customer proceeds straight to
-    the deposit screen without any method selection step.
+    Pass `paymentOptions.methods` with **exactly one entry** containing **both** `coin`
+    and `chain`. HexPay selects this method on behalf of the customer, resolves the
+    address immediately and returns the payment in `pending` status with
+    `paymentDetails` populated. The customer proceeds straight to the deposit screen
+    without any method selection step.
 
     ### Customer Choice
-    Omit `payment_options`. All store-enabled payment methods are offered to the customer
+    Omit `paymentOptions`. All store-enabled payment methods are offered to the customer
     at checkout. The payment starts in `created` status.
 
     ---
 
     ### Supported combinations
-    | `currency` | `payment_options.methods`          | Initial status | `paymentDetails` |
+    | `currency` | `paymentOptions.methods`           | Initial status | `paymentDetails` |
     |------------|------------------------------------|----------------|------------------|
     | `USD`      | *(omitted)*                        | `created`      | absent           |
     | `TON`      | *(omitted)*                        | `created`      | absent           |
@@ -318,8 +322,8 @@ async def asyncio(
         body (CreatePaymentRequest): Request body for creating a new payment. The body is
             intentionally flat:
             `amount`, `currency`, and all optional fields are top-level. The only nested
-            structure is `payment_options.methods`, which describes an allowlist of
-            acceptable payment methods.
+            structure is `paymentOptions.methods`, which restricts the payment methods
+            offered to the customer.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/api/payments/list_payments.py

@@ -108,8 +108,7 @@ def sync_detailed(
 
     Args:
         limit (int | Unset):  Default: 10. Example: 20.
-        cursor (str | Unset):  Example:
-            eyJpZCI6IjAxOTMyN2M2LTIwNTgtNzkwMS1iMjM0LTU2Nzg5YWJjZGVmZiJ9.
+        cursor (str | Unset):  Example: 019327c6-1234-7901-b234-56789abcde00.
         status (list[PaymentStatus] | Unset):  Example: ['pending', 'completed'].
 
     Raises:
@@ -153,8 +152,7 @@ def sync(
 
     Args:
         limit (int | Unset):  Default: 10. Example: 20.
-        cursor (str | Unset):  Example:
-            eyJpZCI6IjAxOTMyN2M2LTIwNTgtNzkwMS1iMjM0LTU2Nzg5YWJjZGVmZiJ9.
+        cursor (str | Unset):  Example: 019327c6-1234-7901-b234-56789abcde00.
         status (list[PaymentStatus] | Unset):  Example: ['pending', 'completed'].
 
     Raises:
@@ -193,8 +191,7 @@ async def asyncio_detailed(
 
     Args:
         limit (int | Unset):  Default: 10. Example: 20.
-        cursor (str | Unset):  Example:
-            eyJpZCI6IjAxOTMyN2M2LTIwNTgtNzkwMS1iMjM0LTU2Nzg5YWJjZGVmZiJ9.
+        cursor (str | Unset):  Example: 019327c6-1234-7901-b234-56789abcde00.
         status (list[PaymentStatus] | Unset):  Example: ['pending', 'completed'].
 
     Raises:
@@ -236,8 +233,7 @@ async def asyncio(
 
     Args:
         limit (int | Unset):  Default: 10. Example: 20.
-        cursor (str | Unset):  Example:
-            eyJpZCI6IjAxOTMyN2M2LTIwNTgtNzkwMS1iMjM0LTU2Nzg5YWJjZGVmZiJ9.
+        cursor (str | Unset):  Example: 019327c6-1234-7901-b234-56789abcde00.
         status (list[PaymentStatus] | Unset):  Example: ['pending', 'completed'].
 
     Raises:

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/models/__init__.py

@@ -9,9 +9,9 @@ from .create_payment_request_metadata import CreatePaymentRequestMetadata
 from .error import Error
 from .error_response import ErrorResponse
 from .error_type import ErrorType
-from .method_filter import MethodFilter
-from .method_filter_chain import MethodFilterChain
-from .method_filter_coin import MethodFilterCoin
+from .method_restriction import MethodRestriction
+from .method_restriction_chain import MethodRestrictionChain
+from .method_restriction_coin import MethodRestrictionCoin
 from .payment_cancel_response import PaymentCancelResponse
 from .payment_details import PaymentDetails
 from .payment_list_response import PaymentListResponse
@@ -19,9 +19,14 @@ from .payment_method_list_response import PaymentMethodListResponse
 from .payment_method_response import PaymentMethodResponse
 from .payment_options import PaymentOptions
 from .payment_response import PaymentResponse
+from .payment_response_metadata import PaymentResponseMetadata
 from .payment_status import PaymentStatus
 from .payment_status_response import PaymentStatusResponse
 from .payment_timer_response import PaymentTimerResponse
+from .webhook_payload import WebhookPayload
+from .webhook_payload_metadata_type_0 import WebhookPayloadMetadataType0
+from .webhook_payload_status import WebhookPayloadStatus
+from .webhook_request import WebhookRequest
 
 __all__ = (
     "ChainResponse",
@@ -33,9 +38,9 @@ __all__ = (
     "Error",
     "ErrorResponse",
     "ErrorType",
-    "MethodFilter",
-    "MethodFilterChain",
-    "MethodFilterCoin",
+    "MethodRestriction",
+    "MethodRestrictionChain",
+    "MethodRestrictionCoin",
     "PaymentCancelResponse",
     "PaymentDetails",
     "PaymentListResponse",
@@ -43,7 +48,12 @@ __all__ = (
     "PaymentMethodResponse",
     "PaymentOptions",
     "PaymentResponse",
+    "PaymentResponseMetadata",
     "PaymentStatus",
     "PaymentStatusResponse",
     "PaymentTimerResponse",
+    "WebhookPayload",
+    "WebhookPayloadMetadataType0",
+    "WebhookPayloadStatus",
+    "WebhookRequest",
 )

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/models/chain_response.py

@@ -21,7 +21,7 @@ class ChainResponse:
     Attributes:
         name (str): Human-readable name of the blockchain network. Example: TON.
         symbol (ChainResponseSymbol): Ticker symbol. Use this value as the `chain` field in
-            `payment_options.methods` when creating payments.
+            `paymentOptions.methods` when creating payments.
              Example: TON.
         img_url (str): URL of the chain logo image. Example: https://assets.hexpay.io/chains/ton.svg.
     """

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/models/coin_response.py

@@ -21,7 +21,7 @@ class CoinResponse:
     Attributes:
         name (str): Human-readable name of the cryptocurrency. Example: Tether.
         symbol (CoinResponseSymbol): Ticker symbol. Use this value as the `coin` field in
-            `payment_options.methods` when creating payments.
+            `paymentOptions.methods` when creating payments.
              Example: USDT.
         img_url (str): URL of the coin logo image. Example: https://assets.hexpay.io/coins/usdt.svg.
     """

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/models/create_payment_request.py

@@ -23,26 +23,26 @@ T = TypeVar("T", bound="CreatePaymentRequest")
 class CreatePaymentRequest:
     """Request body for creating a new payment. The body is intentionally flat:
     `amount`, `currency`, and all optional fields are top-level. The only nested
-    structure is `payment_options.methods`, which describes an allowlist of
-    acceptable payment methods.
+    structure is `paymentOptions.methods`, which restricts the payment methods
+    offered to the customer.
 
         Attributes:
-            amount (str): The payment value as a positive decimal string. No leading zeros are
-                permitted on the integer part (`"007"` is invalid; use `"7"`).
+            amount (str): The payment value as a positive decimal string. Zero is not allowed.
+                No leading zeros are permitted on the integer part (`"007"` is invalid; use `"7"`).
                 For fiat currencies up to 2 decimal places are recommended.
                 For crypto tickers precision depends on the coin.
                  Example: 100.00.
-            currency (str): Ticker symbol for the denomination. Accepts fiat codes (e.g. `USD`, `EUR`,
-                `RUB`) or TON-ecosystem coin tickers (e.g. `TON`, `USDT`).
+            currency (str): Ticker symbol for the denomination. Accepts fiat codes (`USD`, `EUR`, `RUB`)
+                or TON-ecosystem coin tickers (`TON`, `USDT`, `NOT`, `DOGS`, `BUILD`, `BLUM`,
+                `DUST`, `DYOR`, `STON`, `XAUt0`).
 
                 This field defines the **unit of value** — it does not determine the coin
-                the customer pays with. Payment coin is controlled by `payment_options.methods`.
+                the customer pays with. Payment coin is controlled by `paymentOptions.methods`.
 
-                For the full list of accepted values use `GET /v1/payment-methods` (coins)
-                or refer to the supported fiat codes in your store settings.
+                Any supported ticker is accepted, regardless of which payment methods are
+                enabled for your store.
                  Example: USD.
-            payment_options (PaymentOptions | Unset): Optional constraints on which payment methods are available at
-                checkout.
+            payment_options (PaymentOptions | Unset): Optional restriction on which payment methods are offered at checkout.
                 When omitted entirely, all payment methods enabled for your store are shown
                 and the payment is created in `created` status.
             ttl (int | Unset): Time-to-live in seconds. Defines how long the payment remains active
@@ -54,27 +54,37 @@ class CreatePaymentRequest:
                  Default: 3600. Example: 3600.
             order_id (str | Unset): Merchant-defined external order identifier. Use this to correlate a HexPay
                 payment with your internal order or invoice system. Returned on all payment
-                objects and included in webhook payloads.
+                objects and included in the webhook payload.
                  Example: order-2026-00123.
             description (str | Unset): Human-readable description of the payment purpose. May be displayed to
                 the customer on the payment page.
                  Example: Premium subscription — 1 year.
             metadata (CreatePaymentRequestMetadata | Unset): Arbitrary key-value pairs for merchant use. All values must be
                 strings.
-                Returned on all payment objects and included in webhook payloads.
+                Returned on all payment objects and included in the webhook payload.
                 Maximum 10 keys; key names up to 64 characters, values up to 512 characters.
+                Keys are stored as provided and are not renamed.
                  Example: {'customer_id': 'cust_abc123', 'customer_email': 'customer@example.com'}.
-            webhook_url (str | Unset): HTTPS URL to which HexPay will POST webhook notifications for this
-                payment's lifecycle events (e.g., transitions to `pending` or `completed`).
+            webhook_url (str | Unset): HTTPS URL to which HexPay will POST a webhook notification when this
+                payment reaches `completed` status. No webhooks are sent for other statuses.
 
                 Requirements:
                 - Must use HTTPS. Plain HTTP URLs are rejected.
-                - Must be publicly reachable from the internet. Loopback addresses
-                  (`localhost`, `127.x.x.x`) and private network ranges (`10.x.x.x`,
-                  `192.168.x.x`, `172.16–31.x.x`) are not allowed.
+                - Must be publicly reachable from the internet. Non-public addresses are
+                  rejected, and host names that resolve to them are blocked at delivery time.
                 - Make sure your server is configured to accept POST requests at this URL
                   before creating payments.
                  Example: https://merchant.com/webhooks/hexpay.
+            redirect_url (str | Unset): HTTPS URL of your page (e.g. the order page) that the checkout page links to
+                once the payment is finished (`completed`, `expired` or `cancelled`), so the
+                customer can return to your store.
+
+                Requirements:
+                - Must be an absolute HTTPS URL. Plain HTTP and other schemes are rejected.
+                - Maximum 512 characters.
+
+                If omitted, the checkout page uses the default HexPay URL.
+                 Example: https://merchant.com/orders/order-2026-00123.
     """
 
     amount: str
@@ -85,6 +95,7 @@ class CreatePaymentRequest:
     description: str | Unset = UNSET
     metadata: CreatePaymentRequestMetadata | Unset = UNSET
     webhook_url: str | Unset = UNSET
+    redirect_url: str | Unset = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
@@ -111,6 +122,8 @@ class CreatePaymentRequest:
 
         webhook_url = self.webhook_url
 
+        redirect_url = self.redirect_url
+
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -120,17 +133,19 @@ class CreatePaymentRequest:
             }
         )
         if payment_options is not UNSET:
-            field_dict["payment_options"] = payment_options
+            field_dict["paymentOptions"] = payment_options
         if ttl is not UNSET:
             field_dict["ttl"] = ttl
         if order_id is not UNSET:
-            field_dict["order_id"] = order_id
+            field_dict["orderId"] = order_id
         if description is not UNSET:
             field_dict["description"] = description
         if metadata is not UNSET:
             field_dict["metadata"] = metadata
         if webhook_url is not UNSET:
-            field_dict["webhookURL"] = webhook_url
+            field_dict["webhookUrl"] = webhook_url
+        if redirect_url is not UNSET:
+            field_dict["redirectUrl"] = redirect_url
 
         return field_dict
 
@@ -144,7 +159,7 @@ class CreatePaymentRequest:
 
         currency = d.pop("currency")
 
-        _payment_options = d.pop("payment_options", UNSET)
+        _payment_options = d.pop("paymentOptions", UNSET)
         payment_options: PaymentOptions | Unset
         if isinstance(_payment_options, Unset):
             payment_options = UNSET
@@ -153,7 +168,7 @@ class CreatePaymentRequest:
 
         ttl = d.pop("ttl", UNSET)
 
-        order_id = d.pop("order_id", UNSET)
+        order_id = d.pop("orderId", UNSET)
 
         description = d.pop("description", UNSET)
 
@@ -164,7 +179,9 @@ class CreatePaymentRequest:
         else:
             metadata = CreatePaymentRequestMetadata.from_dict(_metadata)
 
-        webhook_url = d.pop("webhookURL", UNSET)
+        webhook_url = d.pop("webhookUrl", UNSET)
+
+        redirect_url = d.pop("redirectUrl", UNSET)
 
         create_payment_request = cls(
             amount=amount,
@@ -175,6 +192,7 @@ class CreatePaymentRequest:
             description=description,
             metadata=metadata,
             webhook_url=webhook_url,
+            redirect_url=redirect_url,
         )
 
         create_payment_request.additional_properties = d

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/models/create_payment_request_metadata.py

@@ -15,8 +15,9 @@ T = TypeVar("T", bound="CreatePaymentRequestMetadata")
 @_attrs_define
 class CreatePaymentRequestMetadata:
     """Arbitrary key-value pairs for merchant use. All values must be strings.
-    Returned on all payment objects and included in webhook payloads.
+    Returned on all payment objects and included in the webhook payload.
     Maximum 10 keys; key names up to 64 characters, values up to 512 characters.
+    Keys are stored as provided and are not renamed.
 
         Example:
             {'customer_id': 'cust_abc123', 'customer_email': 'customer@example.com'}

{hexpay-0.0.2 → hexpay-0.0.3}/hexpay/models/error.py

@@ -26,14 +26,14 @@ class Error:
             type_ (ErrorType): High-level error category. Use this to determine the general class of
                 the error without parsing `code`.
                  Example: invalid_request_error.
-            message (str): Human-readable description of the error, intended for developers. Example: Amount must be a
-                positive decimal number.
+            message (str): Human-readable description of the error, intended for developers. Example: Invalid amount (must
+                be a valid positive number).
             code (str): Machine-readable error identifier. Use this in conditional logic to branch
-                on specific error conditions (e.g., retry on `rate_limit_exceeded`,
+                on specific error conditions (e.g., retry on `payment_concurrent_limit_exceeded`,
                 surface to user on `payment_not_cancellable`).
                  Example: invalid_amount.
             param (str | Unset): The name of the request field that caused the error, using dot notation
-                for nested fields (e.g., `currency`, `payment_options.methods[0]`).
+                for nested fields (e.g., `currency`, `paymentOptions.methods`).
                 Present only when the error is attributable to a specific parameter.
                  Example: amount.
     """