@companix/yookassa 0.0.3 → 0.0.4

package/dist/api/requests/refund.d.ts

@@ -1,35 +1,145 @@
 import type { CommonAmount, CommonArticles, CommonReceipt, CommonRefundSettlements, CommonSources } from '../common';
 import { BasicStatusEnum } from '../enums';
+/**
+ * Создание возврата
+ *
+ * Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания. Комиссия ЮKassa за проведение платежа не возвращается.
+ */
 export interface CreateRefundRequest {
+    /**
+     * Идентификатор платежа в ЮKassa.
+     */
     payment_id: string;
+    /**
+     * Сумма, которую нужно вернуть пользователю.
+     *
+     * Сумма указывается с кодом валюты. Если вы разделяете потоки платежей, валюта возврата должна соответствовать валюте субаккаунта, которая была указана для платежа (recipient.gateway_id), если не разделяете — валюте аккаунта shopId в личном кабинете).
+     */
     amount: CommonAmount;
+    /**
+     * Комментарий к возврату, основание для возврата денег пользователю.
+     */
     description?: string;
+    /**
+     * Данные для формирования чека.
+     *
+     * Необходимо передавать в этих случаях:
+     *
+     * вы компания или ИП и для оплаты с соблюдением требований 54-ФЗ используете Чеки от ЮKassa;
+     *
+     * вы компания или ИП, для оплаты с соблюдением требований 54-ФЗ используете стороннюю онлайн-кассу и отправляете данные для чеков по одному из сценариев: Платеж и чек одновременно или Сначала чек, потом платеж.
+     */
     receipt?: CommonReceipt;
+    /**
+     * Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата. Необходимо передавать, если вы используете Сплитование платежей. Сейчас в этом параметре можно передать данные только одного магазина.
+     */
     sources?: CommonSources[];
+    /**
+     * Данные о сделке, в составе которой проходит возврат. Необходимо передавать, если вы проводите Безопасную сделку.
+     */
     deal?: CreateRefundRequestDeal;
+    /**
+     * Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа.
+     */
     refund_method_data?: CreateRefundRequestRefundMethodData;
+    /**
+     * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * Список возвратов
+ *
+ * Используйте этот запрос, чтобы получить список возвратов. Для выгрузки доступны возвраты, созданные за последние 3 года. Список можно отфильтровать по различным критериям.
+ *
+ * Подробнее о работе со списками
+ */
 export interface GetRefundsListRequest {
+    /**
+     * Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z
+     */
     'created_at.gte'?: string;
+    /**
+     * Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z
+     */
     'created_at.gt'?: string;
+    /**
+     * Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z
+     */
     'created_at.lte'?: string;
+    /**
+     * Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z
+     */
     'created_at.lt'?: string;
+    /**
+     * Фильтр по идентификатору платежа (получить все возвраты по платежу). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9
+     */
     payment_id?: string;
+    /**
+     * Фильтр по статусу возврата. Возможные значения: pending — в обработке, succeeded — успешно выполнен, canceled — отменен. Пример: status=succeeded
+     */
     status?: BasicStatusEnum;
+    /**
+     * Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50
+     *
+     * Значение по умолчанию: 10
+     */
     limit?: number;
+    /**
+     * Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15
+     *
+     * В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования
+     */
     cursor?: string;
 }
+/**
+ * Данные о сделке, в составе которой проходит возврат. Необходимо передавать, если вы проводите Безопасную сделку.
+ */
 export interface CreateRefundRequestDeal {
+    /**
+     * Данные о распределении денег.
+     */
     refund_settlements: CommonRefundSettlements[];
 }
+/**
+ * Данные для возврата платежа по электронному сертификату.
+ */
 export interface CreateRefundRequestRefundMethodDataElectronicCertificate {
+    /**
+     * Код способа оплаты.
+     */
     type: 'electronic_certificate';
+    /**
+     * Данные от ФЭС НСПК для возврата на электронный сертификат.
+     *
+     * Неоходимо передавать только при оплате со сбором данных на вашей стороне.
+     */
     electronic_certificate?: CreateRefundRequestRefundMethodDataElectronicCertificateElectronicCertificate;
+    /**
+     * Корзина возврата (в терминах НСПК) — список возвращаемых товаров, для оплаты которых использовался электронный сертификат. Данные должны соответствовать товарам из одобренной корзины покупки (articles в объекте платежа).
+     *
+     * Необходимо передавать только при оплате на готовой странице ЮKassa.
+     */
     articles?: CommonArticles[];
 }
+/**
+ * Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа.
+ *
+ * Способы оплаты
+ */
 export type CreateRefundRequestRefundMethodData = CreateRefundRequestRefundMethodDataElectronicCertificate;
+/**
+ * Данные от ФЭС НСПК для возврата на электронный сертификат.
+ *
+ * Неоходимо передавать только при оплате со сбором данных на вашей стороне.
+ */
 export interface CreateRefundRequestRefundMethodDataElectronicCertificateElectronicCertificate {
+    /**
+     * Сумма, которая вернется на электронный сертификат, — значение totalCertAmount, которое вы получили в ФЭС НСПК в запросе на предварительное одобрение возврата (Refund Pre-Auth).
+     */
     amount: CommonAmount;
+    /**
+     * Идентификатор корзины возврата, сформированной в НСПК, — значение returnBasketId, которое вы получили в ФЭС НСПК в запросе на предварительное одобрение возврата (Refund Pre-Auth).
+     */
     basket_id: string;
 }

package/dist/api/requests/webhook.d.ts

@@ -1,5 +1,18 @@
 import { NotificationEventEnum } from '../enums';
+/**
+ * Создание webhook
+ *
+ * Запрос позволяет подписаться на уведомления о событиях (например, переход платежа в статус succeeded). C помощью webhook можно подписаться только на события платежей и возвратов.
+ *
+ * Если вы хотите получать уведомления о нескольких событиях, вам нужно для каждого из них создать свой webhook. Для каждого OAuth-токена нужно создавать свой набор webhook.
+ */
 export interface CreateWebhookRequest {
+    /**
+     * Событие, которое вы хотите отслеживать.
+     */
     event: NotificationEventEnum;
+    /**
+     * URL, на который ЮKassa будет отправлять уведомления.
+     */
     url: string;
 }

package/dist/api/responses/deal.d.ts

@@ -1,23 +1,97 @@
 import type { CommonAmount } from '../common';
 import { DealFeeMomentEnum, DealStatusEnum } from '../enums';
+/**
+ * Тип сделки. Фиксированное значение: safe_deal — Безопасная сделка.
+ */
 export interface DealSafeDeal {
+    /**
+     * Тип сделки. Фиксированное значение: safe_deal — Безопасная сделка.
+     */
     "type": string;
+    /**
+     * Идентификатор сделки.
+     */
     id: string;
+    /**
+     * Момент перечисления вам вознаграждения платформы. Возможные значения:
+     *
+     * payment_succeeded — после успешной оплаты;
+     *
+     * deal_closed — при закрытии сделки после успешной выплаты.
+     */
     fee_moment: DealFeeMomentEnum;
+    /**
+     * Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок.
+     */
     description?: string;
+    /**
+     * Баланс сделки.
+     */
     balance: CommonAmount;
+    /**
+     * Сумма вознаграждения продавца.
+     */
     payout_balance: CommonAmount;
+    /**
+     * Статус сделки. Возможные значения:
+     *
+     * opened — сделка открыта; можно выполнять платежи, возвраты и выплаты в составе сделки;
+     *
+     * closed — сделка закрыта — вознаграждение перечислено продавцу и платформе или оплата возвращена покупателю; нельзя выполнять платежи, возвраты и выплаты в составе сделки.
+     */
     status: DealStatusEnum;
+    /**
+     * Время создания сделки. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
+     */
     created_at: string;
+    /**
+     * Время автоматического закрытия сделки. Если в указанное время сделка всё еще в статусе opened, ЮKassa вернет деньги покупателю и закроет сделку. По умолчанию время жизни сделки составляет 90 дней. Время указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
+     */
     expires_at: string;
+    /**
+     * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
+     */
     metadata?: Record<string, unknown>;
+    /**
+     * Признак тестовой операции.
+     */
     test: boolean;
 }
+/**
+ * Объект сделки
+ *
+ * Объект сделки (Deal) содержит всю информацию о сделке, актуальную на текущий момент времени. Он формируется при создании сделки и приходит в ответ на любой запрос, связанный со сделками.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект сделки (Deal) — актуальная информация о сделке.
+ *
+ * Типы сделок
+ */
 export type Deal = DealSafeDeal;
+/**
+ * Создание сделки
+ *
+ * В ответ на запрос придет объект сделки в актуальном статусе.
+ */
 export type CreateDealResponse = Deal;
+/**
+ * Список сделок
+ *
+ * В ответ на запрос вернется список сделок с учетом переданных параметров. В списке будет информация о сделках, созданных за последние 3 года. Список будет отсортирован по времени создания сделок в порядке убывания.
+ *
+ * Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент.
+ *
+ * Подробнее о работе со списками
+ */
 export interface GetDealsListResponse {
     type: "list";
     items: Deal[];
     next_cursor?: string;
 }
+/**
+ * Информация о сделке
+ *
+ * В ответ на запрос придет объект сделки в актуальном статусе.
+ */
 export type GetDealResponse = Deal;

package/dist/api/responses/invoice.d.ts

@@ -1,35 +1,160 @@
 import type { CommonCart } from '../common';
 import { BasicStatusEnum, CancellationDetailsPartyEnum, CancellationDetailsReasonEnum, PaymentDetailsStatusEnum } from '../enums';
+/**
+ * Объект счета
+ *
+ * Объект счета (Invoice) содержит всю информацию о счете, актуальную на текущий момент времени. Он формируется при создании счета и приходит в ответ на любой запрос, связанный с счетами.
+ *
+ * Набор возвращаемых параметров зависит от статуса объекта (значение параметра status) и того, какие параметры вы передали в запросе на создание счета.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект счета (Invoice) — актуальная информация о счете.
+ */
 export interface Invoice {
+    /**
+     * Идентификатор счета в ЮKassa.
+     */
     id: string;
+    /**
+     * Статус счета. Возможные значения:
+     *
+     * pending — счет создан и ожидает успешной оплаты;
+     *
+     * succeeded — счет успешно оплачен, есть связанный платеж в статусе succeeded (финальный и неизменяемый статус для платежей в одну стадию);
+     *
+     * canceled — вы отменили счет, успешный платеж по нему не поступил или был отменен (при оплате в две стадии) либо истек срок действия счета (финальный и неизменяемый статус).
+     *
+     * Подробнее про жизненный цикл счета
+     */
     status: BasicStatusEnum;
+    /**
+     * Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.
+     */
     cart: CommonCart[];
+    /**
+     * Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.
+     */
     delivery_method?: InvoiceDeliveryMethod;
+    /**
+     * Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.
+     */
     payment_details?: InvoicePaymentDetails;
+    /**
+     * Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
+     */
     created_at: string;
+    /**
+     * Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z
+     *
+     * Присутствует только для счетов в статусе pending.
+     */
     expires_at?: string;
+    /**
+     * Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».
+     */
     description?: string;
+    /**
+     * Комментарий к статусу canceled: кто отменил счет и по какой причине.
+     */
     cancellation_details?: InvoiceCancellationDetails;
+    /**
+     * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * Данные для самостоятельной доставки пользователю ссылки на счет.
+ */
 export interface InvoiceDeliveryMethodSelf {
+    /**
+     * Код способа доставки счета пользователю.
+     */
     "type": "self";
+    /**
+     * URL страницы счета, который необходимо передать пользователю для оплаты. Не более 2048 символов.
+     */
     url?: string;
 }
+/**
+ * Данные способа отправки счета по смс.
+ */
 export interface InvoiceDeliveryMethodSms {
+    /**
+     * Код способа доставки счета пользователю.
+     */
     "type": "sms";
 }
+/**
+ * Данные способа отправки счета по по электронной почте.
+ */
 export interface InvoiceDeliveryMethodEmail {
+    /**
+     * Код способа доставки счета пользователю.
+     */
     "type": "email";
 }
+/**
+ * Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.
+ *
+ * Способ доставки счета
+ */
 export type InvoiceDeliveryMethod = InvoiceDeliveryMethodSelf | InvoiceDeliveryMethodSms | InvoiceDeliveryMethodEmail;
+/**
+ * Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.
+ */
 export interface InvoicePaymentDetails {
+    /**
+     * Идентификатор платежа в ЮKassa.
+     */
     id: string;
+    /**
+     * Статус платежа. Возможные значения:
+     *
+     * waiting_for_capture — для платежей в две стадии: платеж оплачен, деньги авторизованы, вам необходимо списать оплату или отменить платеж;
+     *
+     * succeeded — платеж успешно завершен, деньги будут перечислены на ваш расчетный счет в соответствии с вашим договором с ЮKassa (финальный и неизменяемый статус);
+     *
+     * canceled — для платежей в две стадии: вы отменили платеж по API (финальный и неизменяемый статус).
+     */
     status: PaymentDetailsStatusEnum;
 }
+/**
+ * Комментарий к статусу canceled: кто отменил счет и по какой причине.
+ */
 export interface InvoiceCancellationDetails {
+    /**
+     * Участник процесса, который принял решение об отмене счета. Возможные значения:
+     *
+     * merchant — продавец товаров и услуг (вы);
+     *
+     * yoo_money — ЮKassa.
+     */
     party: CancellationDetailsPartyEnum;
+    /**
+     * Причина отмены счета. Возможные значения:
+     *
+     * invoice_canceled — счет отменен вручную из личного кабинета ЮKassa;
+     *
+     * invoice_expired — истек срок действия счета, который вы установили в запросе на создание счета в параметре expires_at, и по счету нет ни одного успешного платежа;
+     *
+     * general_decline — причина не детализирована, поэтому пользователю следует обратиться к инициатору отмены счета за уточнением подробностей;
+     *
+     * payment_canceled — платеж отменен по API при оплате в две стадии;
+     *
+     * payment_expired_on_capture — истек срок списания оплаты для платежа в две стадии.
+     */
     reason: CancellationDetailsReasonEnum;
 }
+/**
+ * Создание счета
+ *
+ * В ответ на запрос придет созданный объект счета в актуальном статусе.
+ */
 export type CreateInvoiceResponse = Invoice;
+/**
+ * Информация о счете
+ *
+ * В ответ на запрос придет созданный объект счета в актуальном статусе.
+ */
 export type GetInvoiceResponse = Invoice;

package/dist/api/responses/me.d.ts

@@ -1,19 +1,100 @@
 import type { CommonAmount } from '../common';
 import { FiscalizationProviderEnum, MeStatusEnum, PayoutMethodEnum } from '../enums';
+/**
+ * Объект настроек
+ *
+ * Объект настроек магазина или шлюза (Me) содержит актуальную информацию о настройках запрошенного магазина или шлюза. Возвращается в ответ на запрос информации о настройках.
+ *
+ * Набор возвращаемых параметров зависит от того, чьи настройки запрашиваются — магазина для приема платежей или шлюза для выплат.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект настроек магазина или шлюза (Me) — актуальная информация о настройках магазина или шлюза.
+ */
 export interface Me {
+    /**
+     * Идентификатор магазина или шлюза.
+     */
     account_id: string;
+    /**
+     * Статус магазина или шлюза. Возможные значения:
+     *
+     * enabled — подключен к ЮKassa, может проводить платежи или выплаты;
+     *
+     * disabled — не может проводить платежи или выплаты (еще не подключен, закрыт или временно не работает).
+     */
     status: MeStatusEnum;
+    /**
+     * Это тестовый магазин или шлюз.
+     */
     test: boolean;
+    /**
+     * Настройки магазина для отправки чеков в налоговую.
+     *
+     * Присутствует, если вы запрашивали настройки магазина и этот магазин использует решения ЮKassa для отправки чеков. Отсутствует, если магазин еще не включал отправку чеков через ЮKassa.
+     */
     fiscalization?: MeFiscalization;
+    /**
+     * Устаревший параметр, который раньше использовался для определения настроек отправки чеков в налоговую. Сохранен для поддержки обратной совместимости, в новых версиях API может быть удален.
+     *
+     * Используйте объект fiscalization, чтобы определить, какие у магазина настройки отправки чеков.
+     */
     fiscalization_enabled?: boolean;
+    /**
+     * Список способов оплаты, доступных магазину. Присутствует, если вы запрашивали настройки магазина.
+     */
     payment_methods?: unknown[];
+    /**
+     * ИНН магазина (от 1 до 20 цифр). Присутствует, если вы запрашивали настройки магазина.
+     */
     itn?: string;
+    /**
+     * Список способов получения выплат, доступных шлюзу. Возможные значения:
+     *
+     * bank_card — выплаты на банковские карты;
+     *
+     * yoo_money — выплаты на кошельки ЮMoney;
+     *
+     * sbp — выплаты через СБП.
+     *
+     * Присутствует, если вы запрашивали настройки шлюза.
+     */
     payout_methods?: PayoutMethodEnum[];
+    /**
+     * Название шлюза, которое отображается в личном кабинете ЮKassa. Присутствует, если вы запрашивали настройки шлюза.
+     */
     name?: string;
+    /**
+     * Баланс вашего шлюза. Присутствует, если вы запрашивали настройки шлюза.
+     */
     payout_balance?: CommonAmount;
 }
+/**
+ * Настройки магазина для отправки чеков в налоговую.
+ *
+ * Присутствует, если вы запрашивали настройки магазина и этот магазин использует решения ЮKassa для отправки чеков. Отсутствует, если магазин еще не включал отправку чеков через ЮKassa.
+ */
 export interface MeFiscalization {
+    /**
+     * В настройках магазина включена отправка чеков. Возможные значения:
+     *
+     * true — магазин отправляет данные для чеков через ЮKassa;
+     *
+     * false — магазин выключил отправку чеков через ЮKassa.
+     */
     enabled: boolean;
+    /**
+     * Решение ЮKassa, которое магазин использует для отправки чеков. Возможные значения:
+     *
+     * 54-ФЗ: Чеки от ЮKassa — avanpost (ООО «Аванпост»), yoo_receipt (ООО «АйтиГрупп»).
+     *
+     * 54-ФЗ: сторонняя онлайн-касса (наименование онлайн-кассы) — a_qsi (aQsi online), atol (АТОЛ Онлайн), business_ru (Бизнес.ру), digital_kassa (digitalkassa), evotor (Эвотор), first_ofd (Первый ОФД), kit_invest (Кит Инвест), komtet (КОМТЕТ Касса), life_pay (LIFE PAY), mertrade (Mertrade), modul_kassa (МодульКасса), rocket (RocketR), shtrih_m (Orange Data).
+     */
     provider: FiscalizationProviderEnum;
 }
+/**
+ * Информация о настройках магазина или шлюза
+ *
+ * В ответ на запрос вернется объект настроек магазина, для которого выдан OAuth-токен или чей идентификатор передан в параметре on_behalf_of, или шлюза, идентификатор и секретный ключ которого указан в качестве логина для аутентификации запроса.
+ */
 export type GetMeResponse = Me;

package/dist/api/responses/payment-method.d.ts

@@ -1,15 +1,75 @@
 import type { CommonCard2, CommonConfirmation2, CommonHolder } from '../common';
 import { PaymentMethodStatusEnum } from '../enums';
+/**
+ * Сохраненная банковская карта.
+ */
 export interface PaymentMethodBankCard {
+    /**
+     * Код способа оплаты.
+     *
+     * Возможное значение: bank_card — банковская карта.
+     */
     "type": string;
+    /**
+     * Идентификатор сохраненного способа оплаты.
+     */
     id: string;
+    /**
+     * Признак сохранения способа оплаты для автоплатежей. Возможные значения:
+     *
+     * true — способ оплаты сохранен для автоплатежей и выплат;
+     *
+     * false — способ оплаты не сохранен.
+     */
     saved: boolean;
+    /**
+     * Статус проверки и сохранения способа оплаты. Возможные значения:
+     *
+     * pending — ожидает действий от пользователя;
+     *
+     * active — способ оплаты сохранен, его можно использовать для автоплатежей или выплат;
+     *
+     * inactive — способ оплаты не сохранен: пользователь не подтвердил привязку платежного средства или при сохранении способа оплаты возникла ошибка. Чтобы узнать подробности, обратитесь в техническую поддержку ЮKassa.
+     */
     status: PaymentMethodStatusEnum;
+    /**
+     * Данные магазина, для которого сохраняется способ оплаты.
+     */
     holder: CommonHolder;
+    /**
+     * Название способа оплаты.
+     */
     title?: string;
+    /**
+     * Выбранный сценарий подтверждения привязки. Присутствует, когда привязка ожидает подтверждения от пользователя.
+     */
     confirmation?: CommonConfirmation2;
+    /**
+     * Данные банковской карты.
+     */
     card?: CommonCard2;
 }
+/**
+ * Объект способа оплаты
+ *
+ * Объект способа оплаты (PaymentMethod) содержит всю информацию о платежном средстве пользователя, актуальную на текущий момент времени. Он формируется при создании способа оплаты и приходит в ответ на любой запрос, связанный со способами оплаты.
+ *
+ * Набор возвращаемых параметров зависит от статуса объекта (значение параметра status) и того, какие параметры вы передали в запросе на создание способа оплаты.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Сохраненный способ оплаты.
+ */
 export type PaymentMethod = PaymentMethodBankCard;
+/**
+ * Создание способа оплаты
+ *
+ * В ответ на запрос придет объект способа оплаты в актуальном статусе.
+ */
 export type CreatePaymentMethodResponse = PaymentMethod;
+/**
+ * Информация о способе оплаты
+ *
+ * В ответ на запрос придет объект способа оплаты в актуальном статусе.
+ */
 export type GetPaymentMethodResponse = PaymentMethod;