# This file was auto-generated by Fern from our API Definition.

import typing

import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
from .error import Error
from .payment_refund import PaymentRefund


class GetPaymentRefundResponse(UncheckedBaseModel):
    """
    Defines the response returned by [GetRefund](api-endpoint:Refunds-GetPaymentRefund).

    Note: If there are errors processing the request, the refund field might not be
    present or it might be present in a FAILED state.
    """

    errors: typing.Optional[typing.List[Error]] = pydantic.Field(default=None)
    """
    Information about errors encountered during the request.
    """

    refund: typing.Optional[PaymentRefund] = pydantic.Field(default=None)
    """
    The requested `PaymentRefund`.
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
