unit-openapi-python-sdk 0.18.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

unit_finance_sdk/api/stop_payments_api.py

@@ -0,0 +1,1770 @@
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.19.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated
+from unit_finance_sdk.models.create_stop_payment201_response import CreateStopPayment201Response
+from unit_finance_sdk.models.create_stop_payment_request import CreateStopPaymentRequest
+from unit_finance_sdk.models.get_stop_payment200_response import GetStopPayment200Response
+from unit_finance_sdk.models.list_stop_payments200_response import ListStopPayments200Response
+from unit_finance_sdk.models.update_ach_stop_payment200_response import UpdateAchStopPayment200Response
+from unit_finance_sdk.models.update_ach_stop_payment_request import UpdateAchStopPaymentRequest
+
+from unit_finance_sdk.api_client import ApiClient, RequestSerialized
+from unit_finance_sdk.api_response import ApiResponse
+from unit_finance_sdk.rest import RESTResponseType
+
+
+class StopPaymentsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def create_stop_payment(
+        self,
+        create_stop_payment_request: CreateStopPaymentRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> CreateStopPayment201Response:
+        """Create a stop payment
+
+        Create a stop payment. The request body is one of CreateACHStopPaymentRequest or CreateCheckStopPaymentRequest, discriminated by data.type (achStopPayment, checkStopPayment). The stopPayment created webhook event will be fired.
+
+        :param create_stop_payment_request: (required)
+        :type create_stop_payment_request: CreateStopPaymentRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_stop_payment_serialize(
+            create_stop_payment_request=create_stop_payment_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "CreateStopPayment201Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def create_stop_payment_with_http_info(
+        self,
+        create_stop_payment_request: CreateStopPaymentRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[CreateStopPayment201Response]:
+        """Create a stop payment
+
+        Create a stop payment. The request body is one of CreateACHStopPaymentRequest or CreateCheckStopPaymentRequest, discriminated by data.type (achStopPayment, checkStopPayment). The stopPayment created webhook event will be fired.
+
+        :param create_stop_payment_request: (required)
+        :type create_stop_payment_request: CreateStopPaymentRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_stop_payment_serialize(
+            create_stop_payment_request=create_stop_payment_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "CreateStopPayment201Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def create_stop_payment_without_preload_content(
+        self,
+        create_stop_payment_request: CreateStopPaymentRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Create a stop payment
+
+        Create a stop payment. The request body is one of CreateACHStopPaymentRequest or CreateCheckStopPaymentRequest, discriminated by data.type (achStopPayment, checkStopPayment). The stopPayment created webhook event will be fired.
+
+        :param create_stop_payment_request: (required)
+        :type create_stop_payment_request: CreateStopPaymentRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_stop_payment_serialize(
+            create_stop_payment_request=create_stop_payment_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "CreateStopPayment201Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_stop_payment_serialize(
+        self,
+        create_stop_payment_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if create_stop_payment_request is not None:
+            _body_params = create_stop_payment_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/vnd.api+json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/vnd.api+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/stop-payments',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def disable_stop_payment(
+        self,
+        stop_payment_id: StrictStr,
+        body: Optional[Dict[str, Any]] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GetStopPayment200Response:
+        """Disable a stop payment
+
+        Disable a Stop Payment by id. When a Stop Payment is disabled, the checkStopPayment disabled webhook event is fired and future check payments wont be stopped by this stop payment.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param body:
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._disable_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def disable_stop_payment_with_http_info(
+        self,
+        stop_payment_id: StrictStr,
+        body: Optional[Dict[str, Any]] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GetStopPayment200Response]:
+        """Disable a stop payment
+
+        Disable a Stop Payment by id. When a Stop Payment is disabled, the checkStopPayment disabled webhook event is fired and future check payments wont be stopped by this stop payment.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param body:
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._disable_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def disable_stop_payment_without_preload_content(
+        self,
+        stop_payment_id: StrictStr,
+        body: Optional[Dict[str, Any]] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Disable a stop payment
+
+        Disable a Stop Payment by id. When a Stop Payment is disabled, the checkStopPayment disabled webhook event is fired and future check payments wont be stopped by this stop payment.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param body:
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._disable_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _disable_stop_payment_serialize(
+        self,
+        stop_payment_id,
+        body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if stop_payment_id is not None:
+            _path_params['stopPaymentId'] = stop_payment_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body is not None:
+            _body_params = body
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/vnd.api+json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/vnd.api+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/stop-payments/{stopPaymentId}/disable',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_stop_payment(
+        self,
+        stop_payment_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GetStopPayment200Response:
+        """Get a stop payment by id
+
+        Get a stop payment by id.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_stop_payment_with_http_info(
+        self,
+        stop_payment_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GetStopPayment200Response]:
+        """Get a stop payment by id
+
+        Get a stop payment by id.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_stop_payment_without_preload_content(
+        self,
+        stop_payment_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get a stop payment by id
+
+        Get a stop payment by id.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_stop_payment_serialize(
+        self,
+        stop_payment_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if stop_payment_id is not None:
+            _path_params['stopPaymentId'] = stop_payment_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/vnd.api+json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/stop-payments/{stopPaymentId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def list_stop_payments(
+        self,
+        page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
+        page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
+        filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter stop payments by Tags.")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
+        filter_since: Annotated[Optional[StrictStr], Field(description="Optional. Filters *before* the specified date. e.g. 2021-06-01")] = None,
+        filter_until: Annotated[Optional[StrictStr], Field(description="Optional. Filters *after* the specified date. e.g. 2021-07-01")] = None,
+        filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by status (Active, Disabled). Usage example: *filter[status][0]=Disabled*")] = None,
+        filter_from_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Stop Payments that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000")] = None,
+        filter_to_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Stop Payments that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000")] = None,
+        filter_no_amount: Annotated[Optional[StrictStr], Field(description="Optional. If set to true, returns only Stop Payments with no amount . If set to false only returns Stop Payments with amount")] = None,
+        filter_from_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters ACH stop Payments that have minAmount higher than the specified amount (cents).")] = None,
+        filter_to_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters ACH stop Payments that have minAmount lower than the specified amount (cents).")] = None,
+        filter_no_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. If set to true, returns only ACH Stop Payments with no minAmount . If set to false only returns Stop Payments with minAmount")] = None,
+        filter_originator_name: Annotated[Optional[StrictStr], Field(description="Optional.")] = None,
+        filter_no_originator_name: Annotated[Optional[StrictStr], Field(description="Optional.")] = None,
+        filter_check_number: Annotated[Optional[StrictStr], Field(description="Optional. Filter Stop Payments by check number (trimming leading zeros).")] = None,
+        filter_type: Annotated[Optional[StrictStr], Field(description="Optional. Either checkStopPayment or achStopPayment")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ListStopPayments200Response:
+        """List stop payments
+
+        List stop payment resources. Filtering, paging and sorting can be applied.
+
+        :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
+        :type page_limit: str
+        :param page_offset: Number of resources to skip. See Pagination.
+        :type page_offset: str
+        :param filter_account_id: Optional. Filters the results by the specified account id.
+        :type filter_account_id: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_tags: Optional. Filter stop payments by Tags.
+        :type filter_tags: str
+        :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
+        :type sort: str
+        :param filter_since: Optional. Filters *before* the specified date. e.g. 2021-06-01
+        :type filter_since: str
+        :param filter_until: Optional. Filters *after* the specified date. e.g. 2021-07-01
+        :type filter_until: str
+        :param filter_status: Optional. Filter by status (Active, Disabled). Usage example: *filter[status][0]=Disabled*
+        :type filter_status: str
+        :param filter_from_amount: Optional. Filters the Check Stop Payments that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000
+        :type filter_from_amount: str
+        :param filter_to_amount: Optional. Filters the Stop Payments that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000
+        :type filter_to_amount: str
+        :param filter_no_amount: Optional. If set to true, returns only Stop Payments with no amount . If set to false only returns Stop Payments with amount
+        :type filter_no_amount: str
+        :param filter_from_min_amount: Optional. Filters ACH stop Payments that have minAmount higher than the specified amount (cents).
+        :type filter_from_min_amount: str
+        :param filter_to_min_amount: Optional. Filters ACH stop Payments that have minAmount lower than the specified amount (cents).
+        :type filter_to_min_amount: str
+        :param filter_no_min_amount: Optional. If set to true, returns only ACH Stop Payments with no minAmount . If set to false only returns Stop Payments with minAmount
+        :type filter_no_min_amount: str
+        :param filter_originator_name: Optional.
+        :type filter_originator_name: str
+        :param filter_no_originator_name: Optional.
+        :type filter_no_originator_name: str
+        :param filter_check_number: Optional. Filter Stop Payments by check number (trimming leading zeros).
+        :type filter_check_number: str
+        :param filter_type: Optional. Either checkStopPayment or achStopPayment
+        :type filter_type: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_stop_payments_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_account_id=filter_account_id,
+            filter_customer_id=filter_customer_id,
+            filter_tags=filter_tags,
+            sort=sort,
+            filter_since=filter_since,
+            filter_until=filter_until,
+            filter_status=filter_status,
+            filter_from_amount=filter_from_amount,
+            filter_to_amount=filter_to_amount,
+            filter_no_amount=filter_no_amount,
+            filter_from_min_amount=filter_from_min_amount,
+            filter_to_min_amount=filter_to_min_amount,
+            filter_no_min_amount=filter_no_min_amount,
+            filter_originator_name=filter_originator_name,
+            filter_no_originator_name=filter_no_originator_name,
+            filter_check_number=filter_check_number,
+            filter_type=filter_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListStopPayments200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def list_stop_payments_with_http_info(
+        self,
+        page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
+        page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
+        filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter stop payments by Tags.")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
+        filter_since: Annotated[Optional[StrictStr], Field(description="Optional. Filters *before* the specified date. e.g. 2021-06-01")] = None,
+        filter_until: Annotated[Optional[StrictStr], Field(description="Optional. Filters *after* the specified date. e.g. 2021-07-01")] = None,
+        filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by status (Active, Disabled). Usage example: *filter[status][0]=Disabled*")] = None,
+        filter_from_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Stop Payments that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000")] = None,
+        filter_to_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Stop Payments that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000")] = None,
+        filter_no_amount: Annotated[Optional[StrictStr], Field(description="Optional. If set to true, returns only Stop Payments with no amount . If set to false only returns Stop Payments with amount")] = None,
+        filter_from_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters ACH stop Payments that have minAmount higher than the specified amount (cents).")] = None,
+        filter_to_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters ACH stop Payments that have minAmount lower than the specified amount (cents).")] = None,
+        filter_no_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. If set to true, returns only ACH Stop Payments with no minAmount . If set to false only returns Stop Payments with minAmount")] = None,
+        filter_originator_name: Annotated[Optional[StrictStr], Field(description="Optional.")] = None,
+        filter_no_originator_name: Annotated[Optional[StrictStr], Field(description="Optional.")] = None,
+        filter_check_number: Annotated[Optional[StrictStr], Field(description="Optional. Filter Stop Payments by check number (trimming leading zeros).")] = None,
+        filter_type: Annotated[Optional[StrictStr], Field(description="Optional. Either checkStopPayment or achStopPayment")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ListStopPayments200Response]:
+        """List stop payments
+
+        List stop payment resources. Filtering, paging and sorting can be applied.
+
+        :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
+        :type page_limit: str
+        :param page_offset: Number of resources to skip. See Pagination.
+        :type page_offset: str
+        :param filter_account_id: Optional. Filters the results by the specified account id.
+        :type filter_account_id: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_tags: Optional. Filter stop payments by Tags.
+        :type filter_tags: str
+        :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
+        :type sort: str
+        :param filter_since: Optional. Filters *before* the specified date. e.g. 2021-06-01
+        :type filter_since: str
+        :param filter_until: Optional. Filters *after* the specified date. e.g. 2021-07-01
+        :type filter_until: str
+        :param filter_status: Optional. Filter by status (Active, Disabled). Usage example: *filter[status][0]=Disabled*
+        :type filter_status: str
+        :param filter_from_amount: Optional. Filters the Check Stop Payments that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000
+        :type filter_from_amount: str
+        :param filter_to_amount: Optional. Filters the Stop Payments that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000
+        :type filter_to_amount: str
+        :param filter_no_amount: Optional. If set to true, returns only Stop Payments with no amount . If set to false only returns Stop Payments with amount
+        :type filter_no_amount: str
+        :param filter_from_min_amount: Optional. Filters ACH stop Payments that have minAmount higher than the specified amount (cents).
+        :type filter_from_min_amount: str
+        :param filter_to_min_amount: Optional. Filters ACH stop Payments that have minAmount lower than the specified amount (cents).
+        :type filter_to_min_amount: str
+        :param filter_no_min_amount: Optional. If set to true, returns only ACH Stop Payments with no minAmount . If set to false only returns Stop Payments with minAmount
+        :type filter_no_min_amount: str
+        :param filter_originator_name: Optional.
+        :type filter_originator_name: str
+        :param filter_no_originator_name: Optional.
+        :type filter_no_originator_name: str
+        :param filter_check_number: Optional. Filter Stop Payments by check number (trimming leading zeros).
+        :type filter_check_number: str
+        :param filter_type: Optional. Either checkStopPayment or achStopPayment
+        :type filter_type: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_stop_payments_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_account_id=filter_account_id,
+            filter_customer_id=filter_customer_id,
+            filter_tags=filter_tags,
+            sort=sort,
+            filter_since=filter_since,
+            filter_until=filter_until,
+            filter_status=filter_status,
+            filter_from_amount=filter_from_amount,
+            filter_to_amount=filter_to_amount,
+            filter_no_amount=filter_no_amount,
+            filter_from_min_amount=filter_from_min_amount,
+            filter_to_min_amount=filter_to_min_amount,
+            filter_no_min_amount=filter_no_min_amount,
+            filter_originator_name=filter_originator_name,
+            filter_no_originator_name=filter_no_originator_name,
+            filter_check_number=filter_check_number,
+            filter_type=filter_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListStopPayments200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def list_stop_payments_without_preload_content(
+        self,
+        page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
+        page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
+        filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter stop payments by Tags.")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
+        filter_since: Annotated[Optional[StrictStr], Field(description="Optional. Filters *before* the specified date. e.g. 2021-06-01")] = None,
+        filter_until: Annotated[Optional[StrictStr], Field(description="Optional. Filters *after* the specified date. e.g. 2021-07-01")] = None,
+        filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by status (Active, Disabled). Usage example: *filter[status][0]=Disabled*")] = None,
+        filter_from_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Stop Payments that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000")] = None,
+        filter_to_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Stop Payments that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000")] = None,
+        filter_no_amount: Annotated[Optional[StrictStr], Field(description="Optional. If set to true, returns only Stop Payments with no amount . If set to false only returns Stop Payments with amount")] = None,
+        filter_from_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters ACH stop Payments that have minAmount higher than the specified amount (cents).")] = None,
+        filter_to_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters ACH stop Payments that have minAmount lower than the specified amount (cents).")] = None,
+        filter_no_min_amount: Annotated[Optional[StrictStr], Field(description="Optional. If set to true, returns only ACH Stop Payments with no minAmount . If set to false only returns Stop Payments with minAmount")] = None,
+        filter_originator_name: Annotated[Optional[StrictStr], Field(description="Optional.")] = None,
+        filter_no_originator_name: Annotated[Optional[StrictStr], Field(description="Optional.")] = None,
+        filter_check_number: Annotated[Optional[StrictStr], Field(description="Optional. Filter Stop Payments by check number (trimming leading zeros).")] = None,
+        filter_type: Annotated[Optional[StrictStr], Field(description="Optional. Either checkStopPayment or achStopPayment")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """List stop payments
+
+        List stop payment resources. Filtering, paging and sorting can be applied.
+
+        :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
+        :type page_limit: str
+        :param page_offset: Number of resources to skip. See Pagination.
+        :type page_offset: str
+        :param filter_account_id: Optional. Filters the results by the specified account id.
+        :type filter_account_id: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_tags: Optional. Filter stop payments by Tags.
+        :type filter_tags: str
+        :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
+        :type sort: str
+        :param filter_since: Optional. Filters *before* the specified date. e.g. 2021-06-01
+        :type filter_since: str
+        :param filter_until: Optional. Filters *after* the specified date. e.g. 2021-07-01
+        :type filter_until: str
+        :param filter_status: Optional. Filter by status (Active, Disabled). Usage example: *filter[status][0]=Disabled*
+        :type filter_status: str
+        :param filter_from_amount: Optional. Filters the Check Stop Payments that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000
+        :type filter_from_amount: str
+        :param filter_to_amount: Optional. Filters the Stop Payments that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000
+        :type filter_to_amount: str
+        :param filter_no_amount: Optional. If set to true, returns only Stop Payments with no amount . If set to false only returns Stop Payments with amount
+        :type filter_no_amount: str
+        :param filter_from_min_amount: Optional. Filters ACH stop Payments that have minAmount higher than the specified amount (cents).
+        :type filter_from_min_amount: str
+        :param filter_to_min_amount: Optional. Filters ACH stop Payments that have minAmount lower than the specified amount (cents).
+        :type filter_to_min_amount: str
+        :param filter_no_min_amount: Optional. If set to true, returns only ACH Stop Payments with no minAmount . If set to false only returns Stop Payments with minAmount
+        :type filter_no_min_amount: str
+        :param filter_originator_name: Optional.
+        :type filter_originator_name: str
+        :param filter_no_originator_name: Optional.
+        :type filter_no_originator_name: str
+        :param filter_check_number: Optional. Filter Stop Payments by check number (trimming leading zeros).
+        :type filter_check_number: str
+        :param filter_type: Optional. Either checkStopPayment or achStopPayment
+        :type filter_type: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_stop_payments_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_account_id=filter_account_id,
+            filter_customer_id=filter_customer_id,
+            filter_tags=filter_tags,
+            sort=sort,
+            filter_since=filter_since,
+            filter_until=filter_until,
+            filter_status=filter_status,
+            filter_from_amount=filter_from_amount,
+            filter_to_amount=filter_to_amount,
+            filter_no_amount=filter_no_amount,
+            filter_from_min_amount=filter_from_min_amount,
+            filter_to_min_amount=filter_to_min_amount,
+            filter_no_min_amount=filter_no_min_amount,
+            filter_originator_name=filter_originator_name,
+            filter_no_originator_name=filter_no_originator_name,
+            filter_check_number=filter_check_number,
+            filter_type=filter_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListStopPayments200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _list_stop_payments_serialize(
+        self,
+        page_limit,
+        page_offset,
+        filter_account_id,
+        filter_customer_id,
+        filter_tags,
+        sort,
+        filter_since,
+        filter_until,
+        filter_status,
+        filter_from_amount,
+        filter_to_amount,
+        filter_no_amount,
+        filter_from_min_amount,
+        filter_to_min_amount,
+        filter_no_min_amount,
+        filter_originator_name,
+        filter_no_originator_name,
+        filter_check_number,
+        filter_type,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if page_limit is not None:
+            
+            _query_params.append(('page[limit]', page_limit))
+            
+        if page_offset is not None:
+            
+            _query_params.append(('page[offset]', page_offset))
+            
+        if filter_account_id is not None:
+            
+            _query_params.append(('filter[accountId]', filter_account_id))
+            
+        if filter_customer_id is not None:
+            
+            _query_params.append(('filter[customerId]', filter_customer_id))
+            
+        if filter_tags is not None:
+            
+            _query_params.append(('filter[tags]', filter_tags))
+            
+        if sort is not None:
+            
+            _query_params.append(('sort', sort))
+            
+        if filter_since is not None:
+            
+            _query_params.append(('filter[since]', filter_since))
+            
+        if filter_until is not None:
+            
+            _query_params.append(('filter[until]', filter_until))
+            
+        if filter_status is not None:
+            
+            _query_params.append(('filter[status][]', filter_status))
+            
+        if filter_from_amount is not None:
+            
+            _query_params.append(('filter[fromAmount]', filter_from_amount))
+            
+        if filter_to_amount is not None:
+            
+            _query_params.append(('filter[toAmount]', filter_to_amount))
+            
+        if filter_no_amount is not None:
+            
+            _query_params.append(('filter[noAmount]', filter_no_amount))
+            
+        if filter_from_min_amount is not None:
+            
+            _query_params.append(('filter[fromMinAmount]', filter_from_min_amount))
+            
+        if filter_to_min_amount is not None:
+            
+            _query_params.append(('filter[toMinAmount]', filter_to_min_amount))
+            
+        if filter_no_min_amount is not None:
+            
+            _query_params.append(('filter[noMinAmount]', filter_no_min_amount))
+            
+        if filter_originator_name is not None:
+            
+            _query_params.append(('filter[originatorName]', filter_originator_name))
+            
+        if filter_no_originator_name is not None:
+            
+            _query_params.append(('filter[noOriginatorName]', filter_no_originator_name))
+            
+        if filter_check_number is not None:
+            
+            _query_params.append(('filter[checkNumber]', filter_check_number))
+            
+        if filter_type is not None:
+            
+            _query_params.append(('filter[type]', filter_type))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/vnd.api+json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/stop-payments',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def update_ach_stop_payment(
+        self,
+        stop_payment_id: StrictStr,
+        update_ach_stop_payment_request: UpdateAchStopPaymentRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> UpdateAchStopPayment200Response:
+        """Update an ACH stop payment
+
+        Update an AchStopPayment.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param update_ach_stop_payment_request: (required)
+        :type update_ach_stop_payment_request: UpdateAchStopPaymentRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_ach_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            update_ach_stop_payment_request=update_ach_stop_payment_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "UpdateAchStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def update_ach_stop_payment_with_http_info(
+        self,
+        stop_payment_id: StrictStr,
+        update_ach_stop_payment_request: UpdateAchStopPaymentRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[UpdateAchStopPayment200Response]:
+        """Update an ACH stop payment
+
+        Update an AchStopPayment.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param update_ach_stop_payment_request: (required)
+        :type update_ach_stop_payment_request: UpdateAchStopPaymentRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_ach_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            update_ach_stop_payment_request=update_ach_stop_payment_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "UpdateAchStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def update_ach_stop_payment_without_preload_content(
+        self,
+        stop_payment_id: StrictStr,
+        update_ach_stop_payment_request: UpdateAchStopPaymentRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Update an ACH stop payment
+
+        Update an AchStopPayment.
+
+        :param stop_payment_id: (required)
+        :type stop_payment_id: str
+        :param update_ach_stop_payment_request: (required)
+        :type update_ach_stop_payment_request: UpdateAchStopPaymentRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_ach_stop_payment_serialize(
+            stop_payment_id=stop_payment_id,
+            update_ach_stop_payment_request=update_ach_stop_payment_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "UpdateAchStopPayment200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _update_ach_stop_payment_serialize(
+        self,
+        stop_payment_id,
+        update_ach_stop_payment_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if stop_payment_id is not None:
+            _path_params['stopPaymentId'] = stop_payment_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if update_ach_stop_payment_request is not None:
+            _body_params = update_ach_stop_payment_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/vnd.api+json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/vnd.api+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/stop-payments/{stopPaymentId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+