increase 0.552.0__tar.gz → 0.554.0__tar.gz

increase-0.554.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.554.0"
+}

{increase-0.552.0 → increase-0.554.0}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.554.0](https://github.com/Increase/increase-python/compare/v0.553.0...v0.554.0) (2026-10-29)
+
+
+### Features
+
+* **api:** api update ([#1653](https://github.com/Increase/increase-python/issues/1653)) ([3407f0e](https://github.com/Increase/increase-python/commit/3407f0e626a761416c6e847cc031a4989882ccbd))
+
+## [0.553.0](https://github.com/Increase/increase-python/compare/v0.552.0...v0.553.0) (2026-10-27)
+
+
+### Features
+
+* **api:** api update ([#1648](https://github.com/Increase/increase-python/issues/1648)) ([08ae64b](https://github.com/Increase/increase-python/commit/08ae64bc0899532304147853bae94bfbbfaa249f))
+
 ## [0.552.0](https://github.com/Increase/increase-python/compare/v0.551.0...v0.552.0) (2026-10-23)
 
 

{increase-0.552.0 → increase-0.554.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: increase
-Version: 0.552.0
+Version: 0.554.0
 Summary: The official Python library for the increase API
 Project-URL: Homepage, https://github.com/Increase/increase-python
 Project-URL: Repository, https://github.com/Increase/increase-python

{increase-0.552.0 → increase-0.554.0}/api.md

@@ -1009,7 +1009,7 @@ Methods:
 
 Methods:
 
-- <code title="post /simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse">client.simulations.wire_drawdown_requests.<a href="./src/increase/resources/simulations/wire_drawdown_requests.py">refuse</a>(wire_drawdown_request_id) -> <a href="./src/increase/types/wire_drawdown_request.py">WireDrawdownRequest</a></code>
+- <code title="post /simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse">client.simulations.wire_drawdown_requests.<a href="./src/increase/resources/simulations/wire_drawdown_requests.py">refuse</a>(wire_drawdown_request_id, \*\*<a href="src/increase/types/simulations/wire_drawdown_request_refuse_params.py">params</a>) -> <a href="./src/increase/types/wire_drawdown_request.py">WireDrawdownRequest</a></code>
 - <code title="post /simulations/wire_drawdown_requests/{wire_drawdown_request_id}/submit">client.simulations.wire_drawdown_requests.<a href="./src/increase/resources/simulations/wire_drawdown_requests.py">submit</a>(wire_drawdown_request_id) -> <a href="./src/increase/types/wire_drawdown_request.py">WireDrawdownRequest</a></code>
 
 ## InboundWireDrawdownRequests

{increase-0.552.0 → increase-0.554.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "increase"
-version = "0.552.0"
+version = "0.554.0"
 description = "The official Python library for the increase API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{increase-0.552.0 → increase-0.554.0}/src/increase/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "increase"
-__version__ = "0.552.0"  # x-release-please-version
+__version__ = "0.554.0"  # x-release-please-version

{increase-0.552.0 → increase-0.554.0}/src/increase/resources/ach_transfers.py

@@ -80,14 +80,24 @@ class ACHTransfersResource(SyncAPIResource):
         idempotency_key: str | None = None,
     ) -> ACHTransfer:
         """
-        Create an ACH Transfer
+        An ACH Transfer has two primary descriptive fields:
+        [`company_name`](/documentation/api/ach-transfers#create-an-ach-transfer.company_name)
+        and
+        [`individual_name`](/documentation/api/ach-transfers#create-an-ach-transfer.individual_name).
+        You should set both of these, in addition to the required amount and account
+        fields.
 
         Args:
-          account_id: The Increase identifier for the account that will send the transfer.
+          account_id: The Increase identifier for the account that will originate the transfer. For
+              credit transfers (transfers with a positive `amount`), this is the account that
+              funds will be sent from. For debit transfers (transfers with a negative
+              `amount`), this is the account that funds will be pulled into.
 
           amount: The transfer amount in USD cents. A positive amount originates a credit transfer
-              pushing funds to the receiving account. A negative amount originates a debit
-              transfer pulling funds from the receiving account.
+              pushing funds from Increase to the account at the other bank. A negative amount
+              originates a debit transfer pulling funds from the account at the other bank
+              into Increase. Debit transfers
+              [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
 
           statement_descriptor: A description you choose to give the transfer. This will be saved with the
               transfer details, displayed in the dashboard, and returned by the API. If
@@ -96,9 +106,10 @@ class ACHTransfersResource(SyncAPIResource):
               help the customer recognize the transfer. You are highly encouraged to pass
               `individual_name` and `company_name` instead of relying on this fallback.
 
-          account_number: The receiver's account number. For credit transfers (positive `amount`) this is
-              the account that funds will be sent to. For debit transfers (negative `amount`)
-              this is the account that funds will be pulled from.
+          account_number: The receiver's account number. For credit transfers (transfers with a positive
+              `amount`), this is the account that funds will be sent to. For debit transfers
+              (transfers with a negative `amount`), this is the account that funds will be
+              pulled from.
 
           addenda: Additional information passed through to the receiving bank with the transfer.
               Most ACH transfers do not need this. Only set this if your recipient has asked
@@ -109,19 +120,24 @@ class ACHTransfersResource(SyncAPIResource):
               batch header. This value is informational and does not affect funds movement,
               settlement timing, or returns. Only set this if your recipient has asked for it.
 
-          company_discretionary_data: Custom data sent in the company batch header. This value is informational and
-              does not affect funds movement, settlement timing, or returns. Most ACH
-              transfers do not need this. Only set this if your recipient has asked for it.
-
-          company_entry_description: A short description sent in the company batch header. Most receivers do not
-              surface this. Only set this if your recipient has asked for a specific value or
-              if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
-              example, Prearranged Payment and Deposit (PPD) payroll credits must use
-              `PAYROLL`, and reversals must use `REVERSAL`.
-
-          company_name: The name by which the recipient knows you, sent in the company batch header. We
-              recommend setting this on every transfer; if you do not, we fall back to the ACH
-              company name configured on your account.
+          company_discretionary_data: Custom data sent in the company batch header, meant as metadata for the
+              originator. This value is informational and does not affect funds movement,
+              settlement timing, or returns. Most ACH transfers do not need this; we recommend
+              storing metadata in your own application instead.
+
+          company_entry_description: A short description sent in the company batch header, meant to provide the
+              receiver with a reason for the transfer. Many receivers do not surface this data
+              on the receiver's bank statement. Only set this if your recipient has asked for
+              a specific value or if Nacha mandates one for your Standard Entry Class (SEC)
+              code and use case. For example, some use cases require constants like
+              `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
+
+          company_name: The name by which the recipient knows the counterparty of this transaction. If
+              you're processing payments on behalf of another party, use their name, not your
+              own, so that it's more likely the recipient understands the context of the
+              payment. This value is usually displayed to the recipient on their bank
+              statement. We recommend setting this on every transfer; if you do not, we fall
+              back to the `statement_descriptor`.
 
           destination_account_holder: The type of entity that owns the receiver's account.
 
@@ -139,11 +155,15 @@ class ACHTransfersResource(SyncAPIResource):
               - `loan` - A loan account used in a lender-borrower relationship. Uncommon.
               - `general_ledger` - A bank's general ledger. Uncommon.
 
-          individual_id: Your internal identifier for the transfer recipient. This value is informational
-              and not verified by the recipient's bank. Most callers can leave this unset.
+          individual_id: Your internal identifier for the recipient. This value is informational and
+              generally not verified by the recipient's bank. Most callers can leave this
+              unset. For the specific case of person-to-person credits with the WEB standard
+              entry class code, this must include the name of the payer.
 
-          individual_name: The name of the transfer recipient. This value is informational and not verified
-              by the recipient's bank.
+          individual_name: The name of the transfer recipient. This value is informational and generally
+              not verified by the recipient's bank. This value is usually displayed to the
+              recipient on their bank statement. We recommend setting this on every transfer;
+              if you do not, we fall back to the `statement_descriptor`.
 
           preferred_effective_date: Configuration for how the effective date of the transfer will be set. This
               determines same-day vs future-dated settlement timing. If not set, defaults to a
@@ -462,14 +482,24 @@ class AsyncACHTransfersResource(AsyncAPIResource):
         idempotency_key: str | None = None,
     ) -> ACHTransfer:
         """
-        Create an ACH Transfer
+        An ACH Transfer has two primary descriptive fields:
+        [`company_name`](/documentation/api/ach-transfers#create-an-ach-transfer.company_name)
+        and
+        [`individual_name`](/documentation/api/ach-transfers#create-an-ach-transfer.individual_name).
+        You should set both of these, in addition to the required amount and account
+        fields.
 
         Args:
-          account_id: The Increase identifier for the account that will send the transfer.
+          account_id: The Increase identifier for the account that will originate the transfer. For
+              credit transfers (transfers with a positive `amount`), this is the account that
+              funds will be sent from. For debit transfers (transfers with a negative
+              `amount`), this is the account that funds will be pulled into.
 
           amount: The transfer amount in USD cents. A positive amount originates a credit transfer
-              pushing funds to the receiving account. A negative amount originates a debit
-              transfer pulling funds from the receiving account.
+              pushing funds from Increase to the account at the other bank. A negative amount
+              originates a debit transfer pulling funds from the account at the other bank
+              into Increase. Debit transfers
+              [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
 
           statement_descriptor: A description you choose to give the transfer. This will be saved with the
               transfer details, displayed in the dashboard, and returned by the API. If
@@ -478,9 +508,10 @@ class AsyncACHTransfersResource(AsyncAPIResource):
               help the customer recognize the transfer. You are highly encouraged to pass
               `individual_name` and `company_name` instead of relying on this fallback.
 
-          account_number: The receiver's account number. For credit transfers (positive `amount`) this is
-              the account that funds will be sent to. For debit transfers (negative `amount`)
-              this is the account that funds will be pulled from.
+          account_number: The receiver's account number. For credit transfers (transfers with a positive
+              `amount`), this is the account that funds will be sent to. For debit transfers
+              (transfers with a negative `amount`), this is the account that funds will be
+              pulled from.
 
           addenda: Additional information passed through to the receiving bank with the transfer.
               Most ACH transfers do not need this. Only set this if your recipient has asked
@@ -491,19 +522,24 @@ class AsyncACHTransfersResource(AsyncAPIResource):
               batch header. This value is informational and does not affect funds movement,
               settlement timing, or returns. Only set this if your recipient has asked for it.
 
-          company_discretionary_data: Custom data sent in the company batch header. This value is informational and
-              does not affect funds movement, settlement timing, or returns. Most ACH
-              transfers do not need this. Only set this if your recipient has asked for it.
-
-          company_entry_description: A short description sent in the company batch header. Most receivers do not
-              surface this. Only set this if your recipient has asked for a specific value or
-              if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
-              example, Prearranged Payment and Deposit (PPD) payroll credits must use
-              `PAYROLL`, and reversals must use `REVERSAL`.
-
-          company_name: The name by which the recipient knows you, sent in the company batch header. We
-              recommend setting this on every transfer; if you do not, we fall back to the ACH
-              company name configured on your account.
+          company_discretionary_data: Custom data sent in the company batch header, meant as metadata for the
+              originator. This value is informational and does not affect funds movement,
+              settlement timing, or returns. Most ACH transfers do not need this; we recommend
+              storing metadata in your own application instead.
+
+          company_entry_description: A short description sent in the company batch header, meant to provide the
+              receiver with a reason for the transfer. Many receivers do not surface this data
+              on the receiver's bank statement. Only set this if your recipient has asked for
+              a specific value or if Nacha mandates one for your Standard Entry Class (SEC)
+              code and use case. For example, some use cases require constants like
+              `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
+
+          company_name: The name by which the recipient knows the counterparty of this transaction. If
+              you're processing payments on behalf of another party, use their name, not your
+              own, so that it's more likely the recipient understands the context of the
+              payment. This value is usually displayed to the recipient on their bank
+              statement. We recommend setting this on every transfer; if you do not, we fall
+              back to the `statement_descriptor`.
 
           destination_account_holder: The type of entity that owns the receiver's account.
 
@@ -521,11 +557,15 @@ class AsyncACHTransfersResource(AsyncAPIResource):
               - `loan` - A loan account used in a lender-borrower relationship. Uncommon.
               - `general_ledger` - A bank's general ledger. Uncommon.
 
-          individual_id: Your internal identifier for the transfer recipient. This value is informational
-              and not verified by the recipient's bank. Most callers can leave this unset.
+          individual_id: Your internal identifier for the recipient. This value is informational and
+              generally not verified by the recipient's bank. Most callers can leave this
+              unset. For the specific case of person-to-person credits with the WEB standard
+              entry class code, this must include the name of the payer.
 
-          individual_name: The name of the transfer recipient. This value is informational and not verified
-              by the recipient's bank.
+          individual_name: The name of the transfer recipient. This value is informational and generally
+              not verified by the recipient's bank. This value is usually displayed to the
+              recipient on their bank statement. We recommend setting this on every transfer;
+              if you do not, we fall back to the `statement_descriptor`.
 
           preferred_effective_date: Configuration for how the effective date of the transfer will be set. This
               determines same-day vs future-dated settlement timing. If not set, defaults to a

{increase-0.552.0 → increase-0.554.0}/src/increase/resources/digital_card_profiles.py

@@ -53,6 +53,7 @@ class DigitalCardProfilesResource(SyncAPIResource):
         background_image_file_id: str,
         card_description: str,
         description: str,
+        apple_pay: digital_card_profile_create_params.ApplePay | Omit = omit,
         contact_email: str | Omit = omit,
         contact_name: str | Omit = omit,
         contact_phone: str | Omit = omit,
@@ -78,6 +79,8 @@ class DigitalCardProfilesResource(SyncAPIResource):
 
           description: A description you can use to identify the Card Profile.
 
+          apple_pay: Apple Pay specific settings for the Card Profile.
+
           contact_email: An email address the user can contact to receive support for their card.
 
           contact_name: The name of your company or card program, shown to the user as who to contact
@@ -107,6 +110,7 @@ class DigitalCardProfilesResource(SyncAPIResource):
                     "background_image_file_id": background_image_file_id,
                     "card_description": card_description,
                     "description": description,
+                    "apple_pay": apple_pay,
                     "contact_email": contact_email,
                     "contact_name": contact_name,
                     "contact_phone": contact_phone,
@@ -275,6 +279,7 @@ class DigitalCardProfilesResource(SyncAPIResource):
         digital_card_profile_id: str,
         *,
         app_icon_file_id: str | Omit = omit,
+        apple_pay: digital_card_profile_clone_params.ApplePay | Omit = omit,
         background_image_file_id: str | Omit = omit,
         card_description: str | Omit = omit,
         contact_email: str | Omit = omit,
@@ -299,6 +304,9 @@ class DigitalCardProfilesResource(SyncAPIResource):
 
           app_icon_file_id: The identifier of the File containing the card's icon image.
 
+          apple_pay: Apple Pay specific settings for the Card Profile. Each list you leave out is
+              copied from the original Card Profile.
+
           background_image_file_id: The identifier of the File containing the card's front image.
 
           card_description: A user-facing description for the card itself.
@@ -338,6 +346,7 @@ class DigitalCardProfilesResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "app_icon_file_id": app_icon_file_id,
+                    "apple_pay": apple_pay,
                     "background_image_file_id": background_image_file_id,
                     "card_description": card_description,
                     "contact_email": contact_email,
@@ -387,6 +396,7 @@ class AsyncDigitalCardProfilesResource(AsyncAPIResource):
         background_image_file_id: str,
         card_description: str,
         description: str,
+        apple_pay: digital_card_profile_create_params.ApplePay | Omit = omit,
         contact_email: str | Omit = omit,
         contact_name: str | Omit = omit,
         contact_phone: str | Omit = omit,
@@ -412,6 +422,8 @@ class AsyncDigitalCardProfilesResource(AsyncAPIResource):
 
           description: A description you can use to identify the Card Profile.
 
+          apple_pay: Apple Pay specific settings for the Card Profile.
+
           contact_email: An email address the user can contact to receive support for their card.
 
           contact_name: The name of your company or card program, shown to the user as who to contact
@@ -441,6 +453,7 @@ class AsyncDigitalCardProfilesResource(AsyncAPIResource):
                     "background_image_file_id": background_image_file_id,
                     "card_description": card_description,
                     "description": description,
+                    "apple_pay": apple_pay,
                     "contact_email": contact_email,
                     "contact_name": contact_name,
                     "contact_phone": contact_phone,
@@ -609,6 +622,7 @@ class AsyncDigitalCardProfilesResource(AsyncAPIResource):
         digital_card_profile_id: str,
         *,
         app_icon_file_id: str | Omit = omit,
+        apple_pay: digital_card_profile_clone_params.ApplePay | Omit = omit,
         background_image_file_id: str | Omit = omit,
         card_description: str | Omit = omit,
         contact_email: str | Omit = omit,
@@ -633,6 +647,9 @@ class AsyncDigitalCardProfilesResource(AsyncAPIResource):
 
           app_icon_file_id: The identifier of the File containing the card's icon image.
 
+          apple_pay: Apple Pay specific settings for the Card Profile. Each list you leave out is
+              copied from the original Card Profile.
+
           background_image_file_id: The identifier of the File containing the card's front image.
 
           card_description: A user-facing description for the card itself.
@@ -672,6 +689,7 @@ class AsyncDigitalCardProfilesResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "app_icon_file_id": app_icon_file_id,
+                    "apple_pay": apple_pay,
                     "background_image_file_id": background_image_file_id,
                     "card_description": card_description,
                     "contact_email": contact_email,

{increase-0.552.0 → increase-0.554.0}/src/increase/resources/simulations/wire_drawdown_requests.py

@@ -2,10 +2,12 @@
 
 from __future__ import annotations
 
+from typing_extensions import Literal
+
 import httpx
 
-from ..._types import Body, Query, Headers, NotGiven, not_given
-from ..._utils import path_template
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..._utils import path_template, maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import (
@@ -15,6 +17,7 @@ from ..._response import (
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
+from ...types.simulations import wire_drawdown_request_refuse_params
 from ...types.wire_drawdown_request import WireDrawdownRequest
 
 __all__ = ["WireDrawdownRequestsResource", "AsyncWireDrawdownRequestsResource"]
@@ -44,6 +47,16 @@ class WireDrawdownRequestsResource(SyncAPIResource):
         self,
         wire_drawdown_request_id: str,
         *,
+        refusal_reason_additional_information: str | Omit = omit,
+        refusal_reason_code: Literal[
+            "invalid_debtor_account_number",
+            "transaction_forbidden",
+            "unsuccessful_direct_debit",
+            "inconsistent_with_end_customer",
+            "narrative",
+            "other",
+        ]
+        | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -58,6 +71,22 @@ class WireDrawdownRequestsResource(SyncAPIResource):
         Args:
           wire_drawdown_request_id: The identifier of the Wire Drawdown Request you wish to refuse.
 
+          refusal_reason_additional_information: Additional information about the refusal that the simulated refusal will have.
+
+          refusal_reason_code: The reason code that the simulated refusal will have.
+
+              - `invalid_debtor_account_number` - The debtor's account number is invalid or
+                missing. Corresponds to the Fedwire reason code `AC02`.
+              - `transaction_forbidden` - The debtor account does not allow drawdown requests.
+                Corresponds to the Fedwire reason code `AG01`.
+              - `unsuccessful_direct_debit` - The debtor account cannot be debited for a
+                generic reason. Corresponds to the Fedwire reason code `AG07`.
+              - `inconsistent_with_end_customer` - The debtor's identification is inconsistent
+                with the debtor account number. Corresponds to the Fedwire reason code `BE01`.
+              - `narrative` - The reason is provided as narrative information in the
+                additional information field. Corresponds to the Fedwire reason code `NARR`.
+              - `other` - Some other error or issue has occurred.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -77,6 +106,13 @@ class WireDrawdownRequestsResource(SyncAPIResource):
                 "/simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse",
                 wire_drawdown_request_id=wire_drawdown_request_id,
             ),
+            body=maybe_transform(
+                {
+                    "refusal_reason_additional_information": refusal_reason_additional_information,
+                    "refusal_reason_code": refusal_reason_code,
+                },
+                wire_drawdown_request_refuse_params.WireDrawdownRequestRefuseParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -159,6 +195,16 @@ class AsyncWireDrawdownRequestsResource(AsyncAPIResource):
         self,
         wire_drawdown_request_id: str,
         *,
+        refusal_reason_additional_information: str | Omit = omit,
+        refusal_reason_code: Literal[
+            "invalid_debtor_account_number",
+            "transaction_forbidden",
+            "unsuccessful_direct_debit",
+            "inconsistent_with_end_customer",
+            "narrative",
+            "other",
+        ]
+        | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -173,6 +219,22 @@ class AsyncWireDrawdownRequestsResource(AsyncAPIResource):
         Args:
           wire_drawdown_request_id: The identifier of the Wire Drawdown Request you wish to refuse.
 
+          refusal_reason_additional_information: Additional information about the refusal that the simulated refusal will have.
+
+          refusal_reason_code: The reason code that the simulated refusal will have.
+
+              - `invalid_debtor_account_number` - The debtor's account number is invalid or
+                missing. Corresponds to the Fedwire reason code `AC02`.
+              - `transaction_forbidden` - The debtor account does not allow drawdown requests.
+                Corresponds to the Fedwire reason code `AG01`.
+              - `unsuccessful_direct_debit` - The debtor account cannot be debited for a
+                generic reason. Corresponds to the Fedwire reason code `AG07`.
+              - `inconsistent_with_end_customer` - The debtor's identification is inconsistent
+                with the debtor account number. Corresponds to the Fedwire reason code `BE01`.
+              - `narrative` - The reason is provided as narrative information in the
+                additional information field. Corresponds to the Fedwire reason code `NARR`.
+              - `other` - Some other error or issue has occurred.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -192,6 +254,13 @@ class AsyncWireDrawdownRequestsResource(AsyncAPIResource):
                 "/simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse",
                 wire_drawdown_request_id=wire_drawdown_request_id,
             ),
+            body=await async_maybe_transform(
+                {
+                    "refusal_reason_additional_information": refusal_reason_additional_information,
+                    "refusal_reason_code": refusal_reason_code,
+                },
+                wire_drawdown_request_refuse_params.WireDrawdownRequestRefuseParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,

{increase-0.552.0 → increase-0.554.0}/src/increase/types/ach_transfer_create_params.py

@@ -21,14 +21,20 @@ __all__ = [
 
 class ACHTransferCreateParams(TypedDict, total=False):
     account_id: Required[str]
-    """The Increase identifier for the account that will send the transfer."""
+    """The Increase identifier for the account that will originate the transfer.
+
+    For credit transfers (transfers with a positive `amount`), this is the account
+    that funds will be sent from. For debit transfers (transfers with a negative
+    `amount`), this is the account that funds will be pulled into.
+    """
 
     amount: Required[int]
     """The transfer amount in USD cents.
 
-    A positive amount originates a credit transfer pushing funds to the receiving
-    account. A negative amount originates a debit transfer pulling funds from the
-    receiving account.
+    A positive amount originates a credit transfer pushing funds from Increase to
+    the account at the other bank. A negative amount originates a debit transfer
+    pulling funds from the account at the other bank into Increase. Debit transfers
+    [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
     """
 
     statement_descriptor: Required[str]
@@ -45,9 +51,9 @@ class ACHTransferCreateParams(TypedDict, total=False):
     account_number: str
     """The receiver's account number.
 
-    For credit transfers (positive `amount`) this is the account that funds will be
-    sent to. For debit transfers (negative `amount`) this is the account that funds
-    will be pulled from.
+    For credit transfers (transfers with a positive `amount`), this is the account
+    that funds will be sent to. For debit transfers (transfers with a negative
+    `amount`), this is the account that funds will be pulled from.
     """
 
     addenda: Addenda
@@ -66,27 +72,31 @@ class ACHTransferCreateParams(TypedDict, total=False):
     """
 
     company_discretionary_data: str
-    """Custom data sent in the company batch header.
-
-    This value is informational and does not affect funds movement, settlement
-    timing, or returns. Most ACH transfers do not need this. Only set this if your
-    recipient has asked for it.
+    """
+    Custom data sent in the company batch header, meant as metadata for the
+    originator. This value is informational and does not affect funds movement,
+    settlement timing, or returns. Most ACH transfers do not need this; we recommend
+    storing metadata in your own application instead.
     """
 
     company_entry_description: str
-    """A short description sent in the company batch header.
-
-    Most receivers do not surface this. Only set this if your recipient has asked
-    for a specific value or if Nacha mandates one for your Standard Entry Class
-    (SEC) code and use case. For example, Prearranged Payment and Deposit (PPD)
-    payroll credits must use `PAYROLL`, and reversals must use `REVERSAL`.
+    """
+    A short description sent in the company batch header, meant to provide the
+    receiver with a reason for the transfer. Many receivers do not surface this data
+    on the receiver's bank statement. Only set this if your recipient has asked for
+    a specific value or if Nacha mandates one for your Standard Entry Class (SEC)
+    code and use case. For example, some use cases require constants like
+    `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
     """
 
     company_name: str
-    """The name by which the recipient knows you, sent in the company batch header.
+    """The name by which the recipient knows the counterparty of this transaction.
 
-    We recommend setting this on every transfer; if you do not, we fall back to the
-    ACH company name configured on your account.
+    If you're processing payments on behalf of another party, use their name, not
+    your own, so that it's more likely the recipient understands the context of the
+    payment. This value is usually displayed to the recipient on their bank
+    statement. We recommend setting this on every transfer; if you do not, we fall
+    back to the `statement_descriptor`.
     """
 
     destination_account_holder: Literal["business", "individual", "unknown"]
@@ -114,16 +124,21 @@ class ACHTransferCreateParams(TypedDict, total=False):
     """
 
     individual_id: str
-    """Your internal identifier for the transfer recipient.
+    """Your internal identifier for the recipient.
 
-    This value is informational and not verified by the recipient's bank. Most
-    callers can leave this unset.
+    This value is informational and generally not verified by the recipient's bank.
+    Most callers can leave this unset. For the specific case of person-to-person
+    credits with the WEB standard entry class code, this must include the name of
+    the payer.
     """
 
     individual_name: str
     """The name of the transfer recipient.
 
-    This value is informational and not verified by the recipient's bank.
+    This value is informational and generally not verified by the recipient's bank.
+    This value is usually displayed to the recipient on their bank statement. We
+    recommend setting this on every transfer; if you do not, we fall back to the
+    `statement_descriptor`.
     """
 
     preferred_effective_date: PreferredEffectiveDate