Payout Types

Типы данных для работы с выплатами.

Payout

class aioyookassa.types.payout.Payout(*, id: str, amount: Money, status: PayoutStatus, payout_destination: BankCardPayoutDestination | SbpPayoutDestination | YooMoneyPayoutDestination, description: str | None = None, created_at: datetime, succeeded_at: datetime | None = None, deal: Deal | None = None, self_employed: SelfEmployed | None = None, receipt: PayoutReceipt | None = None, cancellation_details: CancellationDetails | None = None, metadata: dict | None = None, test: bool)

Bases: BaseModel

Payout object

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

PayoutDestination

Union тип для способов получения выплаты.

class aioyookassa.types.payout.BankCardPayoutDestination(*, type: str = 'bank_card', card: PayoutCardInfo)

Bases: BaseModel

Bank card payout destination

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class aioyookassa.types.payout.SbpPayoutDestination(*, type: str = 'sbp', bank_id: str, phone: str, recipient_checked: bool)

Bases: BaseModel

SBP (Fast Payments System) payout destination

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class aioyookassa.types.payout.YooMoneyPayoutDestination(*, type: str = 'yoo_money', account_number: str)

Bases: BaseModel

YooMoney wallet payout destination

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

SelfEmployed

class aioyookassa.types.payout.SelfEmployed(*, id: str, status: SelfEmployedStatus | None = None, created_at: datetime | None = None, itn: str | None = None, phone: str | None = None, confirmation: SelfEmployedConfirmation | None = None, test: bool | None = None)

Bases: BaseModel

Self-employed person data

Can be used in two contexts: 1. In Payout object - only id is required 2. In SelfEmployed API responses - all fields except itn, phone, confirmation are required

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

SelfEmployedConfirmation

class aioyookassa.types.payout.SelfEmployedConfirmation(*, type: str = 'redirect', confirmation_url: str)

Bases: BaseModel

Self-employed confirmation object

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

PayoutReceipt

class aioyookassa.types.payout.PayoutReceipt(*, service_name: str, npd_receipt_id: str | None = None, url: str | None = None, amount: Money | None = None)

Bases: BaseModel

Receipt data for self-employed payout

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

PayoutCardInfo

class aioyookassa.types.payout.PayoutCardInfo(*, first6: str, last4: str, card_type: str, issuer_country: str | None = None, issuer_name: str | None = None)

Bases: BaseModel

Bank card information for payout

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].