Номинальные счета (tbank.nominal_accounts)¶
Номинальный счёт — счёт, на котором компания-оператор держит деньги в интересах третьих лиц (бенефициаров). SDK покрывает весь жизненный цикл: бенефициары и их банковские реквизиты, скоринг в финмониторинге, сделки с этапами и депонентами/реципиентами, платежи (обычные и налоговые), балансы, холды и переводы между виртуальными счетами.
Хосты: большинство методов — на
business.tbank.ru/openapiпо Bearer-токену; просмотр карточек сделки, этапа и платежа, проверка сделки и все операции с переводами — наsecured-openapi.tbank.ruпо mTLS (cert).Идемпотентность: методы создания ресурсов принимают
idempotency_key(по умолчанию генерируется автоматически) — уходит в заголовокIdempotency-Key.Суммы:
Decimalв рублях. Провод:camelCase.Клиенты:
tbank.nominal_accounts.NominalAccountsClient(async) иtbank.nominal_accounts.sync.NominalAccountsClient(sync).
Полиморфные модели¶
Бенефициары, банковские реквизиты, платежи, скоринг и запросы на добавление карты —
дискриминированные объединения. Тип выбирается по полю type (или status), SDK
сам разбирает ответ в конкретный класс:
from tbank.nominal_accounts.models import (
BeneficiaryFlResidentResponse, CardBankDetailsResponse, RegularPaymentResponse,
)
b = await client.get_beneficiary("b-1")
if isinstance(b, BeneficiaryFlResidentResponse):
print(b.snils)
Бенефициары и реквизиты¶
from tbank.nominal_accounts import NominalAccountsClient
from tbank.nominal_accounts.models import (
BeneficiaryFlResidentRequest, Address, Passport, RkcBankDetailsRequest,
)
client = NominalAccountsClient(token="business-token")
# создать бенефициара (физлицо-резидент)
b = await client.create_beneficiary(BeneficiaryFlResidentRequest(
first_name="Иван", last_name="Петров", is_self_employed=True,
birth_date="1990-05-01", citizenship="RU",
documents=[Passport(serial="4509", number="123456",
issued_on="2010-06-01", division="770-001")],
addresses=[Address(type="REGISTRATION_ADDRESS", address="Москва")],
))
# добавить реквизиты для выплат (по банковским реквизитам)
bd = await client.create_bank_details(b.beneficiary_id, RkcBankDetailsRequest(
bik="044525225", bank_name="Т-Банк",
account_number="40817810000000000001",
corr_account_number="30101810000000000225",
))
await client.set_default_bank_details(b.beneficiary_id, bd.bank_details_id)
# проверка в финмониторинге
await client.get_beneficiaries_scoring(beneficiary_id=b.beneficiary_id, passed=True)
Сделка, этапы, реципиенты¶
from tbank.nominal_accounts.models import (
DealRequest, StepRequest, RecipientRequest, DeponentRequest,
)
from decimal import Decimal
deal = await client.create_deal(DealRequest(account_number="40817810000000000001"))
step = await client.create_step(deal.deal_id, StepRequest(description="Этап 1"))
# кто вносит деньги (депонент) и кто получает (реципиент)
await client.set_deponent(deal.deal_id, step.step_id, payer_id,
DeponentRequest(amount=Decimal("10000")))
await client.create_recipient(deal.deal_id, step.step_id, RecipientRequest(
beneficiary_id=b.beneficiary_id, amount=Decimal("10000"), purpose="Оплата услуг",
))
await client.accept_deal(deal.deal_id) # согласовать сделку
await client.get_deal_validity(deal.deal_id) # mTLS: можно ли платить
await client.complete_step(deal.deal_id, step.step_id) # провести выплаты
Платежи и виртуальные счета¶
from tbank.nominal_accounts.models import (
CreateRegularPaymentRequest, CreateTransferRequest, TransferParty,
)
# обычный платёж бенефициару
pay = await client.create_payment(CreateRegularPaymentRequest(
beneficiary_id=b.beneficiary_id, account_number="40817810000000000001",
amount=Decimal("500.00"), purpose="Выплата",
))
await client.get_payment(pay.payment_id) # mTLS
# балансы и холды на виртуальных счетах
await client.list_balances(account_number="40817810000000000001")
await client.list_holds(beneficiary_id=b.beneficiary_id)
# перевод между виртуальными счетами (mTLS)
await client.create_transfer(CreateTransferRequest(
account_number="40817810000000000001",
from_=TransferParty(beneficiary_id=payer_id),
to=TransferParty(beneficiary_id=b.beneficiary_id),
amount=Decimal("300"),
))
Неопознанные входящие пополнения разбираются через list_incoming_transactions
и identify_incoming_transaction (распределение суммы по бенефициарам).
Клиент¶
- class tbank.nominal_accounts.aio.NominalAccountsClient(token, *, base_url=None, secured_base_url=None, sandbox=False, cert=None, verify=True, retry=None, transport=None, secured_transport=None)[исходный код]¶
Базовые классы:
BaseAsyncClientАсинхронный клиент номинальных счетов: бенефициары и их банковские реквизиты, скоринг, сделки/этапы/депоненты/реципиенты, платежи, балансы, холды и переводы между виртуальными счетами.
Просмотр карточек сделки, этапа и платежа, проверка сделки и все операции с переводами идут на secured-хост и требуют mTLS-сертификата (cert); остальные методы — на обычном хосте по Bearer-токену. Методы создания ресурсов принимают ключ идемпотентности idempotency_key (по умолчанию генерируется автоматически).
- Параметры:
token (str)
base_url (Optional[str])
secured_base_url (Optional[str])
sandbox (bool)
cert (Optional[CertTypes])
verify (VerifyTypes)
retry (Optional[RetryPolicy])
transport (Optional[AsyncTransport])
secured_transport (Optional[AsyncTransport])
- decimal_body: ClassVar[bool] = True¶
True → тело парсится с parse_float=Decimal (точные денежные суммы).
- async list_beneficiaries(*, offset=None, limit=None)[исходный код]¶
Список бенефициаров компании.
- Параметры:
- Тип результата:
- async create_beneficiary(request, *, idempotency_key=None)[исходный код]¶
Создать бенефициара.
- Параметры:
request (Annotated[BeneficiaryFlResidentRequest | BeneficiaryFlNonresidentRequest | BeneficiaryIpResidentRequest | BeneficiaryIpNonresidentRequest | BeneficiaryUlResidentRequest | BeneficiaryUlNonresidentRequest | BeneficiaryLiteContactRequest, FieldInfo(annotation=NoneType, required=True, discriminator='type')])
idempotency_key (str | None)
- Тип результата:
Annotated[BeneficiaryFlResidentResponse | BeneficiaryFlNonresidentResponse | BeneficiaryIpResidentResponse | BeneficiaryIpNonresidentResponse | BeneficiaryUlResidentResponse | BeneficiaryUlNonresidentResponse | BeneficiaryLiteContactResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async get_beneficiary(beneficiary_id)[исходный код]¶
Карточка бенефициара.
- Параметры:
beneficiary_id (str)
- Тип результата:
Annotated[BeneficiaryFlResidentResponse | BeneficiaryFlNonresidentResponse | BeneficiaryIpResidentResponse | BeneficiaryIpNonresidentResponse | BeneficiaryUlResidentResponse | BeneficiaryUlNonresidentResponse | BeneficiaryLiteContactResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async update_beneficiary(beneficiary_id, request)[исходный код]¶
Обновить бенефициара.
- Параметры:
beneficiary_id (str)
request (Annotated[BeneficiaryFlResidentRequest | BeneficiaryFlNonresidentRequest | BeneficiaryIpResidentRequest | BeneficiaryIpNonresidentRequest | BeneficiaryUlResidentRequest | BeneficiaryUlNonresidentRequest | BeneficiaryLiteContactRequest, FieldInfo(annotation=NoneType, required=True, discriminator='type')])
- Тип результата:
Annotated[BeneficiaryFlResidentResponse | BeneficiaryFlNonresidentResponse | BeneficiaryIpResidentResponse | BeneficiaryIpNonresidentResponse | BeneficiaryUlResidentResponse | BeneficiaryUlNonresidentResponse | BeneficiaryLiteContactResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async create_add_card_request(beneficiary_id, request, *, idempotency_key=None)[исходный код]¶
Создать запрос на добавление карты бенефициару.
- Параметры:
beneficiary_id (str)
request (AddCardRequest)
idempotency_key (str | None)
- Тип результата:
Annotated[PendingAddCardResponse | ReadyAddCardResponse | FailedAddCardResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“status“)]
- async get_add_card_request(beneficiary_id, add_card_request_id)[исходный код]¶
Статус запроса на добавление карты.
- Параметры:
- Тип результата:
Annotated[PendingAddCardResponse | ReadyAddCardResponse | FailedAddCardResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“status“)]
- async list_bank_details(beneficiary_id, *, offset=None, limit=None)[исходный код]¶
Список банковских реквизитов бенефициара.
- Параметры:
- Тип результата:
- async create_bank_details(beneficiary_id, request, *, idempotency_key=None)[исходный код]¶
Добавить банковские реквизиты бенефициару.
- Параметры:
beneficiary_id (str)
request (Annotated[RkcBankDetailsRequest | CardBankDetailsRequest | SbpBankDetailsRequest, FieldInfo(annotation=NoneType, required=True, discriminator='type')])
idempotency_key (str | None)
- Тип результата:
Annotated[RkcBankDetailsResponse | CardBankDetailsResponse | SbpBankDetailsResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async get_bank_details(beneficiary_id, bank_details_id)[исходный код]¶
Карточка банковских реквизитов.
- Параметры:
- Тип результата:
Annotated[RkcBankDetailsResponse | CardBankDetailsResponse | SbpBankDetailsResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async update_bank_details(beneficiary_id, bank_details_id, request)[исходный код]¶
Обновить банковские реквизиты.
- Параметры:
beneficiary_id (str)
bank_details_id (str)
request (Annotated[RkcBankDetailsRequest | CardBankDetailsRequest | SbpBankDetailsRequest, FieldInfo(annotation=NoneType, required=True, discriminator='type')])
- Тип результата:
Annotated[RkcBankDetailsResponse | CardBankDetailsResponse | SbpBankDetailsResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async delete_bank_details(beneficiary_id, bank_details_id)[исходный код]¶
Удалить банковские реквизиты.
- async set_default_bank_details(beneficiary_id, bank_details_id)[исходный код]¶
Сделать реквизиты основными для бенефициара.
- async get_beneficiaries_scoring(*, beneficiary_id=None, passed=None, offset=None, limit=None)[исходный код]¶
Результаты проверки бенефициаров в финансовом мониторинге.
- Параметры:
- Тип результата:
- async list_deals(*, offset=None, limit=None)[исходный код]¶
Список сделок.
- Параметры:
- Тип результата:
- async create_deal(request, *, idempotency_key=None)[исходный код]¶
Создать сделку (черновик).
- Параметры:
request (DealRequest)
idempotency_key (str | None)
- Тип результата:
- async get_deal(deal_id)[исходный код]¶
Карточка сделки (mTLS).
- Параметры:
deal_id (str)
- Тип результата:
- async delete_deal(deal_id)[исходный код]¶
Удалить сделку-черновик.
- Параметры:
deal_id (str)
- Тип результата:
None
- async accept_deal(deal_id)[исходный код]¶
Принять (согласовать) сделку.
- Параметры:
deal_id (str)
- Тип результата:
None
- async cancel_deal(deal_id)[исходный код]¶
Отменить сделку.
- Параметры:
deal_id (str)
- Тип результата:
None
- async draft_deal(deal_id)[исходный код]¶
Вернуть сделку в черновик.
- Параметры:
deal_id (str)
- Тип результата:
None
- async get_deal_validity(deal_id)[исходный код]¶
Проверить возможность проведения платежей по сделке (mTLS).
- Параметры:
deal_id (str)
- Тип результата:
- async list_steps(deal_id, *, offset=None, limit=None)[исходный код]¶
Список этапов сделки.
- Параметры:
- Тип результата:
- async create_step(deal_id, request, *, idempotency_key=None)[исходный код]¶
Создать этап сделки.
- Параметры:
deal_id (str)
request (StepRequest)
idempotency_key (str | None)
- Тип результата:
- async get_step(deal_id, step_id)[исходный код]¶
Карточка этапа сделки (mTLS).
- Параметры:
- Тип результата:
- async update_step(deal_id, step_id, request)[исходный код]¶
Обновить этап сделки.
- Параметры:
deal_id (str)
step_id (str)
request (StepRequest)
- Тип результата:
- async delete_step(deal_id, step_id)[исходный код]¶
Удалить этап сделки.
- async complete_step(deal_id, step_id)[исходный код]¶
Завершить этап сделки (провести выплаты).
- async list_deponents(deal_id, step_id, *, offset=None, limit=None)[исходный код]¶
Список депонентов этапа сделки.
- Параметры:
- Тип результата:
- async get_deponent(deal_id, step_id, beneficiary_id)[исходный код]¶
Карточка депонента этапа сделки.
- Параметры:
- Тип результата:
- async set_deponent(deal_id, step_id, beneficiary_id, request)[исходный код]¶
Добавить/обновить депонента этапа сделки.
- Параметры:
deal_id (str)
step_id (str)
beneficiary_id (str)
request (DeponentRequest)
- Тип результата:
- async delete_deponent(deal_id, step_id, beneficiary_id)[исходный код]¶
Удалить депонента этапа сделки.
- async list_recipients(deal_id, step_id, *, offset=None, limit=None)[исходный код]¶
Список реципиентов этапа сделки.
- Параметры:
- Тип результата:
- async create_recipient(deal_id, step_id, request, *, idempotency_key=None)[исходный код]¶
Добавить реципиента этапа сделки.
- Параметры:
deal_id (str)
step_id (str)
request (RecipientRequest)
idempotency_key (str | None)
- Тип результата:
- async get_recipient(deal_id, step_id, recipient_id)[исходный код]¶
Карточка реципиента этапа сделки.
- Параметры:
- Тип результата:
- async update_recipient(deal_id, step_id, recipient_id, request)[исходный код]¶
Обновить реципиента этапа сделки.
- Параметры:
deal_id (str)
step_id (str)
recipient_id (str)
request (RecipientRequest)
- Тип результата:
- async delete_recipient(deal_id, step_id, recipient_id)[исходный код]¶
Удалить реципиента этапа сделки.
- async update_recipient_bank_details(deal_id, step_id, recipient_id, request)[исходный код]¶
Обновить банковские реквизиты реципиента.
- Параметры:
deal_id (str)
step_id (str)
recipient_id (str)
request (UpdateRecipientBankDetailsRequest)
- Тип результата:
None
- async list_payments(*, beneficiary_id=None, deal_id=None, account_number=None, offset=None, limit=None)[исходный код]¶
Список платежей с номинального счёта.
- async create_payment(request, *, idempotency_key=None)[исходный код]¶
Создать платёж (обычный или налоговый).
- Параметры:
request (Annotated[CreateRegularPaymentRequest | CreateTaxPaymentRequest, FieldInfo(annotation=NoneType, required=True, discriminator='type')])
idempotency_key (str | None)
- Тип результата:
Annotated[RegularPaymentResponse | TaxPaymentResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async get_payment(payment_id)[исходный код]¶
Карточка платежа (mTLS).
- Параметры:
payment_id (str)
- Тип результата:
Annotated[RegularPaymentResponse | TaxPaymentResponse, FieldInfo(annotation=NoneType, required=True, discriminator=“type“)]
- async retry_payment(payment_id)[исходный код]¶
Повторить неуспешный платёж.
- Параметры:
payment_id (str)
- Тип результата:
- async list_incoming_transactions(*, account_number=None, offset=None, limit=None)[исходный код]¶
Список неидентифицированных пополнений.
- Параметры:
- Тип результата:
- async identify_incoming_transaction(operation_id, request)[исходный код]¶
Идентифицировать пополнение (распределить по бенефициарам).
- Параметры:
operation_id (str)
request (IdentifyIncomingTransactionRequest)
- Тип результата:
None
- async list_balances(*, account_number=None, beneficiary_id=None, offset=None, limit=None)[исходный код]¶
Балансы бенефициаров на виртуальных счетах.
- Параметры:
- Тип результата:
- async list_holds(*, account_number=None, beneficiary_id=None, offset=None, limit=None)[исходный код]¶
Заблокированные средства (холды) на виртуальных счетах.
- Параметры:
- Тип результата:
- async list_transfers(account_number, *, deal_id=None, from_beneficiary_id=None, to_beneficiary_id=None, offset=None, limit=None)[исходный код]¶
Список переводов между виртуальными счетами (mTLS).
- async create_transfer(request, *, idempotency_key=None)[исходный код]¶
Создать перевод между виртуальными счетами (mTLS).
- Параметры:
request (CreateTransferRequest)
idempotency_key (str | None)
- Тип результата:
- async get_transfer(transfer_id)[исходный код]¶
Карточка перевода между виртуальными счетами (mTLS).
- Параметры:
transfer_id (str)
- Тип результата:
Модели¶
- class tbank.nominal_accounts.models.NominalModel[исходный код]¶
Базовые классы:
BaseModelБазовая модель домена: snake_case в Python, camelCase на проводе.
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.Passport(*, type='PASSPORT', serial, number, date, division, organization=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ForeignPassport(*, type='FOREIGN_PASSPORT', number, date, organization)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ForeignPassportOfForeignCitizens(*, type='FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS', number, date, organization)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.OfficialPassport(*, type='OFFICIAL_PASSPORT', number, date, organization)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DiplomaticPassport(*, type='DIPLOMATIC_PASSPORT', number, date, organization)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.MigrationCard(*, type='MIGRATION_CARD', number, date, expireDate)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.TemporaryResidencePermit(*, type='TEMPORARY_RESIDENCE_PERMIT', number, date, expireDate)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.Visa(*, type='VISA', number, date, expireDate)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.Patent(*, type='PATENT', number, date, expireDate)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ResidencePermit(*, type='RESIDENCE_PERMIT', number, date, serial=None, expireDate=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.Contract(*, type='CONTRACT', number, date, expireDate=None)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ContractGPD(*, type='CONTRACT_GPD', number, date, expireDate=None)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.Address(*, type, address)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
type (AddressType)
address (str)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryFlResidentRequest(*, firstName, lastName, isSelfEmployed, birthDate, citizenship, documents, addresses, middleName=None, birthPlace=None, phoneNumber=None, email=None, inn=None, type='FL_RESIDENT', snils=None)[исходный код]¶
Базовые классы:
_FlBeneficiaryBase- Параметры:
firstName (str)
lastName (str)
isSelfEmployed (bool)
birthDate (date)
citizenship (str)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
middleName (str | None)
birthPlace (str | None)
phoneNumber (str | None)
email (str | None)
inn (str | None)
type (Literal['FL_RESIDENT'])
snils (str | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryFlNonresidentRequest(*, firstName, lastName, isSelfEmployed, birthDate, citizenship, documents, addresses, middleName=None, birthPlace=None, phoneNumber=None, email=None, inn=None, type='FL_NONRESIDENT')[исходный код]¶
Базовые классы:
_FlBeneficiaryBase- Параметры:
firstName (str)
lastName (str)
isSelfEmployed (bool)
birthDate (date)
citizenship (str)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
middleName (str | None)
birthPlace (str | None)
phoneNumber (str | None)
email (str | None)
inn (str | None)
type (Literal['FL_NONRESIDENT'])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryIpResidentRequest(*, firstName, lastName, birthDate, citizenship, documents, addresses, registrationDate, inn, middleName=None, birthPlace=None, phoneNumber=None, email=None, ogrn=None, type='IP_RESIDENT')[исходный код]¶
Базовые классы:
_IpBeneficiaryRequestBase- Параметры:
firstName (str)
lastName (str)
birthDate (date)
citizenship (str)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
registrationDate (date)
inn (str)
middleName (str | None)
birthPlace (str | None)
phoneNumber (str | None)
email (str | None)
ogrn (str | None)
type (Literal['IP_RESIDENT'])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryIpNonresidentRequest(*, firstName, lastName, birthDate, citizenship, documents, addresses, registrationDate, inn, middleName=None, birthPlace=None, phoneNumber=None, email=None, ogrn=None, type='IP_NONRESIDENT')[исходный код]¶
Базовые классы:
_IpBeneficiaryRequestBase- Параметры:
firstName (str)
lastName (str)
birthDate (date)
citizenship (str)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
registrationDate (date)
inn (str)
middleName (str | None)
birthPlace (str | None)
phoneNumber (str | None)
email (str | None)
ogrn (str | None)
type (Literal['IP_NONRESIDENT'])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryUlResidentRequest(*, type='UL_RESIDENT', inn, name=None, phoneNumber=None, email=None, addresses=None, registrationDate=None, opf=None, ogrn=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryUlNonresidentRequest(*, type='UL_NONRESIDENT', name, addresses, registrationDate, registrationNumber, phoneNumber=None, email=None, nza=None, opf=None, inn=None, kio=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryLiteContactRequest(*, type='LITE_CONTACT')[исходный код]¶
Базовые классы:
NominalModel- Параметры:
type (Literal['LITE_CONTACT'])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryFlResidentResponse(*, type='FL_RESIDENT', beneficiaryId, firstName, lastName, isSelfEmployed, birthDate, middleName=None, birthPlace=None, citizenship=None, phoneNumber=None, email=None, documents=None, addresses=None, inn=None, snils=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
type (Literal['FL_RESIDENT'])
beneficiaryId (str)
firstName (str)
lastName (str)
isSelfEmployed (bool)
birthDate (date)
middleName (str | None)
birthPlace (str | None)
citizenship (str | None)
phoneNumber (str | None)
email (str | None)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] | None)
inn (str | None)
snils (str | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryFlNonresidentResponse(*, type='FL_NONRESIDENT', beneficiaryId, firstName, lastName, isSelfEmployed, birthDate, middleName=None, birthPlace=None, citizenship=None, phoneNumber=None, email=None, documents=None, addresses=None, inn=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
type (Literal['FL_NONRESIDENT'])
beneficiaryId (str)
firstName (str)
lastName (str)
isSelfEmployed (bool)
birthDate (date)
middleName (str | None)
birthPlace (str | None)
citizenship (str | None)
phoneNumber (str | None)
email (str | None)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] | None)
inn (str | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryIpResidentResponse(*, beneficiaryId, firstName, lastName, birthDate, registrationDate, middleName=None, birthPlace=None, citizenship=None, phoneNumber=None, email=None, documents=None, addresses=None, inn=None, ogrn=None, type='IP_RESIDENT')[исходный код]¶
Базовые классы:
_IpBeneficiaryResponseBase- Параметры:
beneficiaryId (str)
firstName (str)
lastName (str)
birthDate (date)
registrationDate (date)
middleName (str | None)
birthPlace (str | None)
citizenship (str | None)
phoneNumber (str | None)
email (str | None)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] | None)
inn (str | None)
ogrn (str | None)
type (Literal['IP_RESIDENT'])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryIpNonresidentResponse(*, beneficiaryId, firstName, lastName, birthDate, registrationDate, middleName=None, birthPlace=None, citizenship=None, phoneNumber=None, email=None, documents=None, addresses=None, inn=None, ogrn=None, type='IP_NONRESIDENT')[исходный код]¶
Базовые классы:
_IpBeneficiaryResponseBase- Параметры:
beneficiaryId (str)
firstName (str)
lastName (str)
birthDate (date)
registrationDate (date)
middleName (str | None)
birthPlace (str | None)
citizenship (str | None)
phoneNumber (str | None)
email (str | None)
documents (List[Annotated[Passport | ForeignPassport | ForeignPassportOfForeignCitizens | OfficialPassport | DiplomaticPassport | MigrationCard | TemporaryResidencePermit | Visa | Patent | ResidencePermit | Contract | ContractGPD, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] | None)
inn (str | None)
ogrn (str | None)
type (Literal['IP_NONRESIDENT'])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryUlResidentResponse(*, type='UL_RESIDENT', beneficiaryId, inn, name=None, phoneNumber=None, email=None, addresses=None, registrationDate=None, opf=None, ogrn=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryUlNonresidentResponse(*, type='UL_NONRESIDENT', beneficiaryId, name, registrationDate, registrationNumber, phoneNumber=None, email=None, addresses=None, nza=None, opf=None, inn=None, kio=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryLiteContactResponse(*, type='LITE_CONTACT', beneficiaryId)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- Параметры:
offset (int)
limit (int)
size (int)
total (int)
results (List[Annotated[BeneficiaryFlResidentResponse | BeneficiaryFlNonresidentResponse | BeneficiaryIpResidentResponse | BeneficiaryIpNonresidentResponse | BeneficiaryUlResidentResponse | BeneficiaryUlNonresidentResponse | BeneficiaryLiteContactResponse, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryScoringError(*, code, description)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ScoringInProgress(*, status='IN_PROGRESS', beneficiaryId)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ScoringSucceeded(*, status='SUCCEEDED', beneficiaryId, warnings=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
status (Literal['SUCCEEDED'])
beneficiaryId (str)
warnings (List[BeneficiaryScoringError] | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ScoringFailed(*, status='FAILED', beneficiaryId, warnings=None, errors=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
status (Literal['FAILED'])
beneficiaryId (str)
warnings (List[BeneficiaryScoringError] | None)
errors (List[BeneficiaryScoringError] | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BeneficiaryScoringListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- Параметры:
offset (int)
limit (int)
size (int)
total (int)
results (List[Annotated[ScoringInProgress | ScoringSucceeded | ScoringFailed, FieldInfo(annotation=NoneType, required=True, discriminator='status')]])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.AddCardRequest(*, terminalKey)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
terminalKey (str)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.PendingAddCardResponse(*, status='PENDING', beneficiaryId, addCardRequestId, terminalKey, addCardUrl)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.ReadyAddCardResponse(*, status='READY', beneficiaryId, addCardRequestId, terminalKey, bankDetailsId)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.FailedAddCardResponse(*, status='FAILED', beneficiaryId, addCardRequestId, terminalKey, errorMessage)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RkcBankDetailsRequest(*, type='PAYMENT_DETAILS', bik, bankName, accountNumber, corrAccountNumber, isDefault=None, kpp=None, inn=None, name=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.CardBankDetailsRequest(*, type='CARD', terminalKey, cardData, isDefault=None)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.SbpBankDetailsRequest(*, type='SBP', terminalKey, phoneNumber, bankId, isDefault=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RkcBankDetailsResponse(*, type='PAYMENT_DETAILS', beneficiaryId, bankDetailsId, bik, bankName, accountNumber, corrAccountNumber, isDefault=None, kpp=None, inn=None, name=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.CardBankDetailsResponse(*, type='CARD', beneficiaryId, bankDetailsId, cardId, terminalKey, isDefault=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.SbpBankDetailsResponse(*, type='SBP', beneficiaryId, bankDetailsId, phoneNumber, bankId, terminalKey, isDefault=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BankDetailsListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- Параметры:
offset (int)
limit (int)
size (int)
total (int)
results (List[Annotated[RkcBankDetailsResponse | CardBankDetailsResponse | SbpBankDetailsResponse, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RkcBankDetails(*, type='PAYMENT_DETAILS', bik, bankName, accountNumber, corrAccountNumber, kpp=None, inn=None, name=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.CardBankDetails(*, type='CARD', cardId, terminalKey)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.SbpBankDetails(*, type='SBP', phoneNumber, bankId, terminalKey)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DealRequest(*, accountNumber)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
accountNumber (str)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DealResponse(*, dealId, accountNumber, status)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
dealId (str)
accountNumber (str)
status (DealStatus)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DealListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DealValidityReason(*, code=None, description=None, details=None)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DealValidity(*, isValid, reasons=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
isValid (bool)
reasons (List[DealValidityReason] | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.StepRequest(*, description)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
description (str)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.StepResponse(*, dealId, stepId, stepNumber, description, status)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
dealId (str)
stepId (str)
stepNumber (int)
description (str)
status (StepStatus)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.StepListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DeponentRequest(*, amount)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
amount (Annotated[Decimal, PlainSerializer(func=~tbank.nominal_accounts.models.<lambda>, return_type=float, when_used=json)])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DeponentResponse(*, dealId, stepId, beneficiaryId, amount)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.DeponentListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RecipientRequest(*, beneficiaryId, amount, tax=None, purpose=None, bankDetailsId=None, keepOnVirtualAccount=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
beneficiaryId (str)
amount (Annotated[Decimal, PlainSerializer(func=~tbank.nominal_accounts.models.<lambda>, return_type=float, when_used=json)])
tax (Annotated[Decimal, PlainSerializer(func=~tbank.nominal_accounts.models.<lambda>, return_type=float, when_used=json)] | None)
purpose (str | None)
bankDetailsId (str | None)
keepOnVirtualAccount (bool | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RecipientResponse(*, dealId, stepId, beneficiaryId, recipientId, amount, tax=None, purpose=None, bankDetailsId=None, keepOnVirtualAccount=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RecipientListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.UpdateRecipientBankDetailsRequest(*, bankDetailsId)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
bankDetailsId (str)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.TaxThirdParty(*, inn, kpp)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.TaxPaymentParameters(*, payerStatus, kbk, oktmo, evidence, period, docNumber, docDate, thirdParty=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.CreateRegularPaymentRequest(*, type='REGULAR', beneficiaryId, accountNumber, amount, purpose, bankDetailsId=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.CreateTaxPaymentRequest(*, type='TAX', beneficiaryId, accountNumber, bankDetails, amount, purpose, uin, tax)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
type (Literal['TAX'])
beneficiaryId (str)
accountNumber (str)
bankDetails (RkcBankDetails | CardBankDetails | SbpBankDetails)
amount (Annotated[Decimal, PlainSerializer(func=~tbank.nominal_accounts.models.<lambda>, return_type=float, when_used=json)])
purpose (str)
uin (str)
tax (TaxPaymentParameters)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RegularPaymentResponse(*, type='REGULAR', paymentId, beneficiaryId, accountNumber, bankDetails, amount, status, purpose, dealId=None, stepId=None, recipientId=None, errorMessage=None, operationId=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
type (Literal['REGULAR'])
paymentId (str)
beneficiaryId (str)
accountNumber (str)
bankDetails (RkcBankDetails | CardBankDetails | SbpBankDetails)
amount (Decimal)
status (PaymentStatus)
purpose (str)
dealId (str | None)
stepId (str | None)
recipientId (str | None)
errorMessage (str | None)
operationId (str | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.TaxPaymentResponse(*, type='TAX', paymentId, beneficiaryId, accountNumber, bankDetails, amount, status, purpose, uin, tax, errorMessage=None, operationId=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
type (Literal['TAX'])
paymentId (str)
beneficiaryId (str)
accountNumber (str)
bankDetails (RkcBankDetails | CardBankDetails | SbpBankDetails)
amount (Decimal)
status (PaymentStatus)
purpose (str)
uin (str)
tax (TaxPaymentParameters)
errorMessage (str | None)
operationId (str | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.PaymentListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- Параметры:
offset (int)
limit (int)
size (int)
total (int)
results (List[Annotated[RegularPaymentResponse | TaxPaymentResponse, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.RetryPaymentResponse(*, retryPaymentId)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
retryPaymentId (str)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.IncomingTransactionListItem(*, accountNumber, operationId, amount, currency=None, operationAmount=None, operationCurrency=None, payerBik=None, payerKpp=None, payerInn=None, payerBankName=None, payerBankSwiftCode=None, payerAccountNumber=None, payerCorrAccountNumber=None, payerName=None, paymentPurpose=None, documentNumber=None, chargeDate=None, authorizationDate=None, transactionDate=None, drawDate=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
accountNumber (str)
operationId (str)
amount (Decimal)
currency (str | None)
operationAmount (Decimal | None)
operationCurrency (str | None)
payerBik (str | None)
payerKpp (str | None)
payerInn (str | None)
payerBankName (str | None)
payerBankSwiftCode (str | None)
payerAccountNumber (str | None)
payerCorrAccountNumber (str | None)
payerName (str | None)
paymentPurpose (str | None)
documentNumber (str | None)
chargeDate (datetime | None)
authorizationDate (datetime | None)
transactionDate (datetime | None)
drawDate (datetime | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.IncomingTransactionListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.AmountDistributionItem(*, beneficiaryId, amount)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.IdentifyIncomingTransactionRequest(*, amountDistribution=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
amountDistribution (List[AmountDistributionItem] | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BalanceListItem(*, beneficiaryId, accountNumber, amount, amountOnHold)[исходный код]¶
Базовые классы:
NominalModel- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.BalanceListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.HoldListItem(*, beneficiaryId, accountNumber, holdId, amount, dealId=None, stepId=None, recipientId=None, paymentId=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.HoldListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.TransferParty(*, beneficiaryId)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
beneficiaryId (str)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.CreateTransferRequest(*, accountNumber, from_, to, amount, purpose=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
accountNumber (str)
from_ (TransferParty)
to (TransferParty)
amount (Annotated[Decimal, PlainSerializer(func=~tbank.nominal_accounts.models.<lambda>, return_type=float, when_used=json)])
purpose (str | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.TransferResponse(*, transferId, accountNumber, from_, to, amount, type=None, purpose=None)[исходный код]¶
Базовые классы:
NominalModel- Параметры:
transferId (str)
accountNumber (str)
from_ (TransferParty)
to (TransferParty)
amount (Decimal)
type (TransferType | None)
purpose (str | None)
- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class tbank.nominal_accounts.models.TransferListResponse(*, offset, limit, size, total, results=<factory>)[исходный код]¶
Базовые классы:
_Paged- model_config = {'alias_generator': <function to_camel>, 'extra': 'ignore', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
Перечисления¶
- class tbank.nominal_accounts.enums.BeneficiaryType(*values)[исходный код]¶
-
Тип бенефициара номинального счёта.
- FL_RESIDENT = 'FL_RESIDENT'¶
- FL_NONRESIDENT = 'FL_NONRESIDENT'¶
- UL_RESIDENT = 'UL_RESIDENT'¶
- UL_NONRESIDENT = 'UL_NONRESIDENT'¶
- IP_RESIDENT = 'IP_RESIDENT'¶
- IP_NONRESIDENT = 'IP_NONRESIDENT'¶
- LITE_CONTACT = 'LITE_CONTACT'¶
- class tbank.nominal_accounts.enums.AddressType(*values)[исходный код]¶
-
Тип адреса бенефициара.
- POSTAL = 'POSTAL_ADDRESS'¶
- REGISTRATION = 'REGISTRATION_ADDRESS'¶
- RESIDENCE = 'RESIDENCE_ADDRESS'¶
- LEGAL_ENTITY = 'LEGAL_ENTITY_ADDRESS'¶
- OFFICE_OF_FOREIGN_LEGAL_ENTITY = 'OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS'¶
- class tbank.nominal_accounts.enums.DocumentType(*values)[исходный код]¶
-
Тип документа бенефициара.
- PASSPORT = 'PASSPORT'¶
- FOREIGN_PASSPORT = 'FOREIGN_PASSPORT'¶
- FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS = 'FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS'¶
- OFFICIAL_PASSPORT = 'OFFICIAL_PASSPORT'¶
- DIPLOMATIC_PASSPORT = 'DIPLOMATIC_PASSPORT'¶
- MIGRATION_CARD = 'MIGRATION_CARD'¶
- TEMPORARY_RESIDENCE_PERMIT = 'TEMPORARY_RESIDENCE_PERMIT'¶
- VISA = 'VISA'¶
- RESIDENCE_PERMIT = 'RESIDENCE_PERMIT'¶
- CONTRACT = 'CONTRACT'¶
- CONTRACT_GPD = 'CONTRACT_GPD'¶
- PATENT = 'PATENT'¶
- class tbank.nominal_accounts.enums.BankDetailsType(*values)[исходный код]¶
-
Тип банковских реквизитов бенефициара.
- PAYMENT_DETAILS = 'PAYMENT_DETAILS'¶
- CARD = 'CARD'¶
- SBP = 'SBP'¶
- class tbank.nominal_accounts.enums.PaymentType(*values)[исходный код]¶
-
Тип платежа с номинального счёта.
- REGULAR = 'REGULAR'¶
- TAX = 'TAX'¶
- class tbank.nominal_accounts.enums.PaymentStatus(*values)[исходный код]¶
-
Статус платежа с номинального счёта.
- PENDING = 'PENDING'¶
- IN_PROGRESS = 'IN_PROGRESS'¶
- FAILED = 'FAILED'¶
- CANCELLED = 'CANCELLED'¶
- SUCCEEDED = 'SUCCEEDED'¶
- class tbank.nominal_accounts.enums.DealStatus(*values)[исходный код]¶
-
Статус сделки.
- DRAFT = 'DRAFT'¶
- ACCEPTED = 'ACCEPTED'¶
- IN_PROGRESS = 'IN_PROGRESS'¶
- CANCELLED = 'CANCELLED'¶
- COMPLETED = 'COMPLETED'¶
- class tbank.nominal_accounts.enums.StepStatus(*values)[исходный код]¶
-
Статус этапа сделки.
- NEW = 'NEW'¶
- PAYMENT_IN_PROGRESS = 'PAYMENT_IN_PROGRESS'¶
- PAYMENT_FAILED = 'PAYMENT_FAILED'¶
- CANCELLED = 'CANCELLED'¶
- COMPLETED = 'COMPLETED'¶
- class tbank.nominal_accounts.enums.AddCardStatus(*values)[исходный код]¶
-
Статус запроса на добавление карты бенефициара.
- PENDING = 'PENDING'¶
- READY = 'READY'¶
- FAILED = 'FAILED'¶
- class tbank.nominal_accounts.enums.ScoringStatus(*values)[исходный код]¶
-
Статус проверки бенефициара в финансовом мониторинге.
- IN_PROGRESS = 'IN_PROGRESS'¶
- SUCCEEDED = 'SUCCEEDED'¶
- FAILED = 'FAILED'¶