YooMoney types¶

class glQiwiApi.types.yoomoney.AccountInfo(*, account: str, balance: float, currency: str, identified: bool, account_type: str, account_status: str, balance_details: glQiwiApi.types.yoomoney.types.BalanceDetails, cards_linked: List[glQiwiApi.types.yoomoney.types.CardsLinked] = None)[source]¶

object: AccountInfo

account: str¶: Номер счета

account_status: str¶: Статус пользователя. Возможные значения: anonymous — анонимный счет; named — именной счет; identified — идентифицированный счет.

account_type: str¶: Тип счета пользователя. Возможные значения: personal — счет пользователя в ЮMoney; professional — профессиональный счет в ЮMoney

balance: float¶: Баланс счета

balance_details: glQiwiApi.types.yoomoney.types.BalanceDetails¶: Расширенная информация о балансе. По умолчанию этот блок отсутствует. Блок появляется, если сейчас или когда-либо ранее были зачисления в очереди задолженности, блокировки средств.

cards_linked: Optional[List[glQiwiApi.types.yoomoney.types.CardsLinked]]¶: Информация о привязанных банковских картах. Если к счету не привязано ни одной карты, параметр отсутствует. Если к счету привязана хотя бы одна карта, параметр содержит список данных о привязанных картах. pan_fragment - string Маскированный номер карты. type: string Тип карты. Может отсутствовать, если неизвестен. Возможные значения: - VISA; - MasterCard; - AmericanExpress; - JCB.

currency: str¶: Код валюты счета пользователя. Всегда 643 (рубль РФ по стандарту ISO 4217).

identified: bool¶: Верифицирован ли кошелек

class glQiwiApi.types.yoomoney.IncomingTransaction(*, status: str, protection_code_attempts_available: int, ext_action_uri: str = None, error: str = None)[source]¶: object: IncomingTransaction

class glQiwiApi.types.yoomoney.Operation(*, operation_id: str, status: str, datetime: datetime.datetime, title: str, direction: str, amount: Union[int, float], type: str, label: str = None, pattern_id: str = None, details: Any = None)[source]¶

object: Operation

amount: Union[int, float]¶: Сумма операции.

direction: str¶: Направление движения средств. Может принимать значения: - in (приход); - out (расход).

id: str¶: Идентификатор операции.

label: Optional[str]¶: Метка платежа. Присутствует для входящих и исходящих переводов другим пользователям у которых был указан параметр label вызова send()

operation_date: datetime.datetime¶: Дата и время совершения операции в формате строки в ISO формате с часовым поясом UTC.

operation_type: str¶: Тип операции. Возможные значения: payment-shop — исходящий платеж в магазин; outgoing-transfer — исходящий P2P-перевод любого типа; deposition — зачисление; incoming-transfer — входящий перевод или перевод до востребования; incoming-transfer-protected — входящий перевод с кодом протекции.

pattern_id: Optional[str]¶: Идентификатор шаблона, по которому совершен платеж. Присутствует только для платежей.

status: str¶: Статус платежа (перевода). Может принимать следующие значения: - success — платеж завершен успешно; - refused — платеж отвергнут получателем или отменен отправителем; - in_progress — платеж не завершен,

перевод не принят получателем или ожидает ввода кода протекции.

title: str¶: Краткое описание операции (название магазина или источник пополнения).

class glQiwiApi.types.yoomoney.OperationDetails(*, operation_id: str, status: str = None, amount: float = None, datetime: datetime.datetime = None, type: str = None, direction: str = None, comment: str = None, digital_goods: Dict[str, glQiwiApi.types.yoomoney.types.DigitalGoods] = None, details: str = None, label: str = None, answer_datetime: str = None, expires: str = None, protection_code: str = None, codepro: bool = None, message: str = None, recipient_type: str = None, recipient: str = None, sender: str = None, title: str = None, fee: float = None, amount_due: float = None, pattern_id: str = None, error: str = None)[source]¶

object: OperationDetails

amount: Optional[float]¶: Сумма операции (сумма списания со счета).

amount_due: Optional[float]¶: Сумма к получению. Присутствует для исходящих переводов другим пользователям.

answer_datetime: Optional[str]¶: Дата и время приема или отмены перевода, защищенного кодом протекции. Присутствует для входящих и исходящих переводов, защищенных кодом протекции если при вызове send вы указали protect=True при передаче аргументов. Если перевод еще не принят или не отвергнут получателем, поле отсутствует.

codepro: Optional[bool]¶: Перевод защищен кодом протекции. Присутствует для переводов другим пользователям.

comment: Optional[str]¶: Комментарий к переводу или пополнению. Присутствует в истории отправителя перевода или получателя пополнения.

details: Optional[str]¶: Детальное описание платежа. Строка произвольного формата, может содержать любые символы и переводы строк Необязательный параметр.

digital_goods: Optional[Dict[str, glQiwiApi.types.yoomoney.types.DigitalGoods]]¶: Данные о цифровом товаре (пин-коды и бонусы игр, iTunes, Xbox, etc.) Поле присутствует при успешном платеже в магазины цифровых товаров. Описание формата: https://yoomoney.ru/docs/wallet/process-payments/process-payment#digital-goods

direction: Optional[str]¶: направление движения средств. может принимать значения: - in (приход); - out (расход).

error: Optional[str]¶: Код ошибки, присутствует при ошибке выполнения запрос Возможные ошибки: illegal_param_operation_id - неверное значение параметра operation_id Все прочие значения - техническая ошибка, повторите вызов метода позднее.

expires: Optional[str]¶: Дата и время истечения срока действия кода протекции. Присутствует для входящих и исходящих переводов (от/другим) пользователям, защищенных кодом протекции, если при вызове send вы указали protect=True при передаче аргументов.

fee: Optional[float]¶: Сумма комиссии. Присутствует для исходящих переводов другим пользователям.

id: str¶: Идентификатор операции. Можно получить при вызове метода history()

label: Optional[str]¶: Метка платежа.

message: Optional[str]¶: Сообщение получателю перевода. Присутствует для переводов другим пользователям.

operation_date: Optional[datetime.datetime]¶: Дата и время совершения операции в формате строки в ISO формате с часовым поясом UTC.

operation_type: Optional[str]¶: Тип операции. Возможные значения: payment-shop — исходящий платеж в магазин; outgoing-transfer — исходящий P2P-перевод любого типа; deposition — зачисление; incoming-transfer — входящий перевод или перевод до востребования; incoming-transfer-protected — входящий перевод с кодом протекции.

pattern_id: Optional[str]¶: Идентификатор шаблона платежа, по которому совершен платеж. Присутствует только для платежей.

protection_code: Optional[str]¶: Код протекции. Присутствует для исходящих переводов, защищенных кодом протекции.

recipient: Optional[str]¶: Идентификатор получателя перевода. Присутствует для исходящих переводов другим пользователям.

recipient_type: Optional[str]¶: Тип идентификатора получателя перевода. Возможные значения: account — номер счета получателя в сервисе ЮMoney; phone — номер привязанного мобильного телефона получателя; email — электронная почта получателя перевода. Присутствует для исходящих переводов другим пользователям.

sender: Optional[str]¶: Номер счета отправителя перевода. Присутствует для входящих переводов от других пользователей.

status: Optional[str]¶: Статус платежа (перевода). Можно получить при вызове метода history()

title: Optional[str]¶: Краткое описание операции (название магазина или источник пополнения).

class glQiwiApi.types.yoomoney.OperationType(value)[source]¶

Типы операций YooMoney

deposition — пополнение счета (приход); payment — платежи со счета (расход); incoming_transfers_unaccepted — непринятые входящие P2P-переводы любого типа.

DEPOSITION = 'deposition'¶: Пополнение счета (приход);

PAYMENT = 'payment'¶: Платежи со счета (расход)

TRANSFERS = 'incoming-transfers-unaccepted'¶: непринятые входящие P2P-переводы любого типа.

class glQiwiApi.types.yoomoney.Payment(*, status: str, payment_id: str, credit_amount: float = None, payer: str = None, payee: str = None, payee_uid: Optional[Union[str, int]] = None, invoice_id: str = None, balance: float = None, error: str = None, account_unblock_uri: str = None, acs_uri: str = None, acs_params: str = None, next_retry: int = None, digital_goods: Dict[str, Dict[str, List[glQiwiApi.types.yoomoney.types.DigitalGoods]]] = None, protection_code: str = None)[source]¶

object: Payment

account_unblock_uri: Optional[str]¶: Адрес, на который необходимо отправить пользователя для разблокировки счета Поле присутствует в случае ошибки account_blocked.

balance: Optional[float]¶: Баланс счета пользователя после проведения платежа. Присутствует только при выполнении следующих условий: - метод выполнен успешно; - токен авторизации обладает правом account-info.

credit_amount: Optional[float]¶: Сумма, поступившая на счет получателя. Присутствует при успешном переводе средств на счет другого пользователя ЮMoney.

error: Optional[str]¶: Код ошибки при проведении платежа (пояснение к полю status). Присутствует только при ошибках.

invoice_id: Optional[str]¶: Номер транзакции магазина в ЮMoney. Присутствует при успешном выполнении платежа в магазин.

next_retry: Optional[int]¶: Рекомендуемое время, спустя которое следует повторить запрос, в миллисекундах. Поле присутствует при status=in_progress.

payee: Optional[str]¶: Номер счета получателя. Присутствует при успешном переводе средств на счет другого пользователя ЮMoney.

payee_uid: Optional[Union[str, int]]¶: Служебное значение, не фигурирует в документации

payer: Optional[str]¶: Номер счета плательщика. Присутствует при успешном переводе средств на счет другого пользователя ЮMoney.

payment_id: str¶: Идентификатор проведенного платежа. Присутствует только при успешном выполнении метода send().

protection_code: Optional[str]¶: Код протекции, который был сгенерирован, если при вызове метода апи send вы указали protect=True при передаче аргументов

status: str¶: Код результата выполнения операции. Возможные значения: success — успешное выполнение (платеж проведен). Это конечное состояние платежа. refused — отказ в проведении платежа. Причина отказа возвращается в поле error. Это конечное состояние платежа. in_progress — авторизация платежа не завершена. Приложению следует повторить запрос с теми же параметрами спустя некоторое время. ext_auth_required — для завершения авторизации платежа с использованием банковской карты требуется аутентификация по технологии 3‑D Secure. все прочие значения — состояние платежа неизвестно. Приложению следует повторить запрос с теми же параметрами спустя некоторое время.

class glQiwiApi.types.yoomoney.PreProcessPaymentResponse(*, status: str, request_id: str, recipient_account_status: str, fees: Dict[str, float], balance: float = None, recipient_account_type: str = None, recipient_identified: bool = False, recipient_masked_account: str = None, multiple_recipients_found: str = None, contract_amount: float = None, error: str = None, money_source: glQiwiApi.types.yoomoney.types.MoneySource = None, protection_code: str = None, account_unblock_uri: str = None, ext_action_uri: str = None)[source]¶: Объект, который вы получаете при вызове _pre_process_payment. При вызове данного метода вы не списываете деньги со своего счёта, а условно подготавливаете его к отправке. Для отправки денег на счёт используйте метод send()