12363266691

Committed 16 Dec 2024 11:34PM UTC coverage: 96.282% (+0.006%) from 96.276%

Build # 12363266691

Build Type

Pull #1433

github

Committed by

web-flow

Commit Message

Merge 1fd756175 into d09a4d17f

Pull Request Pull Request #1433: Update generated code for beta

Run Details

1388 of 2123 branches covered (65.38%)

Branch coverage included in aggregate %.

396 of 409 new or added lines in 8 files covered. (96.82%)

1 existing line in 1 file now uncovered.

91071 of 93906 relevant lines covered (96.98%)

0.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.2

/stripe/treasury/_received_credit.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from stripe._test_helpers import APIResourceTestHelpers
from typing import ClassVar, List, Optional, cast
from typing_extensions import (
    Literal,
    NotRequired,
    Type,
    TypedDict,
    Unpack,
    TYPE_CHECKING,
)

if TYPE_CHECKING:
    from stripe._payout import Payout
    from stripe.treasury._credit_reversal import CreditReversal
    from stripe.treasury._outbound_payment import OutboundPayment
    from stripe.treasury._outbound_transfer import OutboundTransfer
    from stripe.treasury._transaction import Transaction


class ReceivedCredit(ListableAPIResource["ReceivedCredit"]):
    """
    ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
    """

    OBJECT_NAME: ClassVar[Literal["treasury.received_credit"]] = (
        "treasury.received_credit"
    )

    class InitiatingPaymentMethodDetails(StripeObject):
        class BillingDetails(StripeObject):
            class Address(StripeObject):
                city: Optional[str]
                """
                City, district, suburb, town, or village.
                """
                country: Optional[str]
                """
                Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
                """
                line1: Optional[str]
                """
                Address line 1 (e.g., street, PO Box, or company name).
                """
                line2: Optional[str]
                """
                Address line 2 (e.g., apartment, suite, unit, or building).
                """
                postal_code: Optional[str]
                """
                ZIP or postal code.
                """
                state: Optional[str]
                """
                State, county, province, or region.
                """

            address: Address
            email: Optional[str]
            """
            Email address.
            """
            name: Optional[str]
            """
            Full name.
            """
            _inner_class_types = {"address": Address}

        class FinancialAccount(StripeObject):
            id: str
            """
            The FinancialAccount ID.
            """
            network: Literal["stripe"]
            """
            The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
            """

        class UsBankAccount(StripeObject):
            bank_name: Optional[str]
            """
            Bank name.
            """
            last4: Optional[str]
            """
            The last four digits of the bank account number.
            """
            routing_number: Optional[str]
            """
            The routing number for the bank account.
            """

        balance: Optional[Literal["payments"]]
        """
        Set when `type` is `balance`.
        """
        billing_details: BillingDetails
        financial_account: Optional[FinancialAccount]
        issuing_card: Optional[str]
        """
        Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
        """
        type: Literal[
            "balance",
            "financial_account",
            "issuing_card",
            "stripe",
            "us_bank_account",
        ]
        """
        Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
        """
        us_bank_account: Optional[UsBankAccount]
        _inner_class_types = {
            "billing_details": BillingDetails,
            "financial_account": FinancialAccount,
            "us_bank_account": UsBankAccount,
        }

    class LinkedFlows(StripeObject):
        class SourceFlowDetails(StripeObject):
            credit_reversal: Optional["CreditReversal"]
            """
            You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
            """
            outbound_payment: Optional["OutboundPayment"]
            """
            Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).

            Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.

            Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
            """
            outbound_transfer: Optional["OutboundTransfer"]
            """
            Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.

            Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.

            Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
            """
            payout: Optional["Payout"]
            """
            A `Payout` object is created when you receive funds from Stripe, or when you
            initiate a payout to either a bank account or debit card of a [connected
            Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
            and list all payouts. Payouts are made on [varying
            schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
            industry.

            Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
            """
            type: Literal[
                "credit_reversal",
                "other",
                "outbound_payment",
                "outbound_transfer",
                "payout",
            ]
            """
            The type of the source flow that originated the ReceivedCredit.
            """

        credit_reversal: Optional[str]
        """
        The CreditReversal created as a result of this ReceivedCredit being reversed.
        """
        issuing_authorization: Optional[str]
        """
        Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
        """
        issuing_transaction: Optional[str]
        """
        Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.
        """
        source_flow: Optional[str]
        """
        ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
        """
        source_flow_details: Optional[SourceFlowDetails]
        """
        The expandable object of the source flow.
        """
        source_flow_type: Optional[str]
        """
        The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
        """
        _inner_class_types = {"source_flow_details": SourceFlowDetails}

    class NetworkDetails(StripeObject):
        class Ach(StripeObject):
            addenda: Optional[str]
            """
            ACH Addenda record
            """

        ach: Optional[Ach]
        """
        Details about an ACH transaction.
        """
        type: Literal["ach"]
        """
        The type of flow that originated the ReceivedCredit.
        """
        _inner_class_types = {"ach": Ach}

    class ReversalDetails(StripeObject):
        deadline: Optional[int]
        """
        Time before which a ReceivedCredit can be reversed.
        """
        restricted_reason: Optional[
            Literal[
                "already_reversed",
                "deadline_passed",
                "network_restricted",
                "other",
                "source_flow_restricted",
            ]
        ]
        """
        Set if a ReceivedCredit cannot be reversed.
        """

    class CreateParams(RequestOptions):
        amount: int
        """
        Amount (in cents) to be transferred.
        """
        currency: str
        """
        Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
        """
        description: NotRequired[str]
        """
        An arbitrary string attached to the object. Often useful for displaying to users.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        financial_account: str
        """
        The FinancialAccount to send funds to.
        """
        initiating_payment_method_details: NotRequired[
            "ReceivedCredit.CreateParamsInitiatingPaymentMethodDetails"
        ]
        """
        Initiating payment method details for the object.
        """
        network: Literal["ach", "us_domestic_wire"]
        """
        Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
        """
        network_details: NotRequired[
            "ReceivedCredit.CreateParamsNetworkDetails"
        ]
        """
        Details about the network used for the ReceivedCredit.
        """

    class CreateParamsInitiatingPaymentMethodDetails(TypedDict):
        type: Literal["us_bank_account"]
        """
        The source type.
        """
        us_bank_account: NotRequired[
            "ReceivedCredit.CreateParamsInitiatingPaymentMethodDetailsUsBankAccount"
        ]
        """
        Optional fields for `us_bank_account`.
        """

    class CreateParamsInitiatingPaymentMethodDetailsUsBankAccount(TypedDict):
        account_holder_name: NotRequired[str]
        """
        The bank account holder's name.
        """
        account_number: NotRequired[str]
        """
        The bank account number.
        """
        routing_number: NotRequired[str]
        """
        The bank account's routing number.
        """

    class CreateParamsNetworkDetails(TypedDict):
        ach: NotRequired["ReceivedCredit.CreateParamsNetworkDetailsAch"]
        """
        Optional fields for `ach`.
        """
        type: Literal["ach"]
        """
        The type of flow that originated the ReceivedCredit.
        """

    class CreateParamsNetworkDetailsAch(TypedDict):
        addenda: NotRequired[str]
        """
        ACH Addenda record
        """

    class ListParams(RequestOptions):
        ending_before: NotRequired[str]
        """
        A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        financial_account: str
        """
        The FinancialAccount that received the funds.
        """
        limit: NotRequired[int]
        """
        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
        """
        linked_flows: NotRequired["ReceivedCredit.ListParamsLinkedFlows"]
        """
        Only return ReceivedCredits described by the flow.
        """
        starting_after: NotRequired[str]
        """
        A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
        """
        status: NotRequired[Literal["failed", "succeeded"]]
        """
        Only return ReceivedCredits that have the given status: `succeeded` or `failed`.
        """

    class ListParamsLinkedFlows(TypedDict):
        source_flow_type: Literal[
            "credit_reversal",
            "other",
            "outbound_payment",
            "outbound_transfer",
            "payout",
        ]
        """
        The source flow type.
        """

    class RetrieveParams(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """

    amount: int
    """
    Amount (in cents) transferred.
    """
    created: int
    """
    Time at which the object was created. Measured in seconds since the Unix epoch.
    """
    currency: str
    """
    Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
    """
    description: str
    """
    An arbitrary string attached to the object. Often useful for displaying to users.
    """
    failure_code: Optional[
        Literal[
            "account_closed",
            "account_frozen",
            "international_transaction",
            "other",
        ]
    ]
    """
    Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
    """
    financial_account: Optional[str]
    """
    The FinancialAccount that received the funds.
    """
    hosted_regulatory_receipt_url: Optional[str]
    """
    A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
    """
    id: str
    """
    Unique identifier for the object.
    """
    initiating_payment_method_details: InitiatingPaymentMethodDetails
    linked_flows: LinkedFlows
    livemode: bool
    """
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
    """
    network: Literal["ach", "card", "stripe", "us_domestic_wire"]
    """
    The rails used to send the funds.
    """
    network_details: Optional[NetworkDetails]
    """
    Details specific to the money movement rails.
    """
    object: Literal["treasury.received_credit"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    reversal_details: Optional[ReversalDetails]
    """
    Details describing when a ReceivedCredit may be reversed.
    """
    status: Literal["failed", "succeeded"]
    """
    Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
    """
    transaction: Optional[ExpandableField["Transaction"]]
    """
    The Transaction associated with this object.
    """

    @classmethod
    def list(
        cls, **params: Unpack["ReceivedCredit.ListParams"]
    ) -> ListObject["ReceivedCredit"]:
        """
        Returns a list of ReceivedCredits.
        """
        result = cls._static_request(
            "get",
            cls.class_url(),
            params=params,
        )
        if not isinstance(result, ListObject):
            raise TypeError(
                "Expected list object from API, got %s"
                % (type(result).__name__)
            )

        return result

    @classmethod
    async def list_async(
        cls, **params: Unpack["ReceivedCredit.ListParams"]
    ) -> ListObject["ReceivedCredit"]:
        """
        Returns a list of ReceivedCredits.
        """
        result = await cls._static_request_async(
            "get",
            cls.class_url(),
            params=params,
        )
        if not isinstance(result, ListObject):
            raise TypeError(
                "Expected list object from API, got %s"
                % (type(result).__name__)
            )

        return result

    @classmethod
    def retrieve(
        cls, id: str, **params: Unpack["ReceivedCredit.RetrieveParams"]
    ) -> "ReceivedCredit":
        """
        Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["ReceivedCredit.RetrieveParams"]
    ) -> "ReceivedCredit":
        """
        Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

    class TestHelpers(APIResourceTestHelpers["ReceivedCredit"]):
        _resource_cls: Type["ReceivedCredit"]

        @classmethod
        def create(
            cls, **params: Unpack["ReceivedCredit.CreateParams"]
        ) -> "ReceivedCredit":
            """
            Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
            """
            return cast(
                "ReceivedCredit",
                cls._static_request(
                    "post",
                    "/v1/test_helpers/treasury/received_credits",
                    params=params,
                ),
            )

        @classmethod
        async def create_async(
            cls, **params: Unpack["ReceivedCredit.CreateParams"]
        ) -> "ReceivedCredit":
            """
            Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
            """
            return cast(
                "ReceivedCredit",
                await cls._static_request_async(
                    "post",
                    "/v1/test_helpers/treasury/received_credits",
                    params=params,
                ),
            )

    @property
    def test_helpers(self):
        return self.TestHelpers(self)

    _inner_class_types = {
        "initiating_payment_method_details": InitiatingPaymentMethodDetails,
        "linked_flows": LinkedFlows,
        "network_details": NetworkDetails,
        "reversal_details": ReversalDetails,
    }


ReceivedCredit.TestHelpers._resource_cls = ReceivedCredit

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._expandable_field import ExpandableField	1✔
4	from stripe._list_object import ListObject	1✔
5	from stripe._listable_api_resource import ListableAPIResource	1✔
6	from stripe._request_options import RequestOptions	1✔
7	from stripe._stripe_object import StripeObject	1✔
8	from stripe._test_helpers import APIResourceTestHelpers	1✔
9	from typing import ClassVar, List, Optional, cast	1✔
10	from typing_extensions import (	1✔
11	Literal,
12	NotRequired,
13	Type,
14	TypedDict,
15	Unpack,
16	TYPE_CHECKING,
17	)
18
19	if TYPE_CHECKING:	1!
20	from stripe._payout import Payout	×
21	from stripe.treasury._credit_reversal import CreditReversal	×
22	from stripe.treasury._outbound_payment import OutboundPayment	×
NEW 23	from stripe.treasury._outbound_transfer import OutboundTransfer	×
UNCOV 24	from stripe.treasury._transaction import Transaction	×
25
26
27	class ReceivedCredit(ListableAPIResource["ReceivedCredit"]):	1✔
28	"""
29	ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
30	"""
31
32	OBJECT_NAME: ClassVar[Literal["treasury.received_credit"]] = (	1✔
33	"treasury.received_credit"
34	)
35
36	class InitiatingPaymentMethodDetails(StripeObject):	1✔
37	class BillingDetails(StripeObject):	1✔
38	class Address(StripeObject):	1✔
39	city: Optional[str]	1✔
40	"""	1✔
41	City, district, suburb, town, or village.
42	"""
43	country: Optional[str]	1✔
44	"""	1✔
45	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
46	"""
47	line1: Optional[str]	1✔
48	"""	1✔
49	Address line 1 (e.g., street, PO Box, or company name).
50	"""
51	line2: Optional[str]	1✔
52	"""	1✔
53	Address line 2 (e.g., apartment, suite, unit, or building).
54	"""
55	postal_code: Optional[str]	1✔
56	"""	1✔
57	ZIP or postal code.
58	"""
59	state: Optional[str]	1✔
60	"""	1✔
61	State, county, province, or region.
62	"""
63
64	address: Address	1✔
65	email: Optional[str]	1✔
66	"""	1✔
67	Email address.
68	"""
69	name: Optional[str]	1✔
70	"""	1✔
71	Full name.
72	"""
73	_inner_class_types = {"address": Address}	1✔
74
75	class FinancialAccount(StripeObject):	1✔
76	id: str	1✔
77	"""	1✔
78	The FinancialAccount ID.
79	"""
80	network: Literal["stripe"]	1✔
81	"""	1✔
82	The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
83	"""
84
85	class UsBankAccount(StripeObject):	1✔
86	bank_name: Optional[str]	1✔
87	"""	1✔
88	Bank name.
89	"""
90	last4: Optional[str]	1✔
91	"""	1✔
92	The last four digits of the bank account number.
93	"""
94	routing_number: Optional[str]	1✔
95	"""	1✔
96	The routing number for the bank account.
97	"""
98
99	balance: Optional[Literal["payments"]]	1✔
100	"""	1✔
101	Set when `type` is `balance`.
102	"""
103	billing_details: BillingDetails	1✔
104	financial_account: Optional[FinancialAccount]	1✔
105	issuing_card: Optional[str]	1✔
106	"""	1✔
107	Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
108	"""
109	type: Literal[	1✔
110	"balance",
111	"financial_account",
112	"issuing_card",
113	"stripe",
114	"us_bank_account",
115	]
116	"""	1✔
117	Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
118	"""
119	us_bank_account: Optional[UsBankAccount]	1✔
120	_inner_class_types = {	1✔
121	"billing_details": BillingDetails,
122	"financial_account": FinancialAccount,
123	"us_bank_account": UsBankAccount,
124	}
125
126	class LinkedFlows(StripeObject):	1✔
127	class SourceFlowDetails(StripeObject):	1✔
128	credit_reversal: Optional["CreditReversal"]	1✔
129	"""	1✔
130	You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
131	"""
132	outbound_payment: Optional["OutboundPayment"]	1✔
133	"""	1✔
134	Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
135
136	Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
137
138	Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
139	"""
140	outbound_transfer: Optional["OutboundTransfer"]	1✔
141	"""	1✔
142	Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
143
144	Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
145
146	Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
147	"""
148	payout: Optional["Payout"]	1✔
149	"""	1✔
150	A `Payout` object is created when you receive funds from Stripe, or when you
151	initiate a payout to either a bank account or debit card of a [connected
152	Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
153	and list all payouts. Payouts are made on [varying
154	schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
155	industry.
156
157	Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
158	"""
159	type: Literal[	1✔
160	"credit_reversal",
161	"other",
162	"outbound_payment",
163	"outbound_transfer",
164	"payout",
165	]
166	"""	1✔
167	The type of the source flow that originated the ReceivedCredit.
168	"""
169
170	credit_reversal: Optional[str]	1✔
171	"""	1✔
172	The CreditReversal created as a result of this ReceivedCredit being reversed.
173	"""
174	issuing_authorization: Optional[str]	1✔
175	"""	1✔
176	Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
177	"""
178	issuing_transaction: Optional[str]	1✔
179	"""	1✔
180	Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.
181	"""
182	source_flow: Optional[str]	1✔
183	"""	1✔
184	ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
185	"""
186	source_flow_details: Optional[SourceFlowDetails]	1✔
187	"""	1✔
188	The expandable object of the source flow.
189	"""
190	source_flow_type: Optional[str]	1✔
191	"""	1✔
192	The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
193	"""
194	_inner_class_types = {"source_flow_details": SourceFlowDetails}	1✔
195
196	class NetworkDetails(StripeObject):	1✔
197	class Ach(StripeObject):	1✔
198	addenda: Optional[str]	1✔
199	"""	1✔
200	ACH Addenda record
201	"""
202
203	ach: Optional[Ach]	1✔
204	"""	1✔
205	Details about an ACH transaction.
206	"""
207	type: Literal["ach"]	1✔
208	"""	1✔
209	The type of flow that originated the ReceivedCredit.
210	"""
211	_inner_class_types = {"ach": Ach}	1✔
212
213	class ReversalDetails(StripeObject):	1✔
214	deadline: Optional[int]	1✔
215	"""	1✔
216	Time before which a ReceivedCredit can be reversed.
217	"""
218	restricted_reason: Optional[	1✔
219	Literal[
220	"already_reversed",
221	"deadline_passed",
222	"network_restricted",
223	"other",
224	"source_flow_restricted",
225	]
226	]
227	"""	1✔
228	Set if a ReceivedCredit cannot be reversed.
229	"""
230
231	class CreateParams(RequestOptions):	1✔
232	amount: int	1✔
233	"""	1✔
234	Amount (in cents) to be transferred.
235	"""
236	currency: str	1✔
237	"""	1✔
238	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
239	"""
240	description: NotRequired[str]	1✔
241	"""	1✔
242	An arbitrary string attached to the object. Often useful for displaying to users.
243	"""
244	expand: NotRequired[List[str]]	1✔
245	"""	1✔
246	Specifies which fields in the response should be expanded.
247	"""
248	financial_account: str	1✔
249	"""	1✔
250	The FinancialAccount to send funds to.
251	"""
252	initiating_payment_method_details: NotRequired[	1✔
253	"ReceivedCredit.CreateParamsInitiatingPaymentMethodDetails"
254	]
255	"""	1✔
256	Initiating payment method details for the object.
257	"""
258	network: Literal["ach", "us_domestic_wire"]	1✔
259	"""	1✔
260	Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
261	"""
262	network_details: NotRequired[	1✔
263	"ReceivedCredit.CreateParamsNetworkDetails"
264	]
265	"""	1✔
266	Details about the network used for the ReceivedCredit.
267	"""
268
269	class CreateParamsInitiatingPaymentMethodDetails(TypedDict):	1✔
270	type: Literal["us_bank_account"]	1✔
271	"""	1✔
272	The source type.
273	"""
274	us_bank_account: NotRequired[	1✔
275	"ReceivedCredit.CreateParamsInitiatingPaymentMethodDetailsUsBankAccount"
276	]
277	"""	1✔
278	Optional fields for `us_bank_account`.
279	"""
280
281	class CreateParamsInitiatingPaymentMethodDetailsUsBankAccount(TypedDict):	1✔
282	account_holder_name: NotRequired[str]	1✔
283	"""	1✔
284	The bank account holder's name.
285	"""
286	account_number: NotRequired[str]	1✔
287	"""	1✔
288	The bank account number.
289	"""
290	routing_number: NotRequired[str]	1✔
291	"""	1✔
292	The bank account's routing number.
293	"""
294
295	class CreateParamsNetworkDetails(TypedDict):	1✔
296	ach: NotRequired["ReceivedCredit.CreateParamsNetworkDetailsAch"]	1✔
297	"""	1✔
298	Optional fields for `ach`.
299	"""
300	type: Literal["ach"]	1✔
301	"""	1✔
302	The type of flow that originated the ReceivedCredit.
303	"""
304
305	class CreateParamsNetworkDetailsAch(TypedDict):	1✔
306	addenda: NotRequired[str]	1✔
307	"""	1✔
308	ACH Addenda record
309	"""
310
311	class ListParams(RequestOptions):	1✔
312	ending_before: NotRequired[str]	1✔
313	"""	1✔
314	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
315	"""
316	expand: NotRequired[List[str]]	1✔
317	"""	1✔
318	Specifies which fields in the response should be expanded.
319	"""
320	financial_account: str	1✔
321	"""	1✔
322	The FinancialAccount that received the funds.
323	"""
324	limit: NotRequired[int]	1✔
325	"""	1✔
326	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
327	"""
328	linked_flows: NotRequired["ReceivedCredit.ListParamsLinkedFlows"]	1✔
329	"""	1✔
330	Only return ReceivedCredits described by the flow.
331	"""
332	starting_after: NotRequired[str]	1✔
333	"""	1✔
334	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
335	"""
336	status: NotRequired[Literal["failed", "succeeded"]]	1✔
337	"""	1✔
338	Only return ReceivedCredits that have the given status: `succeeded` or `failed`.
339	"""
340
341	class ListParamsLinkedFlows(TypedDict):	1✔
342	source_flow_type: Literal[	1✔
343	"credit_reversal",
344	"other",
345	"outbound_payment",
346	"outbound_transfer",
347	"payout",
348	]
349	"""	1✔
350	The source flow type.
351	"""
352
353	class RetrieveParams(RequestOptions):	1✔
354	expand: NotRequired[List[str]]	1✔
355	"""	1✔
356	Specifies which fields in the response should be expanded.
357	"""
358
359	amount: int	1✔
360	"""	1✔
361	Amount (in cents) transferred.
362	"""
363	created: int	1✔
364	"""	1✔
365	Time at which the object was created. Measured in seconds since the Unix epoch.
366	"""
367	currency: str	1✔
368	"""	1✔
369	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
370	"""
371	description: str	1✔
372	"""	1✔
373	An arbitrary string attached to the object. Often useful for displaying to users.
374	"""
375	failure_code: Optional[	1✔
376	Literal[
377	"account_closed",
378	"account_frozen",
379	"international_transaction",
380	"other",
381	]
382	]
383	"""	1✔
384	Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
385	"""
386	financial_account: Optional[str]	1✔
387	"""	1✔
388	The FinancialAccount that received the funds.
389	"""
390	hosted_regulatory_receipt_url: Optional[str]	1✔
391	"""	1✔
392	A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
393	"""
394	id: str	1✔
395	"""	1✔
396	Unique identifier for the object.
397	"""
398	initiating_payment_method_details: InitiatingPaymentMethodDetails	1✔
399	linked_flows: LinkedFlows	1✔
400	livemode: bool	1✔
401	"""	1✔
402	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
403	"""
404	network: Literal["ach", "card", "stripe", "us_domestic_wire"]	1✔
405	"""	1✔
406	The rails used to send the funds.
407	"""
408	network_details: Optional[NetworkDetails]	1✔
409	"""	1✔
410	Details specific to the money movement rails.
411	"""
412	object: Literal["treasury.received_credit"]	1✔
413	"""	1✔
414	String representing the object's type. Objects of the same type share the same value.
415	"""
416	reversal_details: Optional[ReversalDetails]	1✔
417	"""	1✔
418	Details describing when a ReceivedCredit may be reversed.
419	"""
420	status: Literal["failed", "succeeded"]	1✔
421	"""	1✔
422	Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
423	"""
424	transaction: Optional[ExpandableField["Transaction"]]	1✔
425	"""	1✔
426	The Transaction associated with this object.
427	"""
428
429	@classmethod	1✔
430	def list(	1✔
431	cls, **params: Unpack["ReceivedCredit.ListParams"]
432	) -> ListObject["ReceivedCredit"]:
433	"""
434	Returns a list of ReceivedCredits.
435	"""
436	result = cls._static_request(	1✔
437	"get",
438	cls.class_url(),
439	params=params,
440	)
441	if not isinstance(result, ListObject):	1!
442	raise TypeError(	×
443	"Expected list object from API, got %s"
444	% (type(result).__name__)
445	)
446
447	return result	1✔
448
449	@classmethod	1✔
450	async def list_async(	1✔
451	cls, **params: Unpack["ReceivedCredit.ListParams"]
452	) -> ListObject["ReceivedCredit"]:
453	"""
454	Returns a list of ReceivedCredits.
455	"""
456	result = await cls._static_request_async(	1✔
457	"get",
458	cls.class_url(),
459	params=params,
460	)
461	if not isinstance(result, ListObject):	1!
462	raise TypeError(	×
463	"Expected list object from API, got %s"
464	% (type(result).__name__)
465	)
466
467	return result	1✔
468
469	@classmethod	1✔
470	def retrieve(	1✔
471	cls, id: str, **params: Unpack["ReceivedCredit.RetrieveParams"]
472	) -> "ReceivedCredit":
473	"""
474	Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
475	"""
476	instance = cls(id, **params)	1✔
477	instance.refresh()	1✔
478	return instance	1✔
479
480	@classmethod	1✔
481	async def retrieve_async(	1✔
482	cls, id: str, **params: Unpack["ReceivedCredit.RetrieveParams"]
483	) -> "ReceivedCredit":
484	"""
485	Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
486	"""
487	instance = cls(id, **params)	1✔
488	await instance.refresh_async()	1✔
489	return instance	1✔
490
491	class TestHelpers(APIResourceTestHelpers["ReceivedCredit"]):	1✔
492	_resource_cls: Type["ReceivedCredit"]	1✔
493
494	@classmethod	1✔
495	def create(	1✔
496	cls, **params: Unpack["ReceivedCredit.CreateParams"]
497	) -> "ReceivedCredit":
498	"""
499	Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
500	"""
501	return cast(	1✔
502	"ReceivedCredit",
503	cls._static_request(
504	"post",
505	"/v1/test_helpers/treasury/received_credits",
506	params=params,
507	),
508	)
509
510	@classmethod	1✔
511	async def create_async(	1✔
512	cls, **params: Unpack["ReceivedCredit.CreateParams"]
513	) -> "ReceivedCredit":
514	"""
515	Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
516	"""
517	return cast(	1✔
518	"ReceivedCredit",
519	await cls._static_request_async(
520	"post",
521	"/v1/test_helpers/treasury/received_credits",
522	params=params,
523	),
524	)
525
526	@property	1✔
527	def test_helpers(self):	1✔
528	return self.TestHelpers(self)	×
529
530	_inner_class_types = {	1✔
531	"initiating_payment_method_details": InitiatingPaymentMethodDetails,
532	"linked_flows": LinkedFlows,
533	"network_details": NetworkDetails,
534	"reversal_details": ReversalDetails,
535	}
536
537
538	ReceivedCredit.TestHelpers._resource_cls = ReceivedCredit	1✔

stripe / stripe-python / 12363266691

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous