import { t as Configuration } from "./configuration-CnCCjQVu.js"; import { i as RequestArgs, n as BaseAPI } from "./base-ftwm9lz6.js"; import * as axios0 from "axios"; import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios"; //#region src/client/api.d.ts /** * Объект с данными для продажи авиабилетов: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/airline-tickets. Используется только для платежей банковской картой. */ interface Airline { /** * Уникальный номер билета. Если при создании платежа вы уже знаете номер билета, тогда ticket_number — обязательный параметр. Если не знаете, тогда вместо ticket_number необходимо передать booking_reference с номером бронирования. */ 'ticket_number'?: string; /** * Номер бронирования. Обязателен, если не передан ticket_number. */ 'booking_reference'?: string; /** * Список пассажиров. */ 'passengers'?: Array; /** * Список перелетов. */ 'legs'?: Array; } /** * Информация о перелете. */ interface AirlineLeg { /** * Код аэропорта вылета по справочнику IATA: https://www.iata.org/publications/Pages/code-search.aspx, например LED. */ 'departure_airport': string; /** * Код аэропорта прилета по справочнику IATA: https://www.iata.org/publications/Pages/code-search.aspx, например AMS. */ 'destination_airport': string; /** * Дата вылета в формате YYYY-MM-DD по стандарту ISO 8601:2004: http://www.iso.org/iso/catalogue_detail?csnumber=40874. */ 'departure_date': string; /** * Код авиакомпании по справочнику IATA: https://www.iata.org/publications/Pages/code-search.aspx. */ 'carrier_code'?: string; } /** * Информация о пассажире. */ interface AirlinePassenger { /** * Имя пассажира. Необходимо использовать латинские буквы, например SERGEI. */ 'first_name': string; /** * Фамилия пассажира. Необходимо использовать латинские буквы, например IVANOV. */ 'last_name': string; } /** * Данные об авторизации платежа при оплате банковской картой. Присутствуют только для этих способов оплаты: банковская карта, Mir Pay, SberPay, T-Pay. */ interface AuthorizationDetails { /** * Retrieval Reference Number — идентификатор банковской транзакции. */ 'rrn'?: string; /** * Код авторизации. Выдается эмитентом и подтверждает проведение авторизации. */ 'auth_code'?: string; 'three_d_secure': ThreeDSecureDetails; } /** * Данные об НДС, если товар или услуга облагается налогом (в параметре type передано значение calculated). */ interface B2bSberbankCalculatedVatData extends B2bSberbankVatData { /** * Налоговая ставка (в процентах). Возможные значения: 5, 7, 10, 20 и 22. С 1 января 2026 года ставка НДС 22% применяется вместо ставки 20%. */ 'rate': B2bSberbankCalculatedVatDataRateEnum; /** * Сумма НДС. */ 'amount': MonetaryAmount; } declare const B2bSberbankCalculatedVatDataRateEnum: { readonly _5: "5"; readonly _7: "7"; readonly _10: "10"; readonly _20: "20"; readonly _22: "22"; }; type B2bSberbankCalculatedVatDataRateEnum = typeof B2bSberbankCalculatedVatDataRateEnum[keyof typeof B2bSberbankCalculatedVatDataRateEnum]; /** * Данные об НДС, если создается платеж на несколько товаров или услуг с разными ставками НДС (в параметре type передано значение mixed). */ interface B2bSberbankMixedVatData extends B2bSberbankVatData { /** * Сумма НДС. */ 'amount': MonetaryAmount; } /** * Банковские реквизиты плательщика (юридического лица или ИП). */ interface B2bSberbankPayerBankDetails { /** * Полное наименование организации. */ 'full_name': string; /** * Сокращенное наименование организации. */ 'short_name': string; /** * Адрес организации. */ 'address': string; /** * Индивидуальный налоговый номер (ИНН) организации. */ 'inn': string; /** * Наименование банка организации. */ 'bank_name': string; /** * Отделение банка организации. */ 'bank_branch': string; /** * Банковский идентификационный код (БИК) банка организации. */ 'bank_bik': string; /** * Номер счета организации. */ 'account': string; /** * Код причины постановки на учет (КПП) организации. */ 'kpp'?: string; } /** * Данные об НДС, если товар или услуга не облагается налогом (в параметре type передано значение untaxed). */ interface B2bSberbankUntaxedVatData extends B2bSberbankVatData {} /** * Данные о налоге на добавленную стоимость (НДС). Платеж может облагаться или не облагаться НДС. Товары могут облагаться по одной ставке НДС или по разным. */ interface B2bSberbankVatData { 'type': B2bSberbankVatDataType; } /** * Тип способа расчета НДС. */ declare const B2bSberbankVatDataType: { readonly Calculated: "calculated"; readonly Untaxed: "untaxed"; readonly Mixed: "mixed"; }; type B2bSberbankVatDataType = typeof B2bSberbankVatDataType[keyof typeof B2bSberbankVatDataType]; /** * Запрос не может быть обработан. Причиной может быть неправильный синтаксис запроса, ошибка в обязательных параметрах запроса, их отсутствие или неподдерживаемый метод. */ interface BadRequest { /** * Тип объекта. */ 'type'?: BadRequestTypeEnum; /** * Идентификатор ошибки. Используйте его, если возникла необходимость обратиться в техническую поддержку. */ 'id'?: string; /** * Подробное описание ошибки. */ 'description'?: string; /** * Название параметра, из-за которого произошла ошибка. */ 'parameter'?: string; /** * Рекомендуемое количество миллисекунд, спустя которое следует повторить запрос. */ 'retry_after'?: number; /** * Код ошибки */ 'code'?: BadRequestCodeEnum; } declare const BadRequestTypeEnum: { readonly Error: "error"; }; type BadRequestTypeEnum = typeof BadRequestTypeEnum[keyof typeof BadRequestTypeEnum]; declare const BadRequestCodeEnum: { readonly InvalidRequest: "invalid_request"; }; type BadRequestCodeEnum = typeof BadRequestCodeEnum[keyof typeof BadRequestCodeEnum]; /** * Данные банковской карты. */ interface BankCardData { /** * Первые 6 цифр номера карты (BIN). При оплате картой, сохраненной в ЮKassa: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/basics и других сервисах, переданный BIN может не соответствовать значениям last4, expiry_year, expiry_month. */ 'first6'?: string; /** * Последние 4 цифры номера карты. */ 'last4': string; /** * Срок действия, год, YYYY. */ 'expiry_year': string; /** * Срок действия, месяц, MM. */ 'expiry_month': string; 'card_type': BankCardType; 'card_product'?: BankCardProduct; /** * Код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2: https://www.iso.org/obp/ui/#iso:pub:PUB500001:en. Пример: RU. */ 'issuer_country'?: string; /** * Наименование банка, выпустившего карту. */ 'issuer_name'?: string; 'source'?: BankCardDataSource; } /** * Источник данных банковской карты. Возможные значения: mir_pay, apple_pay, google_pay. Присутствует, если пользователь при оплате выбрал карту, сохраненную в Mir Pay, Apple Pay или Google Pay. */ declare const BankCardDataSource: { readonly ApplePay: "apple_pay"; readonly GooglePay: "google_pay"; readonly MirPay: "mir_pay"; }; type BankCardDataSource = typeof BankCardDataSource[keyof typeof BankCardDataSource]; /** * Карточный продукт платежной системы, с которым ассоциирована банковская карта. Например, карточные продукты платежной системы Мир: Mir Classic, Mir Classic Credit, MIR Privilege Plus и другие. */ interface BankCardProduct { /** * Код карточного продукта. Пример: MCP */ 'code': string; /** * Название карточного продукта. Пример: MIR Privilege */ 'name'?: string; } /** * Тип банковской карты. Возможные значения: MasterCard (для карт Mastercard и Maestro), Visa (для карт Visa и Visa Electron), Mir, UnionPay, JCB, AmericanExpress, DinersClub, DiscoverCard, InstaPayment, InstaPaymentTM, Laser, Dankort, Solo, Switch и Unknown. */ declare const BankCardType: { readonly MasterCard: "MasterCard"; readonly Visa: "Visa"; readonly Mir: "Mir"; readonly UnionPay: "UnionPay"; readonly Jcb: "JCB"; readonly AmericanExpress: "AmericanExpress"; readonly DinersClub: "DinersClub"; readonly DiscoverCard: "DiscoverCard"; readonly InstaPayment: "InstaPayment"; readonly InstaPaymentTm: "InstaPaymentTM"; readonly Laser: "Laser"; readonly Dankort: "Dankort"; readonly Solo: "Solo"; readonly Switch: "Switch"; readonly Unknown: "Unknown"; }; type BankCardType = typeof BankCardType[keyof typeof BankCardType]; /** * Объект сделки (Deal) — актуальная информация о сделке. */ interface BaseDeal { 'type': DealType; } /** * Данные о сделке, в составе которой проходит платеж. Необходимо передавать, если вы проводите Безопасную сделку: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics и подтверждаете часть платежа. */ interface CapturePaymentDeal { /** * Данные о распределении денег. */ 'settlements': Array; } /** * Данные банковской карты для выплаты. */ interface CardDataForPayoutDestination { /** * Номер банковской карты. Формат: только цифры, без пробелов. Пример: 5555555555554477 */ 'number': string; } /** * Данные банковской карты (необходимы, если вы собираете данные карты пользователей на своей стороне). */ interface CardRequestData { /** * Номер банковской карты. */ 'number': string; /** * Срок действия, год, YYYY. */ 'expiry_year': string; /** * Срок действия, месяц, MM. */ 'expiry_month': string; /** * Имя владельца карты. */ 'cardholder'?: string; } interface CardRequestDataWithCsc { /** * Номер банковской карты. */ 'number': string; /** * Срок действия, год, YYYY. */ 'expiry_year': string; /** * Срок действия, месяц, MM. */ 'expiry_month': string; /** * Имя владельца карты. */ 'cardholder'?: string; /** * Код CVC2 или CVV2, 3 или 4 символа, печатается на обратной стороне карты. */ 'csc'?: string; } /** * Выбранный способ подтверждения платежа. Присутствует, когда платеж ожидает подтверждения от пользователя. Подробнее о сценариях подтверждения: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#user-confirmation */ interface Confirmation { 'type': ConfirmationType; } /** * Данные, необходимые для инициирования выбранного сценария подтверждения платежа пользователем. Подробнее о сценариях подтверждения: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#user-confirmation */ interface ConfirmationData { 'type': ConfirmationDataType; 'locale'?: Locale; } interface ConfirmationDataEmbedded extends ConfirmationData {} interface ConfirmationDataExternal extends ConfirmationData {} interface ConfirmationDataMobileApplication extends ConfirmationData { /** * URL или диплинк, на который вернется пользователь после подтверждения или отмены платежа в приложении. Если платеж делали из мобильной версии сайта, передайте URL, если из мобильного приложения — диплинк. Не более 255 символов для платежей через SberPay: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/sberpay#create-payment-mobile-application. Для других способов оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all не более 2048 символов. */ 'return_url': string; } interface ConfirmationDataQr extends ConfirmationData { /** * Адрес страницы, на которую пользователь вернется после подтверждения или отмены платежа в приложении банка. Например, если хотите вернуть пользователя на сайт, вы можете передать URL, если в мобильное приложение — диплинк. URI должен соответствовать стандарту RFC-3986: https://www.ietf.org/rfc/rfc3986.txt. Не более 2048 символов. Доступно только для платежей через СБП: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/sbp. */ 'return_url'?: string; } interface ConfirmationDataRedirect extends ConfirmationData { /** * Запрос на проведение платежа с аутентификацией по 3-D Secure. Будет работать, если оплату банковской картой вы по умолчанию принимаете без подтверждения платежа пользователем. В остальных случаях аутентификацией по 3-D Secure будет управлять ЮKassa. Если хотите принимать платежи без дополнительного подтверждения пользователем, напишите вашему менеджеру ЮKassa. */ 'enforce'?: boolean; /** * URL, на который вернется пользователь после подтверждения или отмены платежа на веб-странице. Не более 2048 символов. */ 'return_url': string; } /** * Тип сценария подтверждения платежа пользователем. Возможные значения: redirect - перенаправление пользователя на готовую страницу ЮKassa или на страницу партнера; external - ожидание самостоятельного подтверждения платежа пользователем; qr - формирование QR-кода и его отображение на странице оплаты, чтобы пользователь смог подтвердить платеж; embedded - отображение платежного виджета ЮKassa; mobile_application - перенаправление пользователя в приложение партнера для оплаты. */ declare const ConfirmationDataType: { readonly Redirect: "redirect"; readonly External: "external"; readonly Qr: "qr"; readonly Embedded: "embedded"; readonly MobileApplication: "mobile_application"; }; type ConfirmationDataType = typeof ConfirmationDataType[keyof typeof ConfirmationDataType]; interface ConfirmationEmbedded extends Confirmation { /** * Токен для инициализации платежного виджета ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/widget/basics. */ 'confirmation_token': string; } interface ConfirmationExternal extends Confirmation {} interface ConfirmationMobileApplication extends Confirmation { /** * Диплинк на мобильное приложение, в котором пользователь подтверждает платеж. */ 'confirmation_url': string; } interface ConfirmationQr extends Confirmation { /** * Данные для генерации QR-кода. */ 'confirmation_data': string; } interface ConfirmationRedirect extends Confirmation { /** * Запрос на проведение платежа с аутентификацией по 3-D Secure. Будет работать, если оплату банковской картой вы по умолчанию принимаете без подтверждения платежа пользователем. В остальных случаях аутентификацией по 3-D Secure будет управлять ЮKassa. Если хотите принимать платежи без дополнительного подтверждения пользователем, напишите вашему менеджеру ЮKassa. */ 'enforce'?: boolean; /** * URL, на который вернется пользователь после подтверждения или отмены платежа на веб-странице. Не более 2048 символов. */ 'return_url'?: string; /** * URL, на который необходимо перенаправить пользователя для подтверждения оплаты. */ 'confirmation_url': string; } /** * Тип пользовательского процесса подтверждения платежа | - redirect - необходимо направить пользователя на страницу партнера; - external - необходимо подождать, пока пользователь самостоятельно подтвердит платеж; - qr - необходимо сгенерировать QR-код и отобразить его на странице оплаты, чтобы пользователь смог подтвердить платеж; - embedded - необходимо отобразить платежный виджет ЮKassa; - mobile_application - необходимо перенаправить пользователя в приложение партнера для оплаты. */ declare const ConfirmationType: { readonly Redirect: "redirect"; readonly External: "external"; readonly Qr: "qr"; readonly Embedded: "embedded"; readonly MobileApplication: "mobile_application"; }; type ConfirmationType = typeof ConfirmationType[keyof typeof ConfirmationType]; interface CreateInvoiceRequest { 'payment_data': PaymentData; /** * Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой. */ 'cart': Array; 'delivery_method_data'?: CreateInvoiceRequestDeliveryMethodData; /** * Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2024-10-18T10:51:18.139Z */ 'expires_at': string; 'locale'?: Locale; /** * Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37». */ 'description'?: string; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * @type CreateInvoiceRequestDeliveryMethodData */ type CreateInvoiceRequestDeliveryMethodData = DeliveryMethodDataEmail | DeliveryMethodDataSelf | DeliveryMethodDataSms; interface CreatePaymentRequest { /** * Сумма платежа. Иногда партнеры ЮKassa берут с пользователя дополнительную комиссию, которая не входит в эту сумму. Сумма указывается с кодом валюты. Если вы разделяете потоки платежей, валюта платежа должна соответствовать валюте субаккаунта (recipient.gateway_id), если не разделяете — валюте аккаунта shopId в личном кабинете). */ 'amount': MonetaryAmount; /** * Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru». */ 'description'?: string; 'receipt'?: ReceiptData; 'recipient'?: Recipient; /** * Одноразовый токен для проведения оплаты, сформированный с помощью Checkout.js: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/checkout-js/basics или мобильного SDK: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/mobile-sdks/basics. */ 'payment_token'?: string; /** * Идентификатор сохраненного способа оплаты: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/basics. */ 'payment_method_id'?: string; 'payment_method_data'?: CreatePaymentRequestPaymentMethodData; 'confirmation'?: CreatePaymentRequestConfirmation; /** * Сохранение платежных данных для проведения автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/basics. Возможные значения: true — сохранить способ оплаты (сохранить платежные данные); false — провести платеж без сохранения способа оплаты. Доступно только после согласования с менеджером ЮKassa. */ 'save_payment_method'?: boolean; /** * Автоматический прием: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-true поступившего платежа. Возможные значения: true — оплата списывается сразу (платеж в одну стадию); false — оплата холдируется и списывается по вашему запросу (платеж в две стадии: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel). По умолчанию false. */ 'capture'?: boolean; /** * IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. */ 'client_ip'?: string; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; /** * Объект с данными для продажи авиабилетов. Используется только для платежей банковской картой. */ 'airline'?: Airline; /** * Данные о распределении денег — сколько и в какой магазин нужно перевести. Необходимо передавать, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. */ 'transfers'?: Array; /** * Данные о сделке, в составе которой проходит платеж. Необходимо передавать, если вы проводите Безопасную сделку: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. */ 'deal'?: PaymentDealInfo; /** * Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов. Присутствует, если вы хотите запомнить банковскую карту и отобразить ее при повторном платеже в виджете ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/widget/basics. */ 'merchant_customer_id'?: string; 'payment_order'?: PaymentOrderDataUtilities; 'receiver'?: CreatePaymentRequestReceiver; /** * Данные для отправки справки. Необходимо передавать, если вы хотите, чтобы после оплаты пользователь получил справку. Сейчас доступен один тип справок — квитанция по платежу. Это информация об успешном платеже, которую ЮKassa отправляет на электронную почту пользователя. Квитанцию можно отправить, если оплата прошла с банковской карты, через SberPay или СБП. Отправка квитанции доступна во всех сценариях интеграции: https://yookassa.ru/developers/payment-acceptance/getting-started/selecting-integration-scenario. */ 'statements'?: Array; } /** * @type CreatePaymentRequestConfirmation */ type CreatePaymentRequestConfirmation = ConfirmationDataEmbedded | ConfirmationDataExternal | ConfirmationDataMobileApplication | ConfirmationDataQr | ConfirmationDataRedirect; /** * @type CreatePaymentRequestPaymentMethodData */ type CreatePaymentRequestPaymentMethodData = PaymentMethodDataB2bSberbank | PaymentMethodDataBankCard | PaymentMethodDataCash | PaymentMethodDataElectronicCertificate | PaymentMethodDataMobileBalance | PaymentMethodDataSberBnpl | PaymentMethodDataSberLoan | PaymentMethodDataSberbank | PaymentMethodDataSbp | PaymentMethodDataTinkoffBank | PaymentMethodDataYooMoney; /** * @type CreatePaymentRequestReceiver */ type CreatePaymentRequestReceiver = ReceiverBankAccount | ReceiverDigitalWallet | ReceiverMobileBalance; /** * @type CreatePaymentRequestStatementsInner */ type CreatePaymentRequestStatementsInner = PaymentOverviewStatementData; interface CreateWebhookRequest { /** * Событие: https://yookassa.ru/developers/using-api/webhooks#events, которое вы хотите отслеживать. */ 'event': NotificationEventType; /** * URL, на который ЮKassa будет отправлять уведомления. */ 'url': string; } /** * Трехбуквенный код валюты в формате ISO-4217: https://www.iso.org/iso-4217-currency-codes.html. Пример: RUB. */ declare const CurrencyCode: { readonly Rub: "RUB"; readonly Eur: "EUR"; readonly Usd: "USD"; readonly Kzt: "KZT"; readonly Byn: "BYN"; readonly Uah: "UAH"; readonly Uzs: "UZS"; readonly Try: "TRY"; readonly Inr: "INR"; readonly Mdl: "MDL"; readonly Azn: "AZN"; readonly Amd: "AMD"; }; type CurrencyCode = typeof CurrencyCode[keyof typeof CurrencyCode]; /** * Список сделок, созданных за последние три года. Сделки отсортированы по времени создания в порядке убывания (от новых к старым). Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент. */ interface DealList { /** * Формат выдачи результатов запроса. Возможное значение: list (список). */ 'type': DealListTypeEnum; 'items': Array; /** * Указатель на следующий фрагмент списка. Обязательный параметр, если размер списка больше размера выдачи (limit) и конец выдачи не достигнут. */ 'next_cursor'?: string; } declare const DealListTypeEnum: { readonly List: "list"; }; type DealListTypeEnum = typeof DealListTypeEnum[keyof typeof DealListTypeEnum]; /** * Статус сделки. Возможные значения: opened — сделка открыта; можно выполнять платежи, возвраты и выплаты в составе сделки; closed — сделка закрыта — вознаграждение перечислено продавцу и платформе или оплата возвращена покупателю; нельзя выполнять платежи, возвраты и выплаты в составе сделки. */ declare const DealStatus: { readonly Opened: "opened"; readonly Closed: "closed"; }; type DealStatus = typeof DealStatus[keyof typeof DealStatus]; /** * Тип сделки. Фиксированное значение: safe_deal — Безопасная сделка. */ declare const DealType: { readonly SafeDeal: "safe_deal"; }; type DealType = typeof DealType[keyof typeof DealType]; /** * Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending. */ interface DeliveryMethod { 'type': DeliveryMethodTypeEnum; } declare const DeliveryMethodTypeEnum: { readonly Self: "self"; readonly Sms: "sms"; readonly Email: "email"; }; type DeliveryMethodTypeEnum = typeof DeliveryMethodTypeEnum[keyof typeof DeliveryMethodTypeEnum]; /** * Данные о способе доставки счета пользователю. Подробнее о способах доставки счетов: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/invoices/basics#send-invoice */ interface DeliveryMethodData { /** * Код способа доставки счета пользователю. */ 'type': DeliveryMethodDataTypeEnum; } declare const DeliveryMethodDataTypeEnum: { readonly Self: "self"; readonly Sms: "sms"; readonly Email: "email"; }; type DeliveryMethodDataTypeEnum = typeof DeliveryMethodDataTypeEnum[keyof typeof DeliveryMethodDataTypeEnum]; /** * Данные для выставления счета с отправкой по электронной почте. */ interface DeliveryMethodDataEmail extends DeliveryMethodData { /** * Адрес электронной почты, на который ЮKassa отправит письмо со ссылкой на счет. */ 'email': string; } /** * Данные для выставления счета с самостоятельной доставкой ссылки на счет. */ interface DeliveryMethodDataSelf extends DeliveryMethodData {} /** * Данные для выставления счета с доставкой ссылки на счет в смс. */ interface DeliveryMethodDataSms extends DeliveryMethodData { /** * Номер телефона, на который ЮKassa отправит смс со ссылкой на счет. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. */ 'phone': string; } /** * Данные способа отправки счета по по электронной почте. */ interface DeliveryMethodEmail extends DeliveryMethod {} /** * Данные для самостоятельной доставки пользователю ссылки на счет. */ interface DeliveryMethodSelf extends DeliveryMethod { /** * URL страницы счета, который необходимо передать пользователю для оплаты. Не более 2048 символов. */ 'url'?: string; } /** * Данные способа отправки счета по смс. */ interface DeliveryMethodSms extends DeliveryMethod {} /** * Описание используемого электронного сертификата. */ interface ElectronicCertificate { /** * Идентификатор сертификата. От 20 до 30 символов. */ 'certificate_id': string; /** * Количество единиц товара, которое одобрили для оплаты по этому электронному сертификату. */ 'tru_quantity': number; /** * Максимально допустимая сумма, которую может покрыть электронный сертификат для оплаты одной единицы товара. Пример: сертификат может компенсировать максимум 1000 рублей для оплаты этого товара. */ 'available_compensation': MonetaryAmount; /** * Сумма, которую одобрили для оплаты по сертификату за одну единицу товара. Пример: из 1000 рублей одобрили 500 рублей для оплаты по сертификату. */ 'applied_compensation': MonetaryAmount; } /** * Товарная позиция в одобренной корзине покупки при оплате по электронному сертификату. */ interface ElectronicCertificateApprovedPaymentArticle { /** * Порядковый номер товара в корзине. От 1 до 999 включительно. */ 'article_number': number; /** * Код ТРУ. 30 символов, две группы цифр, разделенные точкой. Формат: NNNNNNNNN.NNNNNNNNNYYYYMMMMZZZ, где NNNNNNNNN.NNNNNNNNN — код вида ТРУ по Перечню ТРУ: https://esnsi.gosuslugi.ru/classifiers/10616/data?pg=1&p=1, YYYY — код производителя, MMMM — код модели, ZZZ — код страны производителя. Пример: 329921120.06001010200080001643 Как сформировать код ТРУ: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/basics#payments-preparations-tru-code */ 'tru_code': string; /** * Код товара в вашей системе. Максимум 128 символов. */ 'article_code'?: string; /** * Список электронных сертификатов, которые используются для оплаты покупки. */ 'certificates': Array; } /** * Товарная позиция в корзине покупки при оплате по электронному сертификату. */ interface ElectronicCertificateArticle { /** * Порядковый номер товара в корзине. От 1 до 999 включительно. */ 'article_number': number; /** * Код ТРУ. 30 символов, две группы цифр, разделенные точкой. Формат: NNNNNNNNN.NNNNNNNNNYYYYMMMMZZZ, где NNNNNNNNN.NNNNNNNNN — код вида ТРУ по Перечню ТРУ: https://esnsi.gosuslugi.ru/classifiers/10616/data?pg=1&p=1, YYYY — код производителя, MMMM — код модели, ZZZ — код страны производителя. Пример: 329921120.06001010200080001643 Как сформировать код ТРУ: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/basics#payments-preparations-tru-code */ 'tru_code': string; /** * Код товара в вашей системе. Максимум 128 символов. */ 'article_code'?: string; /** * Название товара в вашей системе. Отображается на готовой платежной форме ЮKassa. Максимум 128 символов. */ 'article_name': string; /** * Количество единиц товара. Формат: целое положительное число. */ 'quantity': number; /** * Цена за единицу товара. */ 'price': MonetaryAmount; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * Данные от ФЭС НСПК для оплаты по электронному сертификату. */ interface ElectronicCertificatePayment { /** * Сумма, которая спишется с электронного сертификата. */ 'amount': MonetaryAmount; /** * Идентификатор корзины покупки, сформированной в НСПК. */ 'basket_id': string; } /** * Данные от ФЭС НСПК для оплаты по электронному сертификату. Неоходимо передавать только при оплате со сбором данных на вашей стороне: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/merchant-payment-form. */ interface ElectronicCertificatePaymentData { /** * Сумма, которую необходимо использовать по электронному сертификату, — значение totalCertAmount, которое вы получили в ФЭС НСПК в запросе на предварительное одобрение использования сертификата (Pre-Auth): https://www.nspk.ru/developer/api-fes#operation/preAuthPurchase. Сумма должна быть не больше общей суммы платежа (amount). */ 'amount': MonetaryAmount; /** * Идентификатор корзины покупки, сформированной в НСПК, — значение purchaseBasketId, которое вы получили в ФЭС НСПК в запросе на предварительное одобрение использования сертификата (Pre-Auth): https://www.nspk.ru/developer/api-fes#operation/preAuthPurchase. */ 'basket_id': string; } /** * Товарная позиция в корзине возврата при возврате на электронный сертификат. */ interface ElectronicCertificateRefundArticle { /** * Порядковый номер товара в корзине возврата. От 1 до 999 включительно. */ 'article_number': number; /** * Порядковый номер товара в одобренной корзине покупки (article_number в объекте платежа: https://yookassa.ru/developers/api#payment_object). От 1 до 999 включительно. */ 'payment_article_number': number; /** * Код ТРУ. 30 символов, две группы цифр, разделенные точкой. Формат: NNNNNNNNN.NNNNNNNNNYYYYMMMMZZZ, где NNNNNNNNN.NNNNNNNNN — код вида ТРУ по Перечню ТРУ: https://esnsi.gosuslugi.ru/classifiers/10616/data?pg=1&p=1, YYYY — код производителя, MMMM — код модели, ZZZ — код страны производителя. Пример: 329921120.06001010200080001643 Как сформировать код ТРУ: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/basics#payments-preparations-tru-code */ 'tru_code': string; /** * Количество возвращаемых единиц товара. Формат: целое положительное число. */ 'quantity': number; } /** * Данные от ФЭС НСПК для возврата на электронный сертификат. Неоходимо передавать только при оплате со сбором данных на вашей стороне: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/merchant-payment-form. */ interface ElectronicCertificateRefundDataRequest { /** * Сумма, которая вернется на электронный сертификат, — значение totalCertAmount, которое вы получили в ФЭС НСПК в запросе на предварительное одобрение возврата (Refund Pre-Auth): https://www.nspk.ru/developer/api-fes#tag/Protokol-FES-NSPK-v1/operation/preAuthReturn. */ 'amount': MonetaryAmount; /** * Идентификатор корзины возврата, сформированной в НСПК, — значение returnBasketId, которое вы получили в ФЭС НСПК в запросе на предварительное одобрение возврата (Refund Pre-Auth): https://www.nspk.ru/developer/api-fes#tag/Protokol-FES-NSPK-v1/operation/preAuthReturn. */ 'basket_id': string; } /** * Данные от ФЭС НСПК для возврата на электронный сертификат. */ interface ElectronicCertificateRefundDataResponse { /** * Идентификатор корзины возврата, сформированной в НСПК. */ 'basket_id': string; /** * Сумма, которая вернется на электронный сертификат. */ 'amount': MonetaryAmount; } /** * Возврат платежа по электронному сертификату. */ interface ElectronicCertificateRefundMethod extends RefundMethod { 'electronic_certificate'?: ElectronicCertificateRefundDataResponse; /** * Корзина возврата — список возвращаемых товаров, для оплаты которых использовался электронный сертификат. Присутствует, если оплата была на готовой странице ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/ready-made-payment-form. */ 'articles'?: Array; } /** * Данные для возврата платежа по электронному сертификату. */ interface ElectronicCertificateRefundMethodData extends RefundMethodData { 'electronic_certificate'?: ElectronicCertificateRefundDataRequest; /** * Корзина возврата (в терминах НСПК) — список возвращаемых товаров, для оплаты которых использовался электронный сертификат. Данные должны соответствовать товарам из одобренной корзины покупки (articles в объекте платежа: https://yookassa.ru/developers/api#payment_object). Необходимо передавать только при оплате на готовой странице ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/ready-made-payment-form. */ 'articles'?: Array; } /** * Момент перечисления вам вознаграждения платформы. Возможные значения: payment_succeeded — после успешной оплаты; deal_closed — при закрытии сделки после успешной выплаты. */ declare const FeeMoment: { readonly PaymentSucceeded: "payment_succeeded"; readonly DealClosed: "deal_closed"; }; type FeeMoment = typeof FeeMoment[keyof typeof FeeMoment]; /** * Настройки магазина для отправки чеков в налоговую: https://yookassa.ru/developers/payment-acceptance/receipts/basics. Присутствует, если вы запрашивали настройки магазина и этот магазин использует решения ЮKassa для отправки чеков. Отсутствует, если магазин еще не включал отправку чеков через ЮKassa. */ interface FiscalizationData { /** * В настройках магазина включена отправка чеков. Возможные значения: true — магазин отправляет данные для чеков через ЮKassa; false — магазин выключил отправку чеков через ЮKassa. */ 'enabled': boolean; 'provider': FiscalizationProvider; } /** * Решение ЮKassa, которое магазин использует для отправки чеков. Возможные значения: 54-ФЗ: Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics — avanpost; 54-ФЗ: сторонняя онлайн-касса: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics (наименование онлайн-кассы) — 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). */ declare const FiscalizationProvider: { readonly Atol: "atol"; readonly Avanpost: "avanpost"; readonly AQsi: "a_qsi"; readonly BusinessRu: "business_ru"; readonly DigitalKassa: "digital_kassa"; readonly Evotor: "evotor"; readonly FirstOfd: "first_ofd"; readonly KitInvest: "kit_invest"; readonly Komtet: "komtet"; readonly LifePay: "life_pay"; readonly Mertrade: "mertrade"; readonly ModulKassa: "modul_kassa"; readonly Rocket: "rocket"; readonly ShtrihM: "shtrih_m"; }; type FiscalizationProvider = typeof FiscalizationProvider[keyof typeof FiscalizationProvider]; /** * Секретный ключ указан верно, но не хватает прав для совершения операции. */ interface Forbidden { /** * Тип объекта. */ 'type'?: ForbiddenTypeEnum; /** * Идентификатор ошибки. Используйте его, если возникла необходимость обратиться в техническую поддержку. */ 'id'?: string; /** * Подробное описание ошибки. */ 'description'?: string; /** * Название параметра, из-за которого произошла ошибка. */ 'parameter'?: string; /** * Рекомендуемое количество миллисекунд, спустя которое следует повторить запрос. */ 'retry_after'?: number; /** * Код ошибки. */ 'code'?: ForbiddenCodeEnum; } declare const ForbiddenTypeEnum: { readonly Error: "error"; }; type ForbiddenTypeEnum = typeof ForbiddenTypeEnum[keyof typeof ForbiddenTypeEnum]; declare const ForbiddenCodeEnum: { readonly Forbidden: "forbidden"; }; type ForbiddenCodeEnum = typeof ForbiddenCodeEnum[keyof typeof ForbiddenCodeEnum]; /** * Список участников СБП. Участники СБП отсортированы по идентификатору участника в порядке убывания. */ interface GetSbpBanksResponse { /** * Формат выдачи результатов запроса. Возможное значение: list (список). */ 'type': GetSbpBanksResponseTypeEnum; 'items': Array; } declare const GetSbpBanksResponseTypeEnum: { readonly List: "list"; }; type GetSbpBanksResponseTypeEnum = typeof GetSbpBanksResponseTypeEnum[keyof typeof GetSbpBanksResponseTypeEnum]; /** * Сущность была раньше, но была умышленно удалена и теперь недоступна. */ interface Gone { /** * Тип объекта. */ 'type'?: GoneTypeEnum; /** * Идентификатор ошибки. Используйте его, если возникла необходимость обратиться в техническую поддержку. */ 'id'?: string; /** * Подробное описание ошибки. */ 'description'?: string; /** * Название параметра, из-за которого произошла ошибка. */ 'parameter'?: string; /** * Рекомендуемое количество миллисекунд, спустя которое следует повторить запрос. */ 'retry_after'?: number; /** * Код ошибки. */ 'code'?: GoneCodeEnum; } declare const GoneTypeEnum: { readonly Error: "error"; }; type GoneTypeEnum = typeof GoneTypeEnum[keyof typeof GoneTypeEnum]; declare const GoneCodeEnum: { readonly Gone: "gone"; }; type GoneCodeEnum = typeof GoneCodeEnum[keyof typeof GoneCodeEnum]; /** * Данные чека, зарегистрированного в ФНС. Устаревший параметр. Раньше возвращался при проведении выплат самозанятым. Сейчас функциональность недоступна. Параметр сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. */ interface IncomeReceipt { /** * Описание услуги, оказанной получателем выплаты. Не более 50 символов. */ 'service_name': string; /** * Идентификатор чека в сервисе. Пример: 208jd98zqe */ 'npd_receipt_id'?: string; /** * Ссылка на зарегистрированный чек. Пример: https://www.nalog.gov.ru/api/v1/receipt/<Идентификатор чека>/print */ 'url'?: string; /** * Сумма, указанная в чеке. Присутствует, если в запросе передавалась сумма для печати в чеке. */ 'amount'?: MonetaryAmount; } /** * Данные отраслевого реквизита. */ interface IndustryDetails { /** * Идентификатор федерального органа исполнительной власти (тег в 54 ФЗ — 1262). */ 'federal_id': string; /** * Дата документа основания (тег в 54 ФЗ — 1263). Передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601 */ 'document_date': string; /** * Номер нормативного акта федерального органа исполнительной власти, регламентирующего порядок заполнения реквизита «значение отраслевого реквизита» (тег в 54 ФЗ — 1264). */ 'document_number': string; /** * Значение отраслевого реквизита (тег в 54 ФЗ — 1265). */ 'value': string; } /** * В заголовке Authorization указан неверный ключ. */ interface InvalidCredentials { /** * Тип объекта. */ 'type'?: InvalidCredentialsTypeEnum; /** * Идентификатор ошибки. Используйте его, если возникла необходимость обратиться в техническую поддержку. */ 'id'?: string; /** * Подробное описание ошибки. */ 'description'?: string; /** * Название параметра, из-за которого произошла ошибка. */ 'parameter'?: string; /** * Рекомендуемое количество миллисекунд, спустя которое следует повторить запрос. */ 'retry_after'?: number; /** * Код ошибки */ 'code'?: InvalidCredentialsCodeEnum; } declare const InvalidCredentialsTypeEnum: { readonly Error: "error"; }; type InvalidCredentialsTypeEnum = typeof InvalidCredentialsTypeEnum[keyof typeof InvalidCredentialsTypeEnum]; declare const InvalidCredentialsCodeEnum: { readonly InvalidCredentials: "invalid_credentials"; }; type InvalidCredentialsCodeEnum = typeof InvalidCredentialsCodeEnum[keyof typeof InvalidCredentialsCodeEnum]; /** * Объект счета (Invoice) — актуальная информация о счете. */ interface Invoice { /** * Идентификатор счета в ЮKassa. */ 'id': string; 'status': InvoiceStatus; /** * Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой. */ 'cart': Array; 'delivery_method'?: InvoiceDeliveryMethod; 'payment_details'?: PaymentDetails; /** * Дата и время создания счета на оплату. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'created_at': string; /** * Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending. */ 'expires_at'?: string; /** * Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37». */ 'description'?: string; 'cancellation_details'?: InvoiceCancellationDetails; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * Комментарий к статусу canceled: кто отменил счет и по какой причине. */ interface InvoiceCancellationDetails { /** * Участник процесса, который принял решение об отмене счета. Возможные значения: merchant — продавец товаров и услуг (вы); yoo_money — ЮKassa. */ 'party': InvoiceCancellationDetailsPartyEnum; /** * Причина отмены счета. Возможные значения: invoice_canceled — счет отменен вручную: https://yookassa.ru/docs/support/merchant/invoices-to-clients/invoicing#invoicing__cancel из личного кабинета ЮKassa; invoice_expired — истек срок действия счета, который вы установили в запросе на создание счета в параметре expires_at, и по счету нет ни одного успешного платежа; general_decline — причина не детализирована, поэтому пользователю следует обратиться к инициатору отмены счета за уточнением подробностей; payment_canceled — платеж отменен по API: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#cancel при оплате в две стадии; payment_expired_on_capture — истек срок списания оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#hold для платежа в две стадии. */ 'reason': InvoiceCancellationDetailsReasonEnum; } declare const InvoiceCancellationDetailsPartyEnum: { readonly YooMoney: "yoo_money"; readonly Merchant: "merchant"; }; type InvoiceCancellationDetailsPartyEnum = typeof InvoiceCancellationDetailsPartyEnum[keyof typeof InvoiceCancellationDetailsPartyEnum]; declare const InvoiceCancellationDetailsReasonEnum: { readonly InvoiceCanceled: "invoice_canceled"; readonly InvoiceExpired: "invoice_expired"; readonly GeneralDecline: "general_decline"; readonly PaymentCanceled: "payment_canceled"; readonly PaymentExpiredOnCapture: "payment_expired_on_capture"; }; type InvoiceCancellationDetailsReasonEnum = typeof InvoiceCancellationDetailsReasonEnum[keyof typeof InvoiceCancellationDetailsReasonEnum]; /** * @type InvoiceDeliveryMethod */ type InvoiceDeliveryMethod = DeliveryMethodEmail | DeliveryMethodSelf | DeliveryMethodSms; /** * Статус счета. Возможные значения: pending — счет создан и ожидает успешной оплаты; succeeded — счет успешно оплачен, есть связанный платеж в статусе succeeded (финальный и неизменяемый статус для платежей в одну стадию); canceled — вы отменили счет, успешный платеж по нему не поступил или был отменен (при оплате в две стадии) либо истек срок действия счета (финальный и неизменяемый статус). Подробнее про жизненный цикл счета: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/invoices/basics#invoice-status */ declare const InvoiceStatus: { readonly Pending: "pending"; readonly Succeeded: "succeeded"; readonly Canceled: "canceled"; }; type InvoiceStatus = typeof InvoiceStatus[keyof typeof InvoiceStatus]; /** * Данные банковской карты. */ interface InvoicingBankCardData { /** * Первые 6 цифр номера карты (BIN). */ 'first6': string; /** * Последние 4 цифры номера карты. */ 'last4': string; /** * Срок действия, год, YYYY. */ 'expiry_year': string; /** * Срок действия, месяц, MM. */ 'expiry_month': string; 'card_type': BankCardType; } /** * Данные о товаре или услуге в корзине. */ interface LineItem { /** * Название товара или услуги (от 1 до 128 символов). Пользователь увидит его на странице счета перед оплатой. */ 'description': string; /** * Полная цена товара или услуги. Пользователь увидит ее на странице счета перед оплатой. */ 'price': MonetaryAmount; /** * Итоговая цена товара с учетом скидки. Если передана, то на странице счета цена отобразится с учетом скидки. Не нужно передавать, если пользователь оплачивает полную стоимость товара или услуги. */ 'discount_price'?: MonetaryAmount; /** * Количество товара. Можно передать целое или дробное число. Разделитель дробной части — точка, разделитель тысяч отсутствует, максимум три знака после точки. Пример: 5.000 */ 'quantity': number; } /** * Язык интерфейса, писем и смс, которые будет видеть или получать пользователь. Формат соответствует ISO/IEC 15897: https://en.wikipedia.org/wiki/Locale_(computer_software). Возможные значения: ru_RU, en_US. Регистр важен. */ declare const Locale: { readonly RuRu: "ru_RU"; readonly EnUs: "en_US"; }; type Locale = typeof Locale[keyof typeof Locale]; /** * Код товара (тег в 54 ФЗ — 1163). Обязательный параметр, если одновременно выполняются эти условия: вы используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2; товар нужно маркировать: http://docs.cntd.ru/document/902192509. Должно быть заполнено хотя бы одно поле. */ interface MarkCodeInfo { /** * Код товара в том виде, в котором он был прочитан сканером (тег в 54 ФЗ — 2000). Нужно передавать, если используете онлайн-кассу Orange Data. Пример: 010460406000590021N4N57RTCBUZTQ\\u001d2403054002410161218\\u001d1424010191ffd0\\u001g92tIAF/YVpU4roQS3M/m4z78yFq0nc/WsSmLeX6QkF/YVWwy5IMYAeiQ91Xa2m/fFSJcOkb2N+uUUtfr4n0mOX0Q== */ 'mark_code_raw'?: string; /** * Нераспознанный код товара (тег в 54 ФЗ — 1300). */ 'unknown'?: string; /** * Код товара в формате EAN-8 (тег в 54 ФЗ — 1301). */ 'ean_8'?: string; /** * Код товара в формате EAN-13 (тег в 54 ФЗ — 1302). */ 'ean_13'?: string; /** * Код товара в формате ITF-14 (тег в 54 ФЗ — 1303). */ 'itf_14'?: string; /** * Код товара в формате GS1.0 (тег в 54 ФЗ — 1304). Можно передавать, если используете онлайн-кассу Orange Data, aQsi, Кит Инвест, АТОЛ Онлайн. */ 'gs_10'?: string; /** * Код товара в формате GS1.M (тег в 54 ФЗ — 1305). */ 'gs_1m'?: string; /** * Код товара в формате короткого кода маркировки (тег в 54 ФЗ — 1306). */ 'short'?: string; /** * Контрольно-идентификационный знак мехового изделия (тег в 54 ФЗ — 1307). */ 'fur'?: string; /** * Код товара в формате ЕГАИС-2.0 (тег в 54 ФЗ — 1308). */ 'egais_20'?: string; /** * Код товара в формате ЕГАИС-3.0 (тег в 54 ФЗ — 1309). */ 'egais_30'?: string; } /** * Дробное количество маркированного товара (тег в 54 ФЗ — 1291). Обязательный параметр, если одновременно выполняются эти условия: вы используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2; товар нужно маркировать: http://docs.cntd.ru/document/902192509; поле measure имеет значение piece. Пример: вы продаете поштучно карандаши. Они поставляются пачками по 100 штук с одним кодом маркировки. При продаже одного карандаша нужно в numerator передать 1, а в denominator — 100. */ interface MarkQuantity { /** * Числитель — количество продаваемых товаров из одной потребительской упаковки (тег в 54 ФЗ — 1293). Не может превышать denominator. */ 'numerator': number; /** * Знаменатель — общее количество товаров в потребительской упаковке (тег в 54 ФЗ — 1294). */ 'denominator': number; } /** * Объект настроек магазина или шлюза (Me) — актуальная информация о настройках магазина или шлюза. */ interface Me { /** * Идентификатор магазина или шлюза. */ 'account_id': string; /** * Статус магазина или шлюза. Возможные значения: enabled — подключен к ЮKassa, может проводить платежи или выплаты; disabled — не может проводить платежи или выплаты (еще не подключен, закрыт или временно не работает). */ 'status': MeStatusEnum; /** * Это тестовый магазин или шлюз. */ 'test': boolean; 'fiscalization'?: FiscalizationData; /** * Устаревший параметр, который раньше использовался для определения настроек отправки чеков в налоговую. Сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. Используйте объект fiscalization, чтобы определить, какие у магазина настройки отправки чеков. */ 'fiscalization_enabled'?: boolean; /** * Список способов оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all, доступных магазину. Присутствует, если вы запрашивали настройки магазина. */ 'payment_methods'?: Array; /** * ИНН магазина (от 1 до 20 цифр). Присутствует, если вы запрашивали настройки магазина. */ 'itn'?: string; /** * Список способов получения выплат, доступных шлюзу. Возможные значения: bank_card — выплаты на банковские карты; yoo_money — выплаты на кошельки ЮMoney; sbp — выплаты через СБП. Присутствует, если вы запрашивали настройки шлюза. */ 'payout_methods'?: Array; /** * Название шлюза, которое отображается в личном кабинете ЮKassa. Присутствует, если вы запрашивали настройки шлюза. */ 'name'?: string; /** * Баланс вашего шлюза. Присутствует, если вы запрашивали настройки шлюза. */ 'payout_balance'?: MonetaryAmount; } declare const MeStatusEnum: { readonly Enabled: "enabled"; readonly Disabled: "disabled"; }; type MeStatusEnum = typeof MeStatusEnum[keyof typeof MeStatusEnum]; /** * Объект ошибки. */ interface ModelError { /** * Тип объекта. */ 'type'?: ModelErrorTypeEnum; /** * Идентификатор ошибки. Используйте его, если возникла необходимость обратиться в техническую поддержку. */ 'id'?: string; /** * Подробное описание ошибки. */ 'description'?: string; /** * Название параметра, из-за которого произошла ошибка. */ 'parameter'?: string; /** * Рекомендуемое количество миллисекунд, спустя которое следует повторить запрос. */ 'retry_after'?: number; } declare const ModelErrorTypeEnum: { readonly Error: "error"; }; type ModelErrorTypeEnum = typeof ModelErrorTypeEnum[keyof typeof ModelErrorTypeEnum]; /** * Сумма в выбранной валюте. */ interface MonetaryAmount { /** * Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. */ 'value': string; 'currency': CurrencyCode; } /** * Сущность не найдена. */ interface NotFound { /** * Тип объекта. */ 'type'?: NotFoundTypeEnum; /** * Идентификатор ошибки. Используйте его, если возникла необходимость обратиться в техническую поддержку. */ 'id'?: string; /** * Подробное описание ошибки. */ 'description'?: string; /** * Название параметра, из-за которого произошла ошибка. */ 'parameter'?: string; /** * Рекомендуемое количество миллисекунд, спустя которое следует повторить запрос. */ 'retry_after'?: number; /** * Код ошибки. */ 'code'?: NotFoundCodeEnum; } declare const NotFoundTypeEnum: { readonly Error: "error"; }; type NotFoundTypeEnum = typeof NotFoundTypeEnum[keyof typeof NotFoundTypeEnum]; declare const NotFoundCodeEnum: { readonly NotFound: "not_found"; }; type NotFoundCodeEnum = typeof NotFoundCodeEnum[keyof typeof NotFoundCodeEnum]; declare const NotificationEventType: { readonly PaymentWaitingForCapture: "payment.waiting_for_capture"; readonly PaymentSucceeded: "payment.succeeded"; readonly PaymentCanceled: "payment.canceled"; readonly RefundSucceeded: "refund.succeeded"; }; type NotificationEventType = typeof NotificationEventType[keyof typeof NotificationEventType]; /** * Данные операционного реквизита чека */ interface OperationalDetails { /** * Идентификатор операции (тег в 54 ФЗ — 1271). Число от 0 до 255. */ 'operation_id': number; /** * Данные операции (тег в 54 ФЗ — 1272). */ 'value': string; /** * Время создания операции (тег в 54 ФЗ — 1273). Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'created_at': string; } /** * Объект платежа (Payment) — актуальная информация о платеже. */ interface Payment { /** * Идентификатор платежа в ЮKassa. */ 'id': string; 'status': PaymentStatus; /** * Сумма платежа. Иногда партнеры ЮKassa берут с пользователя дополнительную комиссию, которая не входит в эту сумму. Сумма указывается с кодом валюты. Если вы разделяете потоки платежей, валюта платежа должна соответствовать валюте субаккаунта (recipient.gateway_id), если не разделяете — валюте аккаунта shopId в личном кабинете). */ 'amount': MonetaryAmount; /** * Сумма платежа, которую получит магазин, — значение amount за вычетом комиссии ЮKassa и суммы НДС с этой комиссии. Если вы партнер: https://yookassa.ru/developers/solutions-for-platforms/partners-api/basics и для аутентификации запросов используете OAuth-токен, запросите у магазина право: https://yookassa.ru/developers/solutions-for-platforms/partners-api/oauth/basics на получение информации о комиссиях при платежах. */ 'income_amount'?: MonetaryAmount; /** * Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru». */ 'description'?: string; 'recipient': PaymentRecipient; 'payment_method'?: PaymentPaymentMethod; /** * Время подтверждения платежа. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. */ 'captured_at'?: string; /** * Время создания заказа. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'created_at': string; /** * Время, до которого вы можете бесплатно отменить или подтвердить платеж. В указанное время платеж в статусе waiting_for_capture будет автоматически отменен. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'expires_at'?: string; 'confirmation'?: PaymentConfirmation; /** * Признак тестовой операции. */ 'test': boolean; /** * Сумма, которая вернулась пользователю. Присутствует, если у этого платежа есть успешные возвраты. */ 'refunded_amount'?: MonetaryAmount; /** * Признак оплаты заказа. */ 'paid': boolean; /** * Возможность провести возврат по API. */ 'refundable': boolean; /** * Статус регистрации чека. Возможные значения: pending — данные в обработке; succeeded — чек успешно зарегистрирован; canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную. Присутствует, если вы используете решения ЮKassa для отправки чеков в налоговую: https://yookassa.ru/developers/payment-acceptance/receipts/basics. */ 'receipt_registration'?: ReceiptRegistrationStatus; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; 'cancellation_details'?: PaymentCancellationDetails; 'authorization_details'?: AuthorizationDetails; /** * Данные о распределении денег — сколько и в какой магазин нужно перевести. Присутствует, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. */ 'transfers'?: Array; /** * Данные о сделке, в составе которой проходит платеж. Присутствует, если вы проводите Безопасную сделку: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. */ 'deal'?: PaymentDealInfo; /** * Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов. Присутствует, если вы хотите запомнить банковскую карту и отобразить ее при повторном платеже в виджете ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/widget/basics. */ 'merchant_customer_id'?: string; 'invoice_details'?: PaymentInvoiceDetails; } /** * Комментарий к статусу canceled: кто отменил платеж и по какой причине. Подробнее про неуспешные платежи: https://yookassa.ru/developers/payment-acceptance/after-the-payment/declined-payments */ interface PaymentCancellationDetails { /** * Участник процесса платежа, который принял решение об отмене транзакции. Может принимать значения yoo_money, payment_network и merchant. Подробнее про инициаторов отмены платежа: https://yookassa.ru/developers/payment-acceptance/after-the-payment/declined-payments#cancellation-details-party */ 'party': PaymentCancellationDetailsPartyEnum; /** * Причина отмены платежа. Перечень и описание возможных значений: https://yookassa.ru/developers/payment-acceptance/after-the-payment/declined-payments#cancellation-details-reason */ 'reason': PaymentCancellationDetailsReasonEnum; } declare const PaymentCancellationDetailsPartyEnum: { readonly YooMoney: "yoo_money"; readonly PaymentNetwork: "payment_network"; readonly Merchant: "merchant"; }; type PaymentCancellationDetailsPartyEnum = typeof PaymentCancellationDetailsPartyEnum[keyof typeof PaymentCancellationDetailsPartyEnum]; declare const PaymentCancellationDetailsReasonEnum: { readonly _3dSecureFailed: "3d_secure_failed"; readonly CallIssuer: "call_issuer"; readonly CardExpired: "card_expired"; readonly PaymentMethodLimitExceeded: "payment_method_limit_exceeded"; readonly PaymentMethodRestricted: "payment_method_restricted"; readonly CountryForbidden: "country_forbidden"; readonly GeneralDecline: "general_decline"; readonly FraudSuspected: "fraud_suspected"; readonly IdentificationRequired: "identification_required"; readonly InsufficientFunds: "insufficient_funds"; readonly InvalidCardNumber: "invalid_card_number"; readonly InvalidCsc: "invalid_csc"; readonly IssuerUnavailable: "issuer_unavailable"; readonly CanceledByMerchant: "canceled_by_merchant"; readonly PermissionRevoked: "permission_revoked"; readonly InternalTimeout: "internal_timeout"; readonly ExpiredOnConfirmation: "expired_on_confirmation"; readonly ExpiredOnCapture: "expired_on_capture"; readonly UnsupportedMobileOperator: "unsupported_mobile_operator"; readonly DealExpired: "deal_expired"; }; type PaymentCancellationDetailsReasonEnum = typeof PaymentCancellationDetailsReasonEnum[keyof typeof PaymentCancellationDetailsReasonEnum]; interface PaymentCaptureRequest { /** * Итоговая сумма, которая спишется с пользователя. Можно указать часть исходной суммы, тогда остаток вернется пользователю. Для этого проверьте, что выбранный способ оплаты поддерживает частичное списание: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-partly. Сумма указывается с кодом валюты. Если вы разделяете потоки платежей, валюта платежа должна соответствовать валюте субаккаунта (recipient.gateway_id), если не разделяете — валюте аккаунта shopId в личном кабинете). */ 'amount'?: MonetaryAmount; 'receipt'?: ReceiptData; /** * Объект с данными для продажи авиабилетов. Используется только для платежей банковской картой. */ 'airline'?: Airline; /** * Данные об актуальном распределении денег — сколько и в какой магазин нужно перевести. Необходимо передавать, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics и подтверждаете часть платежа. */ 'transfers'?: Array; 'deal'?: CapturePaymentDeal; } /** * @type PaymentConfirmation */ type PaymentConfirmation = ConfirmationEmbedded | ConfirmationExternal | ConfirmationMobileApplication | ConfirmationQr | ConfirmationRedirect; /** * Данные для проведения платежа по выставленному счету. */ interface PaymentData { /** * Сумма платежа. Должна укладываться в лимиты: https://yookassa.ru/docs/support/payments/limits. Сумма указывается с кодом валюты. Если вы разделяете потоки платежей, валюта платежа должна соответствовать валюте субаккаунта (recipient.gateway_id), если не разделяете — валюте аккаунта shopId в личном кабинете). */ 'amount': MonetaryAmount; 'receipt'?: ReceiptData; 'recipient'?: Recipient; /** * Сохранение платежных данных для проведения автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/basics. Возможные значения: true — сохранить способ оплаты (сохранить платежные данные); false — провести платеж без сохранения способа оплаты. Доступно только после согласования с менеджером ЮKassa. */ 'save_payment_method'?: boolean; /** * Автоматический прием: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-true поступившего платежа. Возможные значения: true — оплата списывается сразу (платеж в одну стадию); false — оплата холдируется и списывается по вашему запросу (платеж в две стадии: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel). По умолчанию false. */ 'capture'?: boolean; /** * IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. */ 'client_ip'?: string; /** * Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru». */ 'description'?: string; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } interface PaymentDealInfo { /** * Идентификатор сделки. */ 'id': string; /** * Данные о распределении денег. */ 'settlements': Array; } /** * Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#user-confirmation. */ interface PaymentDetails { /** * Идентификатор платежа в ЮKassa. */ 'id': string; /** * Статус платежа. Возможные значения: waiting_for_capture — для платежей в две стадии: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel: платеж оплачен, деньги авторизованы, вам необходимо списать оплату или отменить платеж; succeeded — платеж успешно завершен, деньги будут перечислены на ваш расчетный счет в соответствии с вашим договором с ЮKassa (финальный и неизменяемый статус); canceled — для платежей в две стадии: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel: вы отменили платеж по API (финальный и неизменяемый статус). */ 'status': PaymentStatus; } /** * Данные о выставленном счете, в рамках которого проведен платеж. */ interface PaymentInvoiceDetails { /** * Идентификатор счета в ЮKassa. */ 'id'?: string; } /** * Список платежей. Платежи отсортированы по времени создания в порядке убывания (от новых к старым). Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент. */ interface PaymentList { /** * Формат выдачи результатов запроса. Возможное значение: list (список). */ 'type': PaymentListTypeEnum; 'items': Array; /** * Указатель на следующий фрагмент списка. Обязательный параметр, если размер списка больше размера выдачи (limit) и конец выдачи не достигнут. */ 'next_cursor'?: string; } declare const PaymentListTypeEnum: { readonly List: "list"; }; type PaymentListTypeEnum = typeof PaymentListTypeEnum[keyof typeof PaymentListTypeEnum]; /** * Способ оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all, который был использован для этого платежа. */ interface PaymentMethod { 'type': PaymentMethodType; /** * Идентификатор способа оплаты. */ 'id': string; /** * Признак сохранения способа оплаты для автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/pay-with-saved. Возможные значения: true — способ оплаты сохранен для автоплатежей и выплат; false — способ оплаты не сохранен. */ 'saved': boolean; /** * Статус проверки и сохранения способа оплаты. Возможные значения: pending — ожидает действий от пользователя; active — способ оплаты сохранен, его можно использовать для автоплатежей или выплат; inactive — способ оплаты не сохранен: возникла ошибка или не было попытки сохранения способа оплаты. */ 'status': PaymentMethodStatus; /** * Название способа оплаты. */ 'title'?: string; } /** * Оплата через Альфа-Клик. */ interface PaymentMethodAlfabank extends PaymentMethod { /** * Логин пользователя в Альфа-Клике (привязанный телефон или дополнительный логин). */ 'login'?: string; } /** * Оплата через Apple Pay. */ interface PaymentMethodApplePay extends PaymentMethod {} /** * Оплата через Сбербанк Бизнес Онлайн. */ interface PaymentMethodB2bSberbank extends PaymentMethod { /** * Назначение платежа (не больше 210 символов). */ 'payment_purpose': string; 'vat_data': PaymentMethodB2bSberbankAllOfVatData; 'payer_bank_details'?: B2bSberbankPayerBankDetails; } /** * @type PaymentMethodB2bSberbankAllOfVatData */ type PaymentMethodB2bSberbankAllOfVatData = B2bSberbankCalculatedVatData | B2bSberbankMixedVatData | B2bSberbankUntaxedVatData; /** * Оплата банковской картой. */ interface PaymentMethodBankCard extends PaymentMethod { 'card'?: BankCardData; } /** * Оплата наличными в терминалах. */ interface PaymentMethodCash extends PaymentMethod {} /** * Данные для оплаты конкретным способом: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/basics#integration-options (payment_method). Вы можете не передавать этот объект в запросе. В этом случае пользователь будет выбирать способ оплаты на стороне ЮKassa. */ interface PaymentMethodData { 'type': PaymentMethodDataTypeEnum; } declare const PaymentMethodDataTypeEnum: { readonly BankCard: "bank_card"; readonly Cash: "cash"; readonly Sberbank: "sberbank"; readonly TinkoffBank: "tinkoff_bank"; readonly YooMoney: "yoo_money"; readonly MobileBalance: "mobile_balance"; readonly B2bSberbank: "b2b_sberbank"; readonly Sbp: "sbp"; readonly SberLoan: "sber_loan"; readonly ElectronicCertificate: "electronic_certificate"; readonly SberBnpl: "sber_bnpl"; }; type PaymentMethodDataTypeEnum = typeof PaymentMethodDataTypeEnum[keyof typeof PaymentMethodDataTypeEnum]; /** * Данные для оплаты через СберБанк Бизнес Онлайн. */ interface PaymentMethodDataB2bSberbank extends PaymentMethodData { /** * Назначение платежа (не больше 210 символов). */ 'payment_purpose': string; 'vat_data': PaymentMethodDataB2bSberbankAllOfVatData; } /** * @type PaymentMethodDataB2bSberbankAllOfVatData */ type PaymentMethodDataB2bSberbankAllOfVatData = B2bSberbankCalculatedVatData | B2bSberbankMixedVatData | B2bSberbankUntaxedVatData; /** * Данные для оплаты банковской картой. */ interface PaymentMethodDataBankCard extends PaymentMethodData { 'card'?: CardRequestDataWithCsc; } /** * Данные для оплаты наличными в терминалах России или СНГ. */ interface PaymentMethodDataCash extends PaymentMethodData { /** * Телефон пользователя, на который придет смс с кодом платежа (для внесения наличных). Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. Поле можно оставить пустым: пользователь сможет заполнить его при оплате на стороне ЮKassa. */ 'phone'?: string; } /** * Данные для оплаты по электронному сертификату. */ interface PaymentMethodDataElectronicCertificate extends PaymentMethodData { 'card'?: CardRequestDataWithCsc; 'electronic_certificate'?: ElectronicCertificatePaymentData; /** * Корзина покупки (в терминах НСПК) — список товаров, которые можно оплатить по сертификату. Необходимо передавать только при оплате на готовой странице ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/ready-made-payment-form. */ 'articles'?: Array; } /** * Данные для оплаты с баланса мобильного телефона. */ interface PaymentMethodDataMobileBalance extends PaymentMethodData { /** * Телефон, с баланса которого осуществляется платеж. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. */ 'phone': string; } /** * Данные для оплаты через сервис «Плати частями». */ interface PaymentMethodDataSberBnpl extends PaymentMethodData { /** * Номер телефона пользователя. Передается партнеру и используется для авторизации в сервисе «Плати частями». Максимум 15 символов. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164. Пример: 79000000000. */ 'phone'?: string; } /** * Данные для оплаты в кредит или рассрочку от СберБанка. */ interface PaymentMethodDataSberLoan extends PaymentMethodData {} /** * Данные для оплаты через SberPay. */ interface PaymentMethodDataSberbank extends PaymentMethodData { /** * Телефон пользователя, на который зарегистрирован аккаунт в SberPay. Необходим для подтверждения оплаты по смс (сценарий подтверждения external). Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. */ 'phone'?: string; } /** * Данные для оплаты через СБП */ interface PaymentMethodDataSbp extends PaymentMethodData {} /** * Данные для оплаты через T-Pay. */ interface PaymentMethodDataTinkoffBank extends PaymentMethodData {} /** * Данные для проведения оплаты из кошелька ЮMoney. */ interface PaymentMethodDataYooMoney extends PaymentMethodData {} /** * Оплата по электронному сертификату. */ interface PaymentMethodElectronicCertificate extends PaymentMethod { /** * Данные банковской карты «Мир». */ 'card'?: BankCardData; 'electronic_certificate'?: ElectronicCertificatePayment; /** * Одобренная корзина покупки — список товаров, одобренных к оплате по электронному сертификату. Присутствует только при оплате на готовой странице ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/ready-made-payment-form. */ 'articles'?: Array; } /** * Оплата через Google Pay. */ interface PaymentMethodGooglePay extends PaymentMethod {} /** * Оплата через сервис «Заплатить по частям» (в кредит или рассрочку). */ interface PaymentMethodInstallments extends PaymentMethod {} /** * Оплата с баланса мобильного телефона. */ interface PaymentMethodMobileBalance extends PaymentMethod {} /** * Оплата из кошелька QIWI Wallet. */ interface PaymentMethodQiwi extends PaymentMethod {} /** * Оплата через сервис «Плати частями». */ interface PaymentMethodSberBnpl extends PaymentMethod {} /** * Оплата в кредит или рассрочку от СберБанка. */ interface PaymentMethodSberLoan extends PaymentMethod { /** * Тариф кредита, который пользователь выбрал при оплате. Возможные значения: loan — кредит; installments_XX — рассрочка, где XX — количество месяцев для выплаты рассрочки. Например, installments_3 — рассрочка на 3 месяца. Присутствует для платежей в статусе waiting_for_capture и succeeded. */ 'loan_option'?: string; /** * Сумма скидки для рассрочки. Присутствует для платежей в статусе waiting_for_capture и succeeded, если пользователь выбрал рассрочку. */ 'discount_amount'?: MonetaryAmount; /** * Время, когда заканчивается период охлаждения: https://yookassa.ru/docs/support/payments/credit-purchases-by-sberbank-with-cooling-off кредита или рассрочки. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Присутствует для платежей в статусе pending, которые по закону: https://www.consultant.ru/document/cons_doc_LAW_498604/ попадают под процедуру охлаждения. */ 'suspended_until'?: string; } /** * Оплата через SberPay. */ interface PaymentMethodSberbank extends PaymentMethod { /** * Телефон пользователя, на который зарегистрирован аккаунт в SberPay. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. */ 'phone'?: string; 'card'?: InvoicingBankCardData; } /** * Оплата через СБП (Система быстрых платежей ЦБ РФ). */ interface PaymentMethodSbp extends PaymentMethod { /** * Идентификатор операции в СБП (НСПК). Пример: 1027088AE4CB48CB81287833347A8777 Обязательный параметр для платежей в статусе succeeded. В остальных случаях может отсутствовать. */ 'sbp_operation_id'?: string; 'payer_bank_details'?: SbpPayerBankDetails; } /** * Статус проверки и сохранения способа оплаты. Возможные значения: pending — ожидает действий от пользователя; active — способ оплаты сохранен, его можно использовать для автоплатежей или выплат; inactive — способ оплаты не сохранен: пользователь не подтвердил привязку платежного средства или при сохранении способа оплаты возникла ошибка. Чтобы узнать подробности, обратитесь в техническую поддержку ЮKassa. */ declare const PaymentMethodStatus: { readonly Pending: "pending"; readonly Active: "active"; readonly Inactive: "inactive"; }; type PaymentMethodStatus = typeof PaymentMethodStatus[keyof typeof PaymentMethodStatus]; /** * Оплата через T-Pay. */ interface PaymentMethodTinkoffBank extends PaymentMethod { 'card'?: InvoicingBankCardData; } /** * Код способа оплаты — тип платежного средства, которое используется для оплаты. Подробнее о способах оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods */ declare const PaymentMethodType: { readonly BankCard: "bank_card"; readonly Cash: "cash"; readonly Alfabank: "alfabank"; readonly Webmoney: "webmoney"; readonly Wechat: "wechat"; readonly ApplePay: "apple_pay"; readonly GooglePay: "google_pay"; readonly Qiwi: "qiwi"; readonly Installments: "installments"; readonly YooMoney: "yoo_money"; readonly Sberbank: "sberbank"; readonly MobileBalance: "mobile_balance"; readonly B2bSberbank: "b2b_sberbank"; readonly TinkoffBank: "tinkoff_bank"; readonly Sbp: "sbp"; readonly SberLoan: "sber_loan"; readonly ElectronicCertificate: "electronic_certificate"; readonly SberBnpl: "sber_bnpl"; }; type PaymentMethodType = typeof PaymentMethodType[keyof typeof PaymentMethodType]; /** * Оплата через WeChat. */ interface PaymentMethodWeChat extends PaymentMethod {} /** * Оплата из кошелька WebMoney. */ interface PaymentMethodWebmoney extends PaymentMethod {} /** * Оплата из кошелька ЮMoney. */ interface PaymentMethodYooMoney extends PaymentMethod { /** * Номер кошелька ЮMoney, из которого заплатил пользователь. */ 'account_number'?: string; } /** * Выбранный сценарий подтверждения привязки. Присутствует, когда привязка ожидает подтверждения от пользователя. */ interface PaymentMethodsConfirmation { 'type': PaymentMethodsConfirmationType; } /** * Данные, необходимые для инициирования сценария подтверждения привязки. */ interface PaymentMethodsConfirmationAttrs { 'type': PaymentMethodsConfirmationType; } /** * Перенаправление пользователя на сайт ЮKassa для подтверждения привязки или страницу банка-эмитента для аутентификации по 3-D Secure. */ interface PaymentMethodsConfirmationAttrsRedirect extends PaymentMethodsConfirmationAttrs { /** * Запрос на проведение привязки с аутентификацией по 3-D Secure. Будет работать, если оплату банковской картой вы по умолчанию принимаете без подтверждения платежа пользователем. В остальных случаях аутентификацией по 3-D Secure будет управлять ЮKassa. Если хотите принимать платежи и создавать привязки без дополнительного подтверждения пользователем, напишите вашему менеджеру ЮKassa. */ 'enforce'?: boolean; /** * URL, на который вернется пользователь после подтверждения или отмены привязки на веб-странице. Не более 2048 символов. */ 'return_url': string; 'locale'?: Locale; } /** * Перенаправление пользователя на сайт ЮKassa для подтверждения привязки или страницу банка-эмитента для аутентификации по 3-D Secure. */ interface PaymentMethodsConfirmationRedirect extends PaymentMethodsConfirmation { /** * URL, на который необходимо перенаправить пользователя для подтверждения привязки. */ 'confirmation_url': string; /** * Запрос на проведение привязки с аутентификацией по 3-D Secure. Будет работать, если оплату банковской картой вы по умолчанию принимаете без подтверждения платежа пользователем. В остальных случаях аутентификацией по 3-D Secure будет управлять ЮKassa. Если хотите принимать платежи и создавать привязки без дополнительного подтверждения пользователем, напишите вашему менеджеру ЮKassa. */ 'enforce'?: boolean; /** * URL, на который вернется пользователь после подтверждения или отмены привязки на веб-странице. Не более 2048 символов. */ 'return_url'?: string; } /** * Код сценария подтверждения пользователем привязки платежного средства к вашему магазину в ЮKassa. */ declare const PaymentMethodsConfirmationType: { readonly Redirect: "redirect"; }; type PaymentMethodsConfirmationType = typeof PaymentMethodsConfirmationType[keyof typeof PaymentMethodsConfirmationType]; /** * Банк получателя платежа. */ interface PaymentOrderBankUtilities { /** * Название банка получателя. */ 'name': string; /** * БИК банка получателя. */ 'bic': string; /** * Счет получателя в банке. */ 'account': string; /** * Корреспондентский счет банка получателя. */ 'correspondent_account': string; } /** * Платежное поручение — распоряжение на перевод банку для оплаты жилищно-коммунальных услуг (ЖКУ), сведения о платеже для регистрации в ГИС ЖКХ. Необходимо передавать при оплате ЖКУ: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/utility-payments. */ interface PaymentOrderData { 'type': PaymentOrderDataTypeEnum; } declare const PaymentOrderDataTypeEnum: { readonly Utilities: "utilities"; }; type PaymentOrderDataTypeEnum = typeof PaymentOrderDataTypeEnum[keyof typeof PaymentOrderDataTypeEnum]; /** * Платежное поручение — распоряжение на перевод банку для оплаты жилищно-коммунальных услуг (ЖКУ), сведения о платеже для регистрации в ГИС ЖКХ. Необходимо передавать при оплате ЖКУ: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/utility-payments. Кроме параметров, отмеченных как обязательные, должен быть передан как минимум один параметр из этого списка: payment_document_id, payment_document_number, account_number, unified_account_number или service_id. */ interface PaymentOrderDataUtilities extends PaymentOrderData { /** * Сумма платежного поручения — сумма, которую пользователь переводит получателю платежа. Равна общей сумме платежа. */ 'amount': MonetaryAmount; /** * Назначение платежа (не больше 210 символов). Рекомендуется формировать с учетом рекомендаций из Письма Банка России № ИН-04-45|12 от 22.02.2018: https://my.dom.gosuslugi.ru/filestore/publicDownloadServlet?context=contentmanagement&uid=ef9a477a-2beb-4212-be30-aed231160db1&mode=view. Пример: Оплата ЖКХ;ЕЛС 80KX478547;ПРД 12.2024;Иванов Иван;г.Москва, ул.Флотская, д.1, кв.1 */ 'payment_purpose': string; /** * Получатель платежа — государственная или коммерческая организация, которая предоставляет услуги или является информационным посредником, который собирает и обрабатывает начисления от других поставщиков услуг. */ 'recipient': PaymentOrderRecipientUtilities; /** * Код бюджетной классификации (КБК). */ 'kbk'?: string; /** * Код ОКТМО (Общероссийский классификатор территорий муниципальных образований). */ 'oktmo'?: string; 'payment_period'?: PaymentPeriod; /** * Идентификатор платежного документа. Обязательный параметр, если не передан payment_document_number, account_number, unified_account_number или service_id. */ 'payment_document_id'?: string; /** * Номер платежного документа на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, account_number, unified_account_number или service_id. */ 'payment_document_number'?: string; /** * Номер лицевого счета на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, payment_document_number, unified_account_number или service_id. */ 'account_number'?: string; /** * Единый лицевой счет. Уникальный идентификатор в ГИС ЖКХ, который характеризует связку «собственник-помещение». Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или service_id. */ 'unified_account_number'?: string; /** * Идентификатор жилищно-коммунальной услуги (ЖКУ). Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или unified_account_number. */ 'service_id'?: string; } /** * Получатель платежа */ interface PaymentOrderRecipientUtilities { /** * Название получателя. */ 'name': string; /** * ИНН получателя. */ 'inn': string; /** * КПП получателя. */ 'kpp': string; /** * Банк получателя. */ 'bank': PaymentOrderBankUtilities; } /** * Квитанция по платежу. */ interface PaymentOverviewStatementData extends Statement { 'delivery_method': PaymentOverviewStatementEmailDeliveryMethod; } /** * Данные о выбранном способе доставки справки. */ interface PaymentOverviewStatementDeliveryMethod { 'type': PaymentOverviewStatementDeliveryMethodType; } declare const PaymentOverviewStatementDeliveryMethodType: { readonly Email: "email"; }; type PaymentOverviewStatementDeliveryMethodType = typeof PaymentOverviewStatementDeliveryMethodType[keyof typeof PaymentOverviewStatementDeliveryMethodType]; /** * Cпособ доставки справки. */ interface PaymentOverviewStatementEmailDeliveryMethod extends PaymentOverviewStatementDeliveryMethod { /** * Электронная почта пользователя для отправки справки. Адрес электронной почты должен соответствовать стандарту RFC 5322: https://www.ietf.org/rfc/rfc5322.txt. Пример: user@example.com. */ 'email': string; } /** * @type PaymentPaymentMethod */ type PaymentPaymentMethod = PaymentMethodAlfabank | PaymentMethodApplePay | PaymentMethodB2bSberbank | PaymentMethodBankCard | PaymentMethodCash | PaymentMethodElectronicCertificate | PaymentMethodGooglePay | PaymentMethodInstallments | PaymentMethodMobileBalance | PaymentMethodQiwi | PaymentMethodSberBnpl | PaymentMethodSberLoan | PaymentMethodSberbank | PaymentMethodSbp | PaymentMethodTinkoffBank | PaymentMethodWeChat | PaymentMethodWebmoney | PaymentMethodYooMoney; /** * Период оплаты, за который выставлены начисления и за который вносится оплата. */ interface PaymentPeriod { /** * Месяц периода. Например, 1 — январь. */ 'month': number; /** * Год периода. Например, 2025. */ 'year': number; } /** * Получатель платежа. */ interface PaymentRecipient { /** * Идентификатор магазина в ЮKassa. */ 'account_id': string; /** * Идентификатор субаккаунта. Используется для разделения потоков платежей в рамках одного аккаунта. */ 'gateway_id': string; } /** * Статус платежа. Возможные значения: pending, waiting_for_capture, succeeded и canceled. Подробнее про жизненный цикл платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle */ declare const PaymentStatus: { readonly Pending: "pending"; readonly WaitingForCapture: "waiting_for_capture"; readonly Succeeded: "succeeded"; readonly Canceled: "canceled"; }; type PaymentStatus = typeof PaymentStatus[keyof typeof PaymentStatus]; /** * Объект выплаты (Payout) — актуальная информация о выплате. */ interface Payout { /** * Идентификатор выплаты. */ 'id': string; /** * Сумма выплаты. */ 'amount': MonetaryAmount; 'status': PayoutStatus; 'payout_destination': PayoutPayoutDestination; /** * Описание транзакции (не более 128 символов). Например: «Выплата по договору 37». */ 'description'?: string; /** * Время создания выплаты. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'created_at': string; /** * Время успешного проведения выплаты. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:42.312Z Обязательный параметр для выплат в статусе succeeded. */ 'succeeded_at'?: string; 'deal'?: PayoutDeal; 'self_employed'?: PayoutSelfEmployed; 'receipt'?: IncomeReceipt; 'cancellation_details'?: PayoutCancellationDetails; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; /** * Признак тестовой операции. */ 'test': boolean; } /** * Комментарий к статусу canceled: кто отменил выплату и по какой причине. */ interface PayoutCancellationDetails { /** * Участник процесса выплаты, который принял решение об отмене транзакции. Перечень инициаторов отмены выплаты: для обычных выплат: https://yookassa.ru/developers/payouts/after-the-payout/declined-payouts#cancellation-details-party, для выплат в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/integration/payouts#declined-payouts-cancellation-details-party. */ 'party': PayoutCancellationDetailsPartyEnum; /** * Причина отмены выплаты. Перечень и описание возможных значений: для обычных выплат: https://yookassa.ru/developers/payouts/after-the-payout/declined-payouts#cancellation-details-reason, для выплат в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/integration/payouts#declined-payouts-cancellation-details-reason. */ 'reason': PayoutCancellationDetailsReasonEnum; } declare const PayoutCancellationDetailsPartyEnum: { readonly YooMoney: "yoo_money"; readonly PayoutNetwork: "payout_network"; }; type PayoutCancellationDetailsPartyEnum = typeof PayoutCancellationDetailsPartyEnum[keyof typeof PayoutCancellationDetailsPartyEnum]; declare const PayoutCancellationDetailsReasonEnum: { readonly InsufficientFunds: "insufficient_funds"; readonly FraudSuspected: "fraud_suspected"; readonly OneTimeLimitExceeded: "one_time_limit_exceeded"; readonly PeriodicLimitExceeded: "periodic_limit_exceeded"; readonly RejectedByPayee: "rejected_by_payee"; readonly GeneralDecline: "general_decline"; readonly IssuerUnavailable: "issuer_unavailable"; readonly RecipientNotFound: "recipient_not_found"; readonly RecipientCheckFailed: "recipient_check_failed"; readonly IdentificationRequired: "identification_required"; readonly SelfEmployedAnnualLimitExceeded: "self_employed_annual_limit_exceeded"; }; type PayoutCancellationDetailsReasonEnum = typeof PayoutCancellationDetailsReasonEnum[keyof typeof PayoutCancellationDetailsReasonEnum]; /** * Данные банковской карты. */ interface PayoutCardData { /** * Первые 6 цифр номера карты (BIN). */ 'first6': string; /** * Последние 4 цифры номера карты. */ 'last4': string; 'card_type': BankCardType; /** * Код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2: https://www.iso.org/obp/ui/#iso:pub:PUB500001:en. Пример: RU. */ 'issuer_country'?: string; /** * Наименование банка, выпустившего карту. */ 'issuer_name'?: string; } /** * Сделка, в рамках которой нужно провести выплату. Присутствует, если вы проводите Безопасную сделку: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. */ interface PayoutDeal { /** * Идентификатор сделки. */ 'id': string; } /** * Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics */ interface PayoutDealInfo { /** * Идентификатор сделки. */ 'id': string; } /** * Платежное средство, на которое ЮKassa зачисляет выплату. */ interface PayoutDestination { 'type': PayoutDestinationType; } /** * Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token или payment_method_id. Выплаты через СБП доступны только при обычных выплатах и только при выплатах физическим лицам. */ interface PayoutDestinationData { 'type': PayoutDestinationDataType; } /** * Способ получения выплаты: yoo_money — выплаты на кошелек ЮMoney; bank_card — выплаты на банковскую карту; sbp — выплаты через СБП на счет в банке или платежном сервисе. */ declare const PayoutDestinationDataType: { readonly YooMoney: "yoo_money"; readonly BankCard: "bank_card"; readonly Sbp: "sbp"; }; type PayoutDestinationDataType = typeof PayoutDestinationDataType[keyof typeof PayoutDestinationDataType]; /** * Способ получения выплаты: bank_card – выплата на банковскую карту; yoo_money – выплата на кошелек ЮMoney; sbp – выплата через СБП на счет в банке или платежном сервисе. */ declare const PayoutDestinationType: { readonly BankCard: "bank_card"; readonly YooMoney: "yoo_money"; readonly Sbp: "sbp"; }; type PayoutDestinationType = typeof PayoutDestinationType[keyof typeof PayoutDestinationType]; /** * Способ получения выплаты. */ declare const PayoutMethodType: { readonly BankCard: "bank_card"; readonly YooMoney: "yoo_money"; readonly Sbp: "sbp"; }; type PayoutMethodType = typeof PayoutMethodType[keyof typeof PayoutMethodType]; /** * @type PayoutPayoutDestination */ type PayoutPayoutDestination = PayoutToCardDestination | PayoutToSbpDestination | PayoutToYooMoneyDestination; /** * Данные для создания выплаты. */ interface PayoutRequest { /** * Сумма выплаты. Есть ограничения на минимальный и максимальный размер выплаты и сумму выплат за месяц. Подробнее о лимитах обычных выплат: https://yookassa.ru/developers/payouts/getting-started/payout-types-and-limits и выплат в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/integration/payouts#specifics */ 'amount': MonetaryAmount; 'payout_destination_data'?: PayoutRequestPayoutDestinationData; /** * Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data или payment_method_id. */ 'payout_token'?: string; /** * Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты. Подробнее о выплатах с использованием идентификатора сохраненного способа оплаты: https://yookassa.ru/developers/payouts/scenario-extensions/multipurpose-token Обязательный параметр, если не передан payout_destination_data или payout_token. */ 'payment_method_id'?: string; /** * Описание транзакции (не более 128 символов). Например: «Выплата по договору 37». */ 'description'?: string; 'deal'?: PayoutDealInfo; /** * Персональные данные получателя выплаты. Только для обычных выплат. Необходимо передавать в этих сценариях: выплаты с проверкой получателя: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-check (только для выплат через СБП); выплаты с передачей данных получателя для выписок из реестра: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-data-send. В массиве можно одновременно передать несколько идентификаторов, но только для разных типов данных. */ 'personal_data'?: Array; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * @type PayoutRequestPayoutDestinationData */ type PayoutRequestPayoutDestinationData = PayoutToBankCardDestinationData | PayoutToSbpDestinationData | PayoutToYooMoneyDestinationData; /** * Данные самозанятого, который получит выплату. Устаревший параметр. Раньше возвращался при проведении выплат самозанятым. Сейчас функциональность недоступна. Параметр сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. */ interface PayoutSelfEmployed { /** * Идентификатор самозанятого в ЮKassa. */ 'id': string; } /** * Данные самозанятого, который получит выплату. Только для обычных выплат. Устаревший параметр. Раньше использовался для выплат самозанятым. Сейчас функциональность недоступна. Параметр сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. */ interface PayoutSelfEmployedInfo { /** * Идентификатор самозанятого в ЮKassa. */ 'id': string; } interface PayoutStatementRecipientPersonalDataRequest extends PersonalDataRequest { /** * Фамилия пользователя. */ 'last_name': string; /** * Имя пользователя. */ 'first_name': string; /** * Отчество пользователя. Обязательный параметр, если есть в паспорте. */ 'middle_name'?: string; /** * Дата рождения. Передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601 */ 'birthdate': string; } /** * Статус выплаты. Возможные значения: pending — выплата создана, но деньги еще не поступили на указанное платежное средство пользователя (например, ЮKassa ждет подтверждения от эквайера, что перевод успешен); succeeded — выплата успешно завершена, деньги переведены на платежное средство пользователя (финальный и неизменяемый статус); canceled — выплата отменена, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус). */ declare const PayoutStatus: { readonly Pending: "pending"; readonly Succeeded: "succeeded"; readonly Canceled: "canceled"; }; type PayoutStatus = typeof PayoutStatus[keyof typeof PayoutStatus]; /** * Данные для выплаты на банковскую карту. */ interface PayoutToBankCardDestinationData extends PayoutDestinationData { 'card': CardDataForPayoutDestination; } /** * Выплаты на банковскую карту */ interface PayoutToCardDestination extends PayoutDestination { 'card'?: PayoutCardData; } /** * Данные для выплаты через СБП на счет в банке или платежном сервисе. */ interface PayoutToSbpDestination extends PayoutDestination { /** * Телефон, к которому привязан счет получателя выплаты в системе участника СБП. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. */ 'phone': string; /** * Идентификатор участника СБП — банка или платежного сервиса, подключенного к сервису. */ 'bank_id': string; /** * Проверка получателя выплаты: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-check: true — выплата проходила с проверкой получателя, false — выплата проходила без проверки получателя. */ 'recipient_checked': boolean; } /** * Данные для выплаты на счет в банке через систему быстрых платежей. */ interface PayoutToSbpDestinationData extends PayoutDestinationData { /** * Телефон, к которому привязан счет получателя выплаты в системе участника СБП. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. */ 'phone': string; /** * Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису. Формат: 12 символов. Как получить идентификатор участника СБП: https://yookassa.ru/developers/payouts/making-payouts/sbp */ 'bank_id': string; } /** * Выплаты на кошелек ЮMoney. */ interface PayoutToYooMoneyDestination extends PayoutDestination { /** * Номер кошелька ЮMoney, например 41001614575714. Длина — от 11 до 33 цифр. */ 'account_number': string; } /** * Данные для выплаты на кошелек ЮMoney. */ interface PayoutToYooMoneyDestinationData extends PayoutDestinationData { 'account_number': PayoutToYooMoneyDestinationDataAllOfAccountNumber; } /** * Номер кошелька ЮMoney, например 41001614575714. Длина от 11 до 33 цифр. Статус кошелька: https://yoomoney.ru/page?id=536140: для обычных выплат: https://yookassa.ru/developers/payouts/overview — любой, для выплат в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics — именной или идентифицированный. */ interface PayoutToYooMoneyDestinationDataAllOfAccountNumber {} /** * Список выплат. Выплаты отсортированы по времени создания в порядке убывания (от новых к старым). Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент. */ interface PayoutsList { /** * Формат выдачи результатов запроса. Возможное значение: list (список). */ 'type': PayoutsListTypeEnum; 'items': Array; /** * Указатель на следующий фрагмент списка. Обязательный параметр, если размер списка больше размера выдачи (limit) и конец выдачи не достигнут. */ 'next_cursor'?: string; } declare const PayoutsListTypeEnum: { readonly List: "list"; }; type PayoutsListTypeEnum = typeof PayoutsListTypeEnum[keyof typeof PayoutsListTypeEnum]; /** * Персональные данные получателя выплаты. Только для обычных выплат. Необходимо передавать в этих сценариях: * выплаты с проверкой получателя: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-check; * выплаты с передачей данных получателя для выписок из реестра: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-data-send. */ interface PayoutsPersonalData { /** * Идентификатор персональных данных, сохраненных в ЮKassa. */ 'id': string; } /** * Объект персональных данных (PersonalData) — актуальная информация о персональных данных пользователя, сохраненных в ЮKassa. */ interface PersonalData { /** * Идентификатор персональных данных, сохраненных в ЮKassa. */ 'id': string; 'type': PersonalDataType; /** * Статус персональных данных. Возможные значения: waiting_for_operation — данные сохранены, но не использованы при проведении выплаты; active — данные сохранены и использованы при проведении выплаты; данные можно использовать повторно до срока, указанного в параметре expires_at; canceled — хранение данных отменено, данные удалены, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус). Жизненный цикл персональных данных зависит от назначения данных: передача данных получателя выплаты: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-data-send#lifecircle для выписки из реестра или проверка получателя: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-check#lifecircle при выплатах через СБП. */ 'status': PersonalDataStatusEnum; 'cancellation_details'?: PersonalDataCancellationDetails; /** * Время создания персональных данных. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'created_at': string; /** * Срок жизни объекта персональных данных — время, до которого вы можете использовать персональные данные при проведении операций. Указывается только для объекта в статусе active. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'expires_at'?: string; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } declare const PersonalDataStatusEnum: { readonly WaitingForOperation: "waiting_for_operation"; readonly Active: "active"; readonly Canceled: "canceled"; }; type PersonalDataStatusEnum = typeof PersonalDataStatusEnum[keyof typeof PersonalDataStatusEnum]; /** * Комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных. */ interface PersonalDataCancellationDetails { /** * Участник процесса, который принял решение о прекращении хранения персональных данных. Возможное значение: yoo_money — ЮKassa. */ 'party': PersonalDataCancellationDetailsPartyEnum; /** * Причина прекращения хранения персональных данных. Возможное значение: expired_by_timeout — истек срок хранения или использования персональных данных. */ 'reason': PersonalDataCancellationDetailsReasonEnum; } declare const PersonalDataCancellationDetailsPartyEnum: { readonly YooMoney: "yoo_money"; }; type PersonalDataCancellationDetailsPartyEnum = typeof PersonalDataCancellationDetailsPartyEnum[keyof typeof PersonalDataCancellationDetailsPartyEnum]; declare const PersonalDataCancellationDetailsReasonEnum: { readonly ExpiredByTimeout: "expired_by_timeout"; }; type PersonalDataCancellationDetailsReasonEnum = typeof PersonalDataCancellationDetailsReasonEnum[keyof typeof PersonalDataCancellationDetailsReasonEnum]; /** * @type PersonalDataPostRequest */ type PersonalDataPostRequest = { type: 'payout_statement_recipient'; } & PayoutStatementRecipientPersonalDataRequest | { type: 'sbp_payout_recipient'; } & SbpPayoutRecipientPersonalDataRequest; /** * Данные для запроса сохранения персональных данных. */ interface PersonalDataRequest { 'type': PersonalDataType; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * Тип персональных данных — цель, для которой вы будете использовать данные. Возможные значение: sbp_payout_recipient — выплаты с проверкой получателя: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-check(только для выплат через СБП); payout_statement_recipient — выплаты с передачей данных получателя выплаты для выписок из реестра: https://yookassa.ru/developers/payouts/scenario-extensions/recipient-data-send. */ declare const PersonalDataType: { readonly PayoutStatementRecipient: "payout_statement_recipient"; readonly SbpPayoutRecipient: "sbp_payout_recipient"; }; type PersonalDataType = typeof PersonalDataType[keyof typeof PersonalDataType]; /** * Данные для формирования чека в онлайн-кассе (для коллекции чеков). */ interface PostReceiptData { /** * Тип чека в онлайн-кассе. Возможные значения: payment (приход), refund (возврат прихода). */ 'type': ReceiptType; /** * Идентификатор платежа в ЮKassa для отображения информации о чеке в личном кабинете: https://yookassa.ru/my/payments, на платеж не влияет. Обязательный параметр при создании чека прихода: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/payments#create-receipt (тип чека — payment, статус платежа — waiting_for_capture или succeeded) и при создании чека возврата прихода: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/payments#payment-receipt-part-capture для отмененного или частично подтвержденного платежа (тип чека — refund, статус платежа — canceled или succeeded). Для одного платежа можно создать не более 30 чеков. */ 'payment_id'?: string; /** * Идентификатор возврата в ЮKassa для отображения информации о чеке в личном кабинете: https://yookassa.ru/my. Обязательный параметр при создании чека возврата прихода: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/refunds#after-refund (если тип чека — refund, статус возврата — succeeded). Для одного возврата можно создать не более 30 чеков. */ 'refund_id'?: string; 'customer': ReceiptDataCustomer; /** * Список товаров в чеке: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics — не более 80 товаров, для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics — не более 100 товаров. */ 'items': Array; /** * Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет. Возможные значения: true — оплата прошла онлайн, через интернет (например, на вашем сайте или в приложении); false — оплата прошла офлайн, при личном взаимодействии (например, в торговой точке или при встрече с курьером). По умолчанию true. Если вы принимаете платежи офлайн, передайте в запросе значение false. */ 'internet'?: boolean; /** * Формирование чека в онлайн-кассе сразу после создания объекта чека. Сейчас можно передать только значение true. */ 'send': boolean; /** * Система налогообложения магазина (тег в 54 ФЗ — 1055). Для сторонних онлайн-касс: обязательный параметр, если вы используете онлайн-кассу Атол Онлайн, обновленную до ФФД 1.2, или у вас несколько систем налогообложения, в остальных случаях не передается. Перечень возможных значений: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#tax-systems Для Чеков от ЮKassa: параметр передавать не нужно, ЮKassa его проигнорирует. */ 'tax_system_code'?: number; /** * Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011). Указывается, только если в чеке есть товары, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#timezone; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#timezone. */ 'timezone'?: number; 'additional_user_props'?: ReceiptAdditionalUserProps; /** * Отраслевой реквизит чека (тег в 54 ФЗ — 1261). Нужно передавать, если используете ФФД 1.2. */ 'receipt_industry_details'?: Array; /** * Операционный реквизит чека (тег в 54 ФЗ — 1270). Нужно передавать, если используете ФФД 1.2. */ 'receipt_operational_details'?: OperationalDetails; /** * Перечень совершенных расчетов. */ 'settlements': Array; /** * Идентификатор магазина, от имени которого нужно отправить чек. Выдается ЮKassa, отображается в разделе Продавцы: https://yookassa.ru/my/marketplace/sellers личного кабинета (столбец shopId). Необходимо передавать, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. */ 'on_behalf_of'?: string; } /** * Информация о товарной позиции в заказе (для формирования чека). */ interface PostReceiptDataItem { /** * Название товара (от 1 до 128 символов). Тег в 54 ФЗ — 1030. */ 'description': string; /** * Цена товара (тег в 54 ФЗ — 1079). */ 'amount': MonetaryAmount; /** * Ставка НДС (тег в 54 ФЗ — 1199). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#vat-codes; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#vat-codes. */ 'vat_code': number; /** * Количество товара (тег в 54 ФЗ — 1023). Можно передать целое или дробное число. Разделитель дробной части — точка, разделитель тысяч отсутствует. Пример: 5.000 Максимально возможное значение и максимальное количество знаков после точки (для дробных значений) зависят от модели вашей онлайн-кассы. Для чеков от ЮKassa максимально возможное значение — 99999.999, не более 3 знаков после точки. */ 'quantity': number; 'measure'?: ReceiptItemMeasure; 'mark_quantity'?: MarkQuantity; 'payment_subject'?: ReceiptItemPaymentSubject; 'payment_mode'?: ReceiptItemPaymentMode; /** * Код страны происхождения товара по общероссийскому классификатору стран мира (OК (MК (ИСО 3166) 004-97) 025-2001: http://docs.cntd.ru/document/842501280). Тег в 54 ФЗ — 1230. Пример: RU. Можно передавать, если используете онлайн-кассу Orange Data, Кит Инвест. */ 'country_of_origin_code'?: string; /** * Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231. Можно передавать, если используете онлайн-кассу Orange Data, Кит Инвест. */ 'customs_declaration_number'?: string; /** * Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229). Десятичное число с точностью до 2 знаков после точки. Можно передавать, если используете онлайн-кассу Orange Data, Кит Инвест. */ 'excise'?: string; /** * Код товара (тег в 54 ФЗ — 1162) — уникальный номер, который присваивается экземпляру товара при маркировке. Формат: число в шестнадцатеричном представлении с пробелами. Максимальная длина — 32 байта. Пример: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00. Обязательный параметр, если одновременно выполняются эти условия: вы используете онлайн-кассу, обновленную до ФФД 1.05; товар нужно маркировать: http://docs.cntd.ru/document/902192509. */ 'product_code'?: string; /** * Планируемый статус товара. Тег в 54 ФЗ — 2003. Указывается только для товаров, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#planned-status; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#planned-status. */ 'planned_status'?: number; 'mark_code_info'?: MarkCodeInfo; /** * Режим обработки кода маркировки (тег в 54 ФЗ — 2102). Обязательный параметр, если одновременно выполняются эти условия: вы используете Чеки от ЮKassa или онлайн-кассу Атол Онлайн или BusinessRu, обновленную до ФФД 1.2; товар нужно маркировать: http://docs.cntd.ru/document/902192509. Должен принимать значение равное «0». */ 'mark_mode'?: string; /** * Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260). Можно передавать, если используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2. */ 'payment_subject_industry_details'?: Array; /** * Дополнительный реквизит предмета расчета (тег в 54 ФЗ — 1191). Не более 64 символов. Можно передавать, если вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment */ 'additional_payment_subject_props'?: string; 'supplier'?: PostReceiptItemSupplierWithInn; 'agent_type'?: ReceiptItemAgentType; } interface PostReceiptItemSupplierWithInn { /** * Наименование поставщика (тег в 54 ФЗ — 1225). Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. */ 'name'?: string; /** * Телефон поставщика (тег в 54 ФЗ — 1171). Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. */ 'phone'?: string; /** * ИНН поставщика (10 или 12 цифр). Тег в 54 ФЗ — 1226. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.05. */ 'inn'?: string; } /** * Объект чека (Receipt) — актуальная информация о чеке. */ interface Receipt { /** * Идентификатор чека в ЮKassa. */ 'id': string; 'type': ReceiptType; /** * Идентификатор платежа: https://yookassa.ru/developers/api#payment_object, для которого был сформирован чек. */ 'payment_id'?: string; /** * Идентификатор возврата: https://yookassa.ru/developers/api#refund_object, для которого был сформирован чек. Отсутствует в чеке платежа. */ 'refund_id'?: string; /** * Статус доставки данных для чека в онлайн-кассу. Возможные значения: pending — данные в обработке; succeeded — чек успешно зарегистрирован; canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную. */ 'status': ReceiptRegistrationStatus; /** * Номер фискального документа. */ 'fiscal_document_number'?: string; /** * Номер фискального накопителя в кассовом аппарате. */ 'fiscal_storage_number'?: string; /** * Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. */ 'fiscal_attribute'?: string; /** * Дата и время формирования чека в фискальном накопителе. Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. */ 'registered_at'?: string; /** * Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. */ 'fiscal_provider_id'?: string; /** * Список товаров в чеке: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics — не более 80 товаров, для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics — не более 100 товаров. */ 'items': Array; /** * Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет. Возможные значения: true — оплата прошла онлайн, через интернет (например, на вашем сайте или в приложении); false — оплата прошла офлайн, при личном взаимодействии (например, в торговой точке или при встрече с курьером). По умолчанию true. Если вы принимаете платежи офлайн, передайте в запросе значение false. */ 'internet'?: boolean; /** * Перечень совершенных расчетов. */ 'settlements'?: Array; /** * Идентификатор магазина, от имени которого нужно отправить чек. Выдается ЮKassa. Присутствует, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. */ 'on_behalf_of'?: string; /** * Система налогообложения магазина (тег в 54 ФЗ — 1055). Для сторонних онлайн-касс: обязательный параметр, если вы используете онлайн-кассу Атол Онлайн, обновленную до ФФД 1.2, или у вас несколько систем налогообложения, в остальных случаях не передается. Перечень возможных значений: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#tax-systems Для Чеков от ЮKassa: параметр передавать не нужно, ЮKassa его проигнорирует. */ 'tax_system_code'?: number; /** * Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011). Указывается, только если в чеке есть товары, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#timezone; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#timezone. */ 'timezone'?: number; /** * Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260). */ 'receipt_industry_details'?: Array; /** * Операционный реквизит чека (тег в 54 ФЗ — 1270). */ 'receipt_operational_details'?: OperationalDetails; } /** * Дополнительный реквизит пользователя (тег в 54 ФЗ — 1084). Можно передавать, если вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment */ interface ReceiptAdditionalUserProps { /** * Наименование дополнительного реквизита пользователя (тег в 54 ФЗ — 1085). Не более 64 символов. */ 'name': string; /** * Значение дополнительного реквизита пользователя (тег в 54 ФЗ — 1086). Не более 234 символов. */ 'value': string; } /** * Данные для формирования чека. Необходимо передавать в этих случаях: вы компания или ИП и для оплаты с соблюдением требований 54-ФЗ используете Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics; вы компания или ИП, для оплаты с соблюдением требований 54-ФЗ используете стороннюю онлайн-кассу: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics и отправляете данные для чеков по одному из сценариев: Платеж и чек одновременно: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#payment-and-receipt или Сначала чек, потом платеж: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#payment-after-receipt. */ interface ReceiptData { 'customer'?: ReceiptDataCustomer; /** * Список товаров в заказе. Если используете Чеки от ЮKassa, можно передать максимум 80 товаров, если используете стороннюю онлайн-кассу, максимум 100 товаров. */ 'items': Array; /** * Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет. Возможные значения: true — оплата прошла онлайн, через интернет (например, на вашем сайте или в приложении); false — оплата прошла офлайн, при личном взаимодействии (например, в торговой точке или при встрече с курьером). По умолчанию true. Если вы принимаете платежи офлайн, передайте в запросе значение false. */ 'internet'?: boolean; /** * Система налогообложения магазина (тег в 54 ФЗ — 1055). Для сторонних онлайн-касс: обязательный параметр, если вы используете онлайн-кассу Атол Онлайн, обновленную до ФФД 1.2, или у вас несколько систем налогообложения, в остальных случаях не передается. Перечень возможных значений: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#tax-systems Для Чеков от ЮKassa: параметр передавать не нужно, ЮKassa его проигнорирует. */ 'tax_system_code'?: number; /** * Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011). Указывается, только если в чеке есть товары, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#timezone; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#timezone. */ 'timezone'?: number; /** * Отраслевой реквизит чека (тег в 54 ФЗ — 1261). Можно передавать, если используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2. */ 'receipt_industry_details'?: Array; /** * Операционный реквизит чека (тег в 54 ФЗ — 1270). Можно передавать, если используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2. */ 'receipt_operational_details'?: OperationalDetails; } /** * Информация о пользователе. Необходимо указать как минимум контактные данные: для Чеков от ЮKassa — электронную почту (customer.email), в остальных случаях — электронную почту (customer.email) или номер телефона (customer.phone). */ interface ReceiptDataCustomer { /** * Для юрлица — название организации, для ИП и физического лица — ФИО. Если у физлица отсутствует ИНН, в этом же параметре передаются паспортные данные. Не более 256 символов. Можно передавать, если используете Чеки от ЮKassa или онлайн-кассу Orange Data, Атол Онлайн. */ 'full_name'?: string; /** * ИНН пользователя (10 или 12 цифр). Если у физического лица отсутствует ИНН, необходимо передать паспортные данные в параметре full_name. Можно передавать, если используете Чеки от ЮKassa или онлайн-кассу Orange Data, Атол Онлайн. */ 'inn'?: string; /** * Электронная почта пользователя для отправки чека. Обязательный параметр, если используете Чеки от ЮKassa или если используете стороннюю онлайн-кассу и не передаете phone. */ 'email'?: string; /** * Телефон пользователя для отправки чека. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. Обязательный параметр, если не передан email. */ 'phone'?: string; } /** * Информация о товарной позиции в заказе. Используется для формирования чека. */ interface ReceiptDataItem { /** * Название товара (от 1 до 128 символов). Тег в 54 ФЗ — 1030. */ 'description': string; /** * Цена товара (тег в 54 ФЗ — 1079). */ 'amount': MonetaryAmount; /** * Ставка НДС (тег в 54 ФЗ — 1199). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#vat-codes; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#vat-codes. */ 'vat_code': number; /** * Количество товара (тег в 54 ФЗ — 1023). Можно передать целое или дробное число. Разделитель дробной части — точка, разделитель тысяч отсутствует. Максимально возможное значение и максимальное количество знаков после точки (для дробных значений) зависят от модели вашей онлайн-кассы. Для чеков от ЮKassa максимально возможное значение — 99999.999, не более 3 знаков после точки. */ 'quantity': number; 'measure'?: ReceiptItemMeasure; 'mark_quantity'?: MarkQuantity; 'payment_subject'?: ReceiptItemPaymentSubject; 'payment_mode'?: ReceiptItemPaymentMode; /** * Код страны происхождения товара по общероссийскому классификатору стран мира (OК (MК (ИСО 3166) 004-97) 025-2001: http://docs.cntd.ru/document/842501280). Тег в 54 ФЗ — 1230. Пример: RU. Можно передавать, если используете онлайн-кассу Orange Data, Кит Инвест. */ 'country_of_origin_code'?: string; /** * Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231. Можно передавать, если используете онлайн-кассу Orange Data, Кит Инвест. */ 'customs_declaration_number'?: string; /** * Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229). Десятичное число с точностью до 2 знаков после точки. Можно передавать, если используете онлайн-кассу Orange Data, Кит Инвест. */ 'excise'?: string; /** * Код товара (тег в 54 ФЗ — 1162) — уникальный номер, который присваивается экземпляру товара при маркировке. Формат: число в шестнадцатеричном представлении с пробелами. Максимальная длина — 32 байта. Пример: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00. Обязательный параметр, если одновременно выполняются эти условия: вы используете онлайн-кассу, обновленную до ФФД 1.05; товар нужно маркировать: http://docs.cntd.ru/document/902192509. */ 'product_code'?: string; /** * Планируемый статус товара. Тег в 54 ФЗ — 2003. Указывается только для товаров, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#planned-status; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#planned-status. */ 'planned_status'?: number; 'mark_code_info'?: MarkCodeInfo; /** * Режим обработки кода маркировки (тег в 54 ФЗ — 2102). Обязательный параметр, если одновременно выполняются эти условия: вы используете Чеки от ЮKassa или онлайн-кассу Атол Онлайн или BusinessRu, обновленную до ФФД 1.2; товар нужно маркировать: http://docs.cntd.ru/document/902192509. Должен принимать значение равное «0». */ 'mark_mode'?: string; /** * Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260). Можно передавать, если используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2. */ 'payment_subject_industry_details'?: Array; } /** * Информация о товарной позиции в заказе (для формирования чека). */ interface ReceiptItem { /** * Название товара (не более 128 символов). Тег в 54 ФЗ — 1030). */ 'description': string; /** * Количество товара (тег в 54 ФЗ — 1023). Формат: десятичное число, дробная часть — три знака или больше (количество знаков зависит от quantity в запросе). Разделитель дробной части — точка, разделитель тысяч отсутствует. Пример: 5.000 */ 'quantity': number; /** * Цена товара (тег в 54 ФЗ — 1079). */ 'amount': MonetaryAmount; /** * Ставка НДС (тег в 54 ФЗ — 1199). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#vat-codes; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#vat-codes. */ 'vat_code': number; 'payment_subject'?: ReceiptItemPaymentSubject; 'payment_mode'?: ReceiptItemPaymentMode; /** * Код страны происхождения товара по общероссийскому классификатору стран мира (OК (MК (ИСО 3166) 004-97) 025-2001: http://docs.cntd.ru/document/842501280). Тег в 54 ФЗ — 1230. Пример: RU. Онлайн-кассы, которые поддерживают этот параметр: Orange Data, Кит Инвест. */ 'country_of_origin_code'?: string; /** * Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231. Онлайн-кассы, которые поддерживают этот параметр: Orange Data, Кит Инвест. */ 'customs_declaration_number'?: string; /** * Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229). Десятичное число с точностью до 2 символов после точки. Онлайн-кассы, которые поддерживают этот параметр: Orange Data, Кит Инвест. */ 'excise'?: string; 'supplier'?: ReceiptItemSupplierWithInn; 'agent_type'?: ReceiptItemAgentType; 'mark_code_info'?: MarkCodeInfo; 'measure'?: ReceiptItemMeasure; /** * Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260). Обязателен при использовании ФФД 1.2. */ 'payment_subject_industry_details'?: Array; /** * Код товара — уникальный номер, который присваивается экземпляру товара при маркировке: http://docs.cntd.ru/document/902192509 (тег в 54 ФЗ — 1162). Формат: число в шестнадцатеричном представлении с пробелами. Максимальная длина — 32 байта. Пример: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00. Обязательный параметр, если товар нужно маркировать: http://docs.cntd.ru/document/557297080. */ 'product_code'?: string; /** * Планируемый статус товара. Тег в 54 ФЗ — 2003. Указывается только для товаров, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#planned-status; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#planned-status. */ 'planned_status'?: number; /** * Режим обработки кода маркировки (тег в 54 ФЗ — 2102). Обязательный параметр, если одновременно выполняются эти условия: вы используете Чеки от ЮKassa или онлайн-кассу Атол Онлайн или BusinessRu, обновленную до ФФД 1.2; товар нужно маркировать: http://docs.cntd.ru/document/902192509. Должен принимать значение равное «0». */ 'mark_mode'?: string; 'mark_quantity'?: MarkQuantity; } /** * Тип посредника, реализующего товар или услугу. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. Перечень возможных значений: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#agent-type. Можно передавать, если ваша онлайн-касса обновлена до ФФД 1.1 и вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment */ declare const ReceiptItemAgentType: { readonly BankingPaymentAgent: "banking_payment_agent"; readonly BankingPaymentSubagent: "banking_payment_subagent"; readonly PaymentAgent: "payment_agent"; readonly PaymentSubagent: "payment_subagent"; readonly Attorney: "attorney"; readonly Commissioner: "commissioner"; readonly Agent: "agent"; }; type ReceiptItemAgentType = typeof ReceiptItemAgentType[keyof typeof ReceiptItemAgentType]; /** * Мера количества предмета расчета (тег в 54 ФЗ — 2108) — единица измерения товара, например штуки, граммы. Обязательный параметр, если используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2. Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#measure; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#measure. */ declare const ReceiptItemMeasure: { readonly Piece: "piece"; readonly Gram: "gram"; readonly Kilogram: "kilogram"; readonly Ton: "ton"; readonly Centimeter: "centimeter"; readonly Decimeter: "decimeter"; readonly Meter: "meter"; readonly SquareCentimeter: "square_centimeter"; readonly SquareDecimeter: "square_decimeter"; readonly SquareMeter: "square_meter"; readonly Milliliter: "milliliter"; readonly Liter: "liter"; readonly CubicMeter: "cubic_meter"; readonly KilowattHour: "kilowatt_hour"; readonly Gigacalorie: "gigacalorie"; readonly Day: "day"; readonly Hour: "hour"; readonly Minute: "minute"; readonly Second: "second"; readonly Kilobyte: "kilobyte"; readonly Megabyte: "megabyte"; readonly Gigabyte: "gigabyte"; readonly Terabyte: "terabyte"; readonly Another: "another"; }; type ReceiptItemMeasure = typeof ReceiptItemMeasure[keyof typeof ReceiptItemMeasure]; /** * Признак способа расчета (тег в 54 ФЗ — 1214) — отражает тип оплаты и факт передачи товара. Пример: покупатель полностью оплачивает товар и сразу получает его. В этом случае нужно передать значение full_payment (полный расчет). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#payment-mode; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#payment-mode. */ declare const ReceiptItemPaymentMode: { readonly FullPrepayment: "full_prepayment"; readonly PartialPrepayment: "partial_prepayment"; readonly Advance: "advance"; readonly FullPayment: "full_payment"; readonly PartialPayment: "partial_payment"; readonly Credit: "credit"; readonly CreditPayment: "credit_payment"; }; type ReceiptItemPaymentMode = typeof ReceiptItemPaymentMode[keyof typeof ReceiptItemPaymentMode]; /** * Признак предмета расчета (тег в 54 ФЗ — 1212) — это то, за что принимается оплата, например товар, услуга. Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#payment-subject; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#payment-subject. */ declare const ReceiptItemPaymentSubject: { readonly Commodity: "commodity"; readonly Excise: "excise"; readonly Job: "job"; readonly Service: "service"; readonly GamblingBet: "gambling_bet"; readonly GamblingPrize: "gambling_prize"; readonly Lottery: "lottery"; readonly LotteryPrize: "lottery_prize"; readonly IntellectualActivity: "intellectual_activity"; readonly Payment: "payment"; readonly AgentCommission: "agent_commission"; readonly PropertyRight: "property_right"; readonly NonOperatingGain: "non_operating_gain"; readonly InsurancePremium: "insurance_premium"; readonly SalesTax: "sales_tax"; readonly ResortFee: "resort_fee"; readonly Composite: "composite"; readonly Another: "another"; readonly Fine: "fine"; readonly Tax: "tax"; readonly Lien: "lien"; readonly Cost: "cost"; readonly PensionInsuranceWithoutPayouts: "pension_insurance_without_payouts"; readonly PensionInsuranceWithPayouts: "pension_insurance_with_payouts"; readonly HealthInsuranceWithoutPayouts: "health_insurance_without_payouts"; readonly HealthInsuranceWithPayouts: "health_insurance_with_payouts"; readonly HealthInsurance: "health_insurance"; readonly Casino: "casino"; readonly AgentWithdrawals: "agent_withdrawals"; readonly NonMarkedExcise: "non_marked_excise"; readonly MarkedExcise: "marked_excise"; readonly Marked: "marked"; readonly NonMarked: "non_marked"; }; type ReceiptItemPaymentSubject = typeof ReceiptItemPaymentSubject[keyof typeof ReceiptItemPaymentSubject]; /** * Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224). Можно передавать, если вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment. */ interface ReceiptItemSupplier { /** * Наименование поставщика (тег в 54 ФЗ — 1225). Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. */ 'name'?: string; /** * Телефон поставщика (тег в 54 ФЗ — 1171). Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. */ 'phone'?: string; } interface ReceiptItemSupplierWithInn { /** * Наименование поставщика (тег в 54 ФЗ — 1225). Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. */ 'name'?: string; /** * Телефон поставщика (тег в 54 ФЗ — 1171). Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164, например 79000000000. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. */ 'phone'?: string; /** * ИНН поставщика в маскированном виде (тег в 54 ФЗ — 1226). Пример: ***. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.05. */ 'inn'?: string; } /** * Список чеков, созданных за последние три года. Чеки отсортированы по времени создания в порядке убывания (от новых к старым). Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент. */ interface ReceiptList { /** * Формат выдачи результатов запроса. Возможное значение: list (список). */ 'type': ReceiptListTypeEnum; 'items': Array; /** * Указатель на следующий фрагмент списка. Обязательный параметр, если размер списка больше размера выдачи (limit) и конец выдачи не достигнут. */ 'next_cursor'?: string; } declare const ReceiptListTypeEnum: { readonly List: "list"; }; type ReceiptListTypeEnum = typeof ReceiptListTypeEnum[keyof typeof ReceiptListTypeEnum]; declare const ReceiptRegistrationStatus: { readonly Pending: "pending"; readonly Succeeded: "succeeded"; readonly Canceled: "canceled"; }; type ReceiptRegistrationStatus = typeof ReceiptRegistrationStatus[keyof typeof ReceiptRegistrationStatus]; /** * Тип чека в онлайн-кассе: приход (payment) или возврат прихода (refund). */ declare const ReceiptType: { readonly Payment: "payment"; readonly Refund: "refund"; }; type ReceiptType = typeof ReceiptType[keyof typeof ReceiptType]; /** * Реквизиты получателя оплаты при пополнении электронного кошелька, банковского счета или баланса телефона: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/receiver-data. */ interface Receiver { 'type': ReceiverType; } /** * Реквизиты для пополнения банковского счета. */ interface ReceiverBankAccount extends Receiver { /** * Номер банковского счета. Формат — 20 символов. */ 'account_number': string; /** * Банковский идентификационный код (БИК) банка, в котором открыт счет. Формат — 9 символов. */ 'bic': string; } /** * Реквизиты для пополнения баланса электронного кошелька. */ interface ReceiverDigitalWallet extends Receiver { /** * Идентификатор электронного кошелька для пополнения. Максимум 20 символов. */ 'account_number': string; } /** * Реквизиты для пополнения баланса телефона. */ interface ReceiverMobileBalance extends Receiver { /** * Номер телефона для пополнения. Максимум 15 символов. Указывается в формате ITU-T E.164: https://ru.wikipedia.org/wiki/E.164. Пример: 79000000000. */ 'phone': string; } /** * Код получателя оплаты. */ declare const ReceiverType: { readonly MobileBalance: "mobile_balance"; readonly DigitalWallet: "digital_wallet"; readonly BankAccount: "bank_account"; }; type ReceiverType = typeof ReceiverType[keyof typeof ReceiverType]; /** * Получатель платежа. Нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес другого аккаунта. */ interface Recipient { /** * Идентификатор субаккаунта. Используется для разделения потоков платежей в рамках одного аккаунта. */ 'gateway_id': string; } /** * Объект возврата (Refund) — актуальная информация о возврате платежа. */ interface Refund { /** * Идентификатор возврата платежа в ЮKassa. */ 'id': string; /** * Идентификатор платежа в ЮKassa. */ 'payment_id': string; 'status': RefundStatus; 'cancellation_details'?: RefundCancellationDetails; /** * Статус регистрации чека. Возможные значения: pending — данные в обработке; succeeded — чек успешно зарегистрирован; canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную. Присутствует, если вы используете решения ЮKassa для отправки чеков в налоговую: https://yookassa.ru/developers/payment-acceptance/receipts/basics. */ 'receipt_registration'?: ReceiptRegistrationStatus; /** * Время создания возврата. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601, например 2017-11-03T11:52:31.827Z */ 'created_at': string; /** * Сумма, возвращенная пользователю. */ 'amount': MonetaryAmount; /** * Основание для возврата денег пользователю. */ 'description'?: string; /** * Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата. Присутствует, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. */ 'sources'?: Array; 'deal'?: RefundDealInfo; 'refund_method'?: RefundRefundMethod; 'refund_authorization_details'?: RefundAuthorizationDetails; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * Данные об авторизации возврата. Присутствуют только для возвратов платежей, совершенных этими способами оплаты: банковская карта, Mir Pay. */ interface RefundAuthorizationDetails { /** * Retrieval Reference Number — идентификатор банковской транзакции. */ 'rrn'?: string; } /** * Комментарий к статусу canceled: кто отменил возврат и по какой причине. */ interface RefundCancellationDetails { /** * Участник процесса возврата, который принял решение отменить транзакцию. Перечень и описание возможных значений: https://yookassa.ru/developers/payment-acceptance/after-the-payment/refunds#declined-refunds-cancellation-details-party */ 'party': RefundCancellationDetailsPartyEnum; /** * Причина отмены возврата. Перечень и описание возможных значений: https://yookassa.ru/developers/payment-acceptance/after-the-payment/refunds#declined-refunds-cancellation-details-reason */ 'reason': RefundCancellationDetailsReasonEnum; } declare const RefundCancellationDetailsPartyEnum: { readonly YooMoney: "yoo_money"; readonly RefundNetwork: "refund_network"; }; type RefundCancellationDetailsPartyEnum = typeof RefundCancellationDetailsPartyEnum[keyof typeof RefundCancellationDetailsPartyEnum]; declare const RefundCancellationDetailsReasonEnum: { readonly YooMoneyAccountClosed: "yoo_money_account_closed"; readonly InsufficientFunds: "insufficient_funds"; readonly GeneralDecline: "general_decline"; readonly RejectedByPayee: "rejected_by_payee"; readonly RejectedByTimeout: "rejected_by_timeout"; readonly PaymentBasketIdNotFound: "payment_basket_id_not_found"; readonly PaymentArticleNumberNotFound: "payment_article_number_not_found"; readonly PaymentTruCodeNotFound: "payment_tru_code_not_found"; readonly TooManyRefundingArticles: "too_many_refunding_articles"; readonly SomeArticlesAlreadyRefunded: "some_articles_already_refunded"; }; type RefundCancellationDetailsReasonEnum = typeof RefundCancellationDetailsReasonEnum[keyof typeof RefundCancellationDetailsReasonEnum]; /** * Данные о сделке, в составе которой проходит возврат. Необходимо передавать, если вы проводите Безопасную сделку: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. */ interface RefundDealData { /** * Данные о распределении денег. */ 'refund_settlements': Array; } /** * Данные о сделке, в составе которой проходит возврат. Присутствует, если вы проводите Безопасную сделку: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. */ interface RefundDealInfo { /** * Идентификатор сделки. Берется из возвращаемого платежа. */ 'id': string; /** * Данные о распределении денег. */ 'refund_settlements': Array; } /** * Список возвратов. Возвраты отсортированы по времени создания в порядке убывания (от новых к старым). Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент. */ interface RefundList { /** * Формат выдачи результатов запроса. Возможное значение: list (список). */ 'type': RefundListTypeEnum; 'items': Array; /** * Указатель на следующий фрагмент списка. Обязательный параметр, если размер списка больше размера выдачи (limit) и конец выдачи не достигнут. */ 'next_cursor'?: string; } declare const RefundListTypeEnum: { readonly List: "list"; }; type RefundListTypeEnum = typeof RefundListTypeEnum[keyof typeof RefundListTypeEnum]; /** * Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа. */ interface RefundMethod { 'type': RefundMethodType; } /** * Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа. */ interface RefundMethodData { 'type': RefundMethodType; } /** * Код способа оплаты, который использовался при проведении платежа. */ declare const RefundMethodType: { readonly Sbp: "sbp"; readonly ElectronicCertificate: "electronic_certificate"; }; type RefundMethodType = typeof RefundMethodType[keyof typeof RefundMethodType]; /** * @type RefundRefundMethod */ type RefundRefundMethod = ElectronicCertificateRefundMethod | SbpRefundMethod; interface RefundRequest { /** * Идентификатор платежа в ЮKassa. */ 'payment_id': string; /** * Сумма, которую нужно вернуть пользователю. Сумма указывается с кодом валюты. Если вы разделяете потоки платежей, валюта возврата должна соответствовать валюте субаккаунта, которая была указана для платежа (recipient.gateway_id), если не разделяете — валюте аккаунта shopId в личном кабинете). */ 'amount': MonetaryAmount; /** * Комментарий к возврату, основание для возврата денег пользователю. */ 'description'?: string; 'receipt'?: ReceiptData; /** * Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата. Необходимо передавать, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. Сейчас в этом параметре можно передать данные только одного магазина. */ 'sources'?: Array; 'deal'?: RefundDealData; 'refund_method_data'?: ElectronicCertificateRefundMethodData; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата. Сейчас в этом параметре можно передать данные только одного магазина. */ interface RefundSourcesData { /** * Идентификатор магазина, для которого вы хотите провести возврат. Выдается ЮKassa, отображается в разделе Продавцы: https://yookassa.ru/my/marketplace/sellers личного кабинета (столбец shopId). */ 'account_id': string; 'amount': RefundSourcesDataAmount; 'platform_fee_amount'?: RefundSourcesDataPlatformFeeAmount; } /** * Сумма возврата. */ interface RefundSourcesDataAmount { /** * Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. */ 'value': string; 'currency': CurrencyCode; } /** * Комиссия, которую вы удержали при оплате, и хотите вернуть. */ interface RefundSourcesDataPlatformFeeAmount { /** * Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. */ 'value': string; 'currency': CurrencyCode; } /** * Статус возврата платежа. Возможные значения: pending — возврат создан, но пока еще обрабатывается; succeeded — возврат успешно завершен, указанная в запросе сумма переведена на платежное средство пользователя (финальный и неизменяемый статус); canceled — возврат отменен, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус). */ declare const RefundStatus: { readonly Pending: "pending"; readonly Succeeded: "succeeded"; readonly Canceled: "canceled"; }; type RefundStatus = typeof RefundStatus[keyof typeof RefundStatus]; interface SafeDeal extends BaseDeal { /** * Идентификатор сделки. */ 'id': string; 'fee_moment': FeeMoment; /** * Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок: https://yookassa.ru/developers/api#get_deals_list. */ 'description'?: string; /** * Баланс сделки. */ 'balance': MonetaryAmount; /** * Сумма вознаграждения продавца. */ 'payout_balance': MonetaryAmount; 'status': DealStatus; /** * Время создания сделки. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'created_at': string; /** * Время автоматического закрытия сделки. Если в указанное время сделка всё еще в статусе opened, ЮKassa вернет деньги покупателю и закроет сделку. По умолчанию время жизни сделки составляет 90 дней. Время указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z */ 'expires_at': string; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; /** * Признак тестовой операции. */ 'test': boolean; } /** * Данные для создания сделки. */ interface SafeDealRequest { 'type': DealType; 'fee_moment': FeeMoment; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; /** * Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок: https://yookassa.ru/developers/api#get_deals_list. */ 'description'?: string; } /** * Сохраненный способ оплаты. */ interface SavePaymentMethod { 'type': SavePaymentMethodType; /** * Идентификатор сохраненного способа оплаты. */ 'id': string; /** * Признак сохранения способа оплаты для автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/pay-with-saved. Возможные значения: true — способ оплаты сохранен для автоплатежей и выплат; false — способ оплаты не сохранен. */ 'saved': boolean; 'status': PaymentMethodStatus; 'holder': SavePaymentMethodHolder; /** * Название способа оплаты. */ 'title'?: string; 'confirmation'?: PaymentMethodsConfirmationRedirect; } /** * Сохраненная банковская карта. */ interface SavePaymentMethodBankCard extends SavePaymentMethod { 'card'?: BankCardData; } /** * Данные для проверки и сохранения способа оплаты. */ interface SavePaymentMethodData { 'type': SavePaymentMethodDataTypeEnum; /** * Данные магазина, для которого сохраняется способ оплаты. */ 'holder'?: Recipient; /** * IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. */ 'client_ip'?: string; 'confirmation'?: PaymentMethodsConfirmationAttrsRedirect; } declare const SavePaymentMethodDataTypeEnum: { readonly BankCard: "bank_card"; }; type SavePaymentMethodDataTypeEnum = typeof SavePaymentMethodDataTypeEnum[keyof typeof SavePaymentMethodDataTypeEnum]; /** * Данные для проверки и сохранения банковской карты. */ interface SavePaymentMethodDataBankCard extends SavePaymentMethodData { 'card'?: CardRequestDataWithCsc; } /** * Данные магазина, для которого сохраняется способ оплаты. */ interface SavePaymentMethodHolder { /** * Идентификатор магазина в ЮKassa. */ 'account_id': string; /** * Идентификатор субаккаунта. Используется для разделения потоков платежей в рамках одного аккаунта. */ 'gateway_id'?: string; } /** * Тип способа оплаты. */ declare const SavePaymentMethodType: { readonly BankCard: "bank_card"; }; type SavePaymentMethodType = typeof SavePaymentMethodType[keyof typeof SavePaymentMethodType]; /** * Объект участника СБП (Системы быстрых платежей ЦБ РФ) — актуальная информация о банке или платежном сервисе, подключенном к СБП. */ interface SbpParticipantBank { /** * Идентификатор банка или платежного сервиса в СБП (НСПК). */ 'bank_id': string; /** * Название банка или платежного сервиса в СБП. */ 'name': string; /** * Банковский идентификационный код (БИК) банка или платежного сервиса. */ 'bic': string; } /** * Реквизиты счета, который использовался для оплаты. Обязательный параметр для платежей в статусе succeeded. В остальных случаях может отсутствовать. */ interface SbpPayerBankDetails { /** * Идентификатор банка или платежного сервиса в СБП (НСПК). */ 'bank_id': string; /** * Банковский идентификационный код (БИК) банка или платежного сервиса. Используйте значение этого параметра, чтобы узнать дополнительные сведения об организации в Справочнике БИК: https://cbr.ru/PSystem/payment_system/?utm_source=w&utm_content=page#a_101477. Например, так вы можете определить название банка. */ 'bic': string; } interface SbpPayoutRecipientPersonalDataRequest extends PersonalDataRequest { /** * Фамилия пользователя. */ 'last_name': string; /** * Имя пользователя. */ 'first_name': string; /** * Отчество пользователя. Обязательный параметр, если есть в паспорте. */ 'middle_name'?: string; } /** * Данные для возврата платежа через СБП (НСПК). */ interface SbpRefundMethod extends RefundMethod { /** * Идентификатор операции в СБП (НСПК). Пример: 1027088AE4CB48CB81287833347A8777. Обязательный параметр для возвратов в статусе succeeded. В остальных случаях может отсутствовать. */ 'sbp_operation_id'?: string; } /** * Информация о совершенных расчетах. */ interface Settlement { /** * Тип расчета. Перечень возможных значений для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#settlement-type; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#settlement-type. */ 'type': SettlementTypeEnum; /** * Сумма расчета. */ 'amount': MonetaryAmount; } declare const SettlementTypeEnum: { readonly Cashless: "cashless"; readonly Prepayment: "prepayment"; readonly Postpayment: "postpayment"; readonly Consideration: "consideration"; }; type SettlementTypeEnum = typeof SettlementTypeEnum[keyof typeof SettlementTypeEnum]; /** * Тип операции. */ declare const SettlementItemType: { readonly Payout: "payout"; }; type SettlementItemType = typeof SettlementItemType[keyof typeof SettlementItemType]; /** * @type SettlementPaymentArrayInner */ type SettlementPaymentArrayInner = SettlementPayoutPayment; /** * Данные о распределении денег. */ interface SettlementPaymentItem { 'type': SettlementItemType; /** * Сумма вознаграждения продавца. */ 'amount': MonetaryAmount; } interface SettlementPayoutPayment extends SettlementPaymentItem {} interface SettlementPayoutRefund extends SettlementRefundItem {} /** * @type SettlementRefundArrayInner */ type SettlementRefundArrayInner = SettlementPayoutRefund; /** * Данные о распределении денег. */ interface SettlementRefundItem { 'type': SettlementItemType; /** * Сумма, на которую необходимо уменьшить вознаграждение продавца. Должна быть меньше суммы возврата или равна ей. */ 'amount': MonetaryAmount; } /** * Данные для отправки справки. Необходимо передавать, если вы хотите, чтобы после оплаты пользователь получил справку. Сейчас доступен один тип справок — квитанция по платежу. Это информация об успешном платеже, которую ЮKassa отправляет на электронную почту пользователя. Квитанцию можно отправить, если оплата прошла с банковской карты, через SberPay или СБП. Отправка квитанции доступна во всех сценариях интеграции: https://yookassa.ru/developers/payment-acceptance/getting-started/selecting-integration-scenario. */ interface Statement { 'type': StatementTypeEnum; } declare const StatementTypeEnum: { readonly PaymentOverview: "payment_overview"; }; type StatementTypeEnum = typeof StatementTypeEnum[keyof typeof StatementTypeEnum]; /** * Данные о прохождении пользователем аутентификации по 3‑D Secure для подтверждения платежа. */ interface ThreeDSecureDetails { /** * Отображение пользователю формы для прохождения аутентификации по 3‑D Secure. Возможные значения: true — ЮKassa отобразила пользователю форму, чтобы он мог пройти аутентификацию по 3‑D Secure; false — платеж проходил без аутентификации по 3‑D Secure. */ 'applied': boolean; } /** * Слишком много запросов одновременно отправляется в API. Повторите запрос позже. */ interface TooManyRequests { /** * Тип объекта. */ 'type'?: TooManyRequestsTypeEnum; /** * Идентификатор ошибки. Используйте его, если возникла необходимость обратиться в техническую поддержку. */ 'id'?: string; /** * Подробное описание ошибки. */ 'description'?: string; /** * Название параметра, из-за которого произошла ошибка. */ 'parameter'?: string; /** * Рекомендуемое количество миллисекунд, спустя которое следует повторить запрос. */ 'retry_after'?: number; /** * Код ошибки. */ 'code'?: TooManyRequestsCodeEnum; } declare const TooManyRequestsTypeEnum: { readonly Error: "error"; }; type TooManyRequestsTypeEnum = typeof TooManyRequestsTypeEnum[keyof typeof TooManyRequestsTypeEnum]; declare const TooManyRequestsCodeEnum: { readonly TooManyRequests: "too_many_requests"; }; type TooManyRequestsCodeEnum = typeof TooManyRequestsCodeEnum[keyof typeof TooManyRequestsCodeEnum]; /** * Данные о распределении денег — сколько и в какой магазин нужно перевести. Присутствует, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. */ interface Transfer { /** * Идентификатор магазина, в пользу которого вы принимаете оплату. Выдается ЮKassa, отображается в разделе Продавцы: https://yookassa.ru/my/marketplace/sellers личного кабинета (столбец shopId). */ 'account_id': string; 'amount': TransferAmount; 'status': TransferStatus; 'platform_fee_amount'?: TransferPlatformFeeAmount; /** * Описание транзакции (не более 128 символов), которое продавец увидит в личном кабинете ЮKassa. Например: «Заказ маркетплейса №72». */ 'description'?: string; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * Сумма, которую необходимо перечислить магазину. */ interface TransferAmount { /** * Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. */ 'value': string; 'currency': CurrencyCode; } /** * Данные о распределении денег — сколько и в какой магазин нужно перевести. Необходимо передавать, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. */ interface TransferData { /** * Идентификатор магазина, в пользу которого вы принимаете оплату. Выдается ЮKassa, отображается в разделе Продавцы: https://yookassa.ru/my/marketplace/sellers личного кабинета (столбец shopId). */ 'account_id': string; 'amount': TransferDataAmount; 'platform_fee_amount'?: TransferPlatformFeeAmount; } /** * Сумма, которую необходимо перевести магазину. */ interface TransferDataAmount { /** * Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. */ 'value': string; 'currency': CurrencyCode; } interface TransferDataCapture { /** * Идентификатор магазина, в пользу которого вы принимаете оплату. Выдается ЮKassa, отображается в разделе Продавцы: https://yookassa.ru/my/marketplace/sellers личного кабинета (столбец shopId). */ 'account_id': string; 'amount': TransferDataAmount; 'platform_fee_amount'?: TransferPlatformFeeAmount; } interface TransferDataPayment { /** * Идентификатор магазина, в пользу которого вы принимаете оплату. Выдается ЮKassa, отображается в разделе Продавцы: https://yookassa.ru/my/marketplace/sellers личного кабинета (столбец shopId). */ 'account_id': string; 'amount': TransferDataAmount; 'platform_fee_amount'?: TransferPlatformFeeAmount; /** * Описание транзакции (не более 128 символов), которое продавец увидит в личном кабинете ЮKassa. Например: «Заказ маркетплейса №72». */ 'description'?: string; /** * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. */ 'metadata'?: { [key: string]: string | null; }; } /** * Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу. */ interface TransferPlatformFeeAmount { /** * Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. */ 'value': string; 'currency': CurrencyCode; } /** * Статус распределения денег между магазинами. Возможные значения: pending, waiting_for_capture, succeeded, canceled. */ declare const TransferStatus: { readonly Pending: "pending"; readonly WaitingForCapture: "waiting_for_capture"; readonly Succeeded: "succeeded"; readonly Canceled: "canceled"; }; type TransferStatus = typeof TransferStatus[keyof typeof TransferStatus]; /** * Данные о webhook. */ interface Webhook { /** * Идентификатор webhook. */ 'id': string; /** * Событие: https://yookassa.ru/developers/using-api/webhooks#events, о котором уведомляет ЮKassa. */ 'event': NotificationEventType; /** * URL, на который ЮKassa отправляет уведомления. */ 'url': string; } /** * Список webhook. */ interface WebhookList { /** * Формат выдачи результатов запроса. Возможное значение: list (список). */ 'type': WebhookListTypeEnum; 'items': Array; } declare const WebhookListTypeEnum: { readonly List: "list"; }; type WebhookListTypeEnum = typeof WebhookListTypeEnum[keyof typeof WebhookListTypeEnum]; /** * DealsApi - axios parameter creator */ declare const DealsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Запрос позволяет получить информацию о текущем состоянии сделки по ее уникальному идентификатору. * @summary Информация о сделке * @param {string} dealId * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsDealIdGet: (dealId: string, options?: RawAxiosRequestConfig) => Promise; /** * Запрос позволяет получить список сделок, отфильтрованный по заданным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список сделок * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGte] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGt] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLte] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLt] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lt=2018-07-18T10:51:18.139Z * @param {DealStatus} [status] Фильтр по статусу сделки. Пример: status=closed * @param {string} [fullTextSearch] Фильтр по описанию сделки — параметру description (например, идентификатор сделки на стороне вашей интернет-площадки в ЮKassa, идентификатор покупателя или продавца). От 4 до 128 символов. Пример: 123554642-2432FF344R * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsGet: (createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, expiresAtGte?: string, expiresAtGt?: string, expiresAtLte?: string, expiresAtLt?: string, status?: DealStatus, fullTextSearch?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу. * @summary Создание сделки * @param {string} idempotenceKey * @param {SafeDealRequest} safeDealRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsPost: (idempotenceKey: string, safeDealRequest: SafeDealRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * DealsApi - functional programming interface */ declare const DealsApiFp: (configuration?: Configuration) => { /** * Запрос позволяет получить информацию о текущем состоянии сделки по ее уникальному идентификатору. * @summary Информация о сделке * @param {string} dealId * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsDealIdGet(dealId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Запрос позволяет получить список сделок, отфильтрованный по заданным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список сделок * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGte] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGt] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLte] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLt] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lt=2018-07-18T10:51:18.139Z * @param {DealStatus} [status] Фильтр по статусу сделки. Пример: status=closed * @param {string} [fullTextSearch] Фильтр по описанию сделки — параметру description (например, идентификатор сделки на стороне вашей интернет-площадки в ЮKassa, идентификатор покупателя или продавца). От 4 до 128 символов. Пример: 123554642-2432FF344R * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, expiresAtGte?: string, expiresAtGt?: string, expiresAtLte?: string, expiresAtLt?: string, status?: DealStatus, fullTextSearch?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу. * @summary Создание сделки * @param {string} idempotenceKey * @param {SafeDealRequest} safeDealRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsPost(idempotenceKey: string, safeDealRequest: SafeDealRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DealsApi - factory interface */ declare const DealsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Запрос позволяет получить информацию о текущем состоянии сделки по ее уникальному идентификатору. * @summary Информация о сделке * @param {string} dealId * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsDealIdGet(dealId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Запрос позволяет получить список сделок, отфильтрованный по заданным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список сделок * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGte] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGt] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLte] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLt] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lt=2018-07-18T10:51:18.139Z * @param {DealStatus} [status] Фильтр по статусу сделки. Пример: status=closed * @param {string} [fullTextSearch] Фильтр по описанию сделки — параметру description (например, идентификатор сделки на стороне вашей интернет-площадки в ЮKassa, идентификатор покупателя или продавца). От 4 до 128 символов. Пример: 123554642-2432FF344R * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, expiresAtGte?: string, expiresAtGt?: string, expiresAtLte?: string, expiresAtLt?: string, status?: DealStatus, fullTextSearch?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу. * @summary Создание сделки * @param {string} idempotenceKey * @param {SafeDealRequest} safeDealRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsPost(idempotenceKey: string, safeDealRequest: SafeDealRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DealsApi - object-oriented interface */ declare class DealsApi extends BaseAPI { /** * Запрос позволяет получить информацию о текущем состоянии сделки по ее уникальному идентификатору. * @summary Информация о сделке * @param {string} dealId * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsDealIdGet(dealId: string, options?: RawAxiosRequestConfig): Promise>; /** * Запрос позволяет получить список сделок, отфильтрованный по заданным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список сделок * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGte] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtGt] Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.gt=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLte] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lte=2018-07-18T10:51:18.139Z * @param {string} [expiresAtLt] Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: expires_at.lt=2018-07-18T10:51:18.139Z * @param {DealStatus} [status] Фильтр по статусу сделки. Пример: status=closed * @param {string} [fullTextSearch] Фильтр по описанию сделки — параметру description (например, идентификатор сделки на стороне вашей интернет-площадки в ЮKassa, идентификатор покупателя или продавца). От 4 до 128 символов. Пример: 123554642-2432FF344R * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, expiresAtGte?: string, expiresAtGt?: string, expiresAtLte?: string, expiresAtLt?: string, status?: DealStatus, fullTextSearch?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу. * @summary Создание сделки * @param {string} idempotenceKey * @param {SafeDealRequest} safeDealRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ dealsPost(idempotenceKey: string, safeDealRequest: SafeDealRequest, options?: RawAxiosRequestConfig): Promise>; } /** * InvoicesApi - axios parameter creator */ declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии счета по его уникальному идентификатору. * @summary Информация о счете * @param {string} invoiceId Идентификатор счета в ЮKassa. * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesInvoiceIdGet: (invoiceId: string, options?: RawAxiosRequestConfig) => Promise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект счета: https://yookassa.ru/developers/api#invoice_object. В запросе необходимо передать данные о заказе, которые отобразятся на странице счета, и данные для проведения платежа. * @summary Создание счета * @param {string} idempotenceKey * @param {CreateInvoiceRequest} createInvoiceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesPost: (idempotenceKey: string, createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * InvoicesApi - functional programming interface */ declare const InvoicesApiFp: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии счета по его уникальному идентификатору. * @summary Информация о счете * @param {string} invoiceId Идентификатор счета в ЮKassa. * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesInvoiceIdGet(invoiceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект счета: https://yookassa.ru/developers/api#invoice_object. В запросе необходимо передать данные о заказе, которые отобразятся на странице счета, и данные для проведения платежа. * @summary Создание счета * @param {string} idempotenceKey * @param {CreateInvoiceRequest} createInvoiceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesPost(idempotenceKey: string, createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InvoicesApi - factory interface */ declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии счета по его уникальному идентификатору. * @summary Информация о счете * @param {string} invoiceId Идентификатор счета в ЮKassa. * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesInvoiceIdGet(invoiceId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект счета: https://yookassa.ru/developers/api#invoice_object. В запросе необходимо передать данные о заказе, которые отобразятся на странице счета, и данные для проведения платежа. * @summary Создание счета * @param {string} idempotenceKey * @param {CreateInvoiceRequest} createInvoiceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesPost(idempotenceKey: string, createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * InvoicesApi - object-oriented interface */ declare class InvoicesApi extends BaseAPI { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии счета по его уникальному идентификатору. * @summary Информация о счете * @param {string} invoiceId Идентификатор счета в ЮKassa. * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesInvoiceIdGet(invoiceId: string, options?: RawAxiosRequestConfig): Promise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект счета: https://yookassa.ru/developers/api#invoice_object. В запросе необходимо передать данные о заказе, которые отобразятся на странице счета, и данные для проведения платежа. * @summary Создание счета * @param {string} idempotenceKey * @param {CreateInvoiceRequest} createInvoiceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ invoicesPost(idempotenceKey: string, createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise>; } /** * PaymentMethodsApi - axios parameter creator */ declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии способа оплаты по его уникальному идентификатору. * @summary Информация о способе оплаты * @param {string} paymentMethodId Идентификатор сохраненного способа оплаты. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPaymentMethodIdGet: (paymentMethodId: string, options?: RawAxiosRequestConfig) => Promise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект способа оплаты: https://yookassa.ru/developers/api#payment_method_object. В запросе необходимо передать код способа оплаты, который вы хотите сохранить, и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Идентификатор созданного способа оплаты вы можете использовать при проведении автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/create-recurring или выплат: https://yookassa.ru/developers/payouts/scenario-extensions/multipurpose-token. * @summary Создание способа оплаты * @param {string} idempotenceKey * @param {SavePaymentMethodDataBankCard} savePaymentMethodDataBankCard * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPost: (idempotenceKey: string, savePaymentMethodDataBankCard: SavePaymentMethodDataBankCard, options?: RawAxiosRequestConfig) => Promise; }; /** * PaymentMethodsApi - functional programming interface */ declare const PaymentMethodsApiFp: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии способа оплаты по его уникальному идентификатору. * @summary Информация о способе оплаты * @param {string} paymentMethodId Идентификатор сохраненного способа оплаты. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPaymentMethodIdGet(paymentMethodId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект способа оплаты: https://yookassa.ru/developers/api#payment_method_object. В запросе необходимо передать код способа оплаты, который вы хотите сохранить, и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Идентификатор созданного способа оплаты вы можете использовать при проведении автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/create-recurring или выплат: https://yookassa.ru/developers/payouts/scenario-extensions/multipurpose-token. * @summary Создание способа оплаты * @param {string} idempotenceKey * @param {SavePaymentMethodDataBankCard} savePaymentMethodDataBankCard * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPost(idempotenceKey: string, savePaymentMethodDataBankCard: SavePaymentMethodDataBankCard, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PaymentMethodsApi - factory interface */ declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии способа оплаты по его уникальному идентификатору. * @summary Информация о способе оплаты * @param {string} paymentMethodId Идентификатор сохраненного способа оплаты. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPaymentMethodIdGet(paymentMethodId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект способа оплаты: https://yookassa.ru/developers/api#payment_method_object. В запросе необходимо передать код способа оплаты, который вы хотите сохранить, и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Идентификатор созданного способа оплаты вы можете использовать при проведении автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/create-recurring или выплат: https://yookassa.ru/developers/payouts/scenario-extensions/multipurpose-token. * @summary Создание способа оплаты * @param {string} idempotenceKey * @param {SavePaymentMethodDataBankCard} savePaymentMethodDataBankCard * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPost(idempotenceKey: string, savePaymentMethodDataBankCard: SavePaymentMethodDataBankCard, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * PaymentMethodsApi - object-oriented interface */ declare class PaymentMethodsApi extends BaseAPI { /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии способа оплаты по его уникальному идентификатору. * @summary Информация о способе оплаты * @param {string} paymentMethodId Идентификатор сохраненного способа оплаты. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPaymentMethodIdGet(paymentMethodId: string, options?: RawAxiosRequestConfig): Promise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект способа оплаты: https://yookassa.ru/developers/api#payment_method_object. В запросе необходимо передать код способа оплаты, который вы хотите сохранить, и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Идентификатор созданного способа оплаты вы можете использовать при проведении автоплатежей: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/create-recurring или выплат: https://yookassa.ru/developers/payouts/scenario-extensions/multipurpose-token. * @summary Создание способа оплаты * @param {string} idempotenceKey * @param {SavePaymentMethodDataBankCard} savePaymentMethodDataBankCard * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentMethodsPost(idempotenceKey: string, savePaymentMethodDataBankCard: SavePaymentMethodDataBankCard, options?: RawAxiosRequestConfig): Promise>; } /** * PaymentsApi - axios parameter creator */ declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить список платежей. Для выгрузки доступны платежи, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список платежей * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGte] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGt] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLte] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLt] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения («по такой-то момент, не включая его») Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lt=2018-07-18T10:51:18.139Z * @param {PaymentMethodType} [paymentMethod] Фильтр по коду способа оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all. Пример: payment_method=bank_card * @param {PaymentStatus} [status] Фильтр по статусу платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsGet: (createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, capturedAtGte?: string, capturedAtGt?: string, capturedAtLte?: string, capturedAtLt?: string, paymentMethod?: PaymentMethodType, status?: PaymentStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Отменяет платеж, находящийся в статусе waiting_for_capture. Отмена платежа значит, что вы не готовы выдать пользователю товар или оказать услугу. Как только вы отменяете платеж, мы начинаем возвращать деньги на счет плательщика. Для платежей банковскими картами, из кошелька ЮMoney или через SberPay отмена происходит мгновенно. Для остальных способов оплаты возврат может занимать до нескольких дней. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Отмена платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCancelPost: (paymentId: string, idempotenceKey: string, options?: RawAxiosRequestConfig) => Promise; /** * Подтверждает вашу готовность принять платеж. После подтверждения платеж перейдет в статус succeeded. Это значит, что вы можете выдать товар или оказать услугу пользователю. Подтвердить можно только платеж в статусе waiting_for_capture и только в течение определенного времени (зависит от способа оплаты). Если вы не подтвердите платеж в отведенное время, он автоматически перейдет в статус canceled, и деньги вернутся пользователю. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Подтверждение платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {PaymentCaptureRequest} paymentCaptureRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCapturePost: (paymentId: string, idempotenceKey: string, paymentCaptureRequest: PaymentCaptureRequest, options?: RawAxiosRequestConfig) => Promise; /** * Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору. * @summary Информация о платеже * @param {string} paymentId Идентификатор платежа. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdGet: (paymentId: string, options?: RawAxiosRequestConfig) => Promise; /** * Чтобы принять оплату, необходимо создать объект платежа: https://yookassa.ru/developers/api#payment_object — Payment. Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус. * @summary Создание платежа * @param {string} idempotenceKey * @param {CreatePaymentRequest} createPaymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPost: (idempotenceKey: string, createPaymentRequest: CreatePaymentRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * PaymentsApi - functional programming interface */ declare const PaymentsApiFp: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить список платежей. Для выгрузки доступны платежи, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список платежей * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGte] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGt] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLte] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLt] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения («по такой-то момент, не включая его») Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lt=2018-07-18T10:51:18.139Z * @param {PaymentMethodType} [paymentMethod] Фильтр по коду способа оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all. Пример: payment_method=bank_card * @param {PaymentStatus} [status] Фильтр по статусу платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, capturedAtGte?: string, capturedAtGt?: string, capturedAtLte?: string, capturedAtLt?: string, paymentMethod?: PaymentMethodType, status?: PaymentStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Отменяет платеж, находящийся в статусе waiting_for_capture. Отмена платежа значит, что вы не готовы выдать пользователю товар или оказать услугу. Как только вы отменяете платеж, мы начинаем возвращать деньги на счет плательщика. Для платежей банковскими картами, из кошелька ЮMoney или через SberPay отмена происходит мгновенно. Для остальных способов оплаты возврат может занимать до нескольких дней. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Отмена платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCancelPost(paymentId: string, idempotenceKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Подтверждает вашу готовность принять платеж. После подтверждения платеж перейдет в статус succeeded. Это значит, что вы можете выдать товар или оказать услугу пользователю. Подтвердить можно только платеж в статусе waiting_for_capture и только в течение определенного времени (зависит от способа оплаты). Если вы не подтвердите платеж в отведенное время, он автоматически перейдет в статус canceled, и деньги вернутся пользователю. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Подтверждение платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {PaymentCaptureRequest} paymentCaptureRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCapturePost(paymentId: string, idempotenceKey: string, paymentCaptureRequest: PaymentCaptureRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору. * @summary Информация о платеже * @param {string} paymentId Идентификатор платежа. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdGet(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Чтобы принять оплату, необходимо создать объект платежа: https://yookassa.ru/developers/api#payment_object — Payment. Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус. * @summary Создание платежа * @param {string} idempotenceKey * @param {CreatePaymentRequest} createPaymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPost(idempotenceKey: string, createPaymentRequest: CreatePaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PaymentsApi - factory interface */ declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Используйте этот запрос, чтобы получить список платежей. Для выгрузки доступны платежи, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список платежей * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGte] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGt] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLte] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLt] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения («по такой-то момент, не включая его») Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lt=2018-07-18T10:51:18.139Z * @param {PaymentMethodType} [paymentMethod] Фильтр по коду способа оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all. Пример: payment_method=bank_card * @param {PaymentStatus} [status] Фильтр по статусу платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, capturedAtGte?: string, capturedAtGt?: string, capturedAtLte?: string, capturedAtLt?: string, paymentMethod?: PaymentMethodType, status?: PaymentStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Отменяет платеж, находящийся в статусе waiting_for_capture. Отмена платежа значит, что вы не готовы выдать пользователю товар или оказать услугу. Как только вы отменяете платеж, мы начинаем возвращать деньги на счет плательщика. Для платежей банковскими картами, из кошелька ЮMoney или через SberPay отмена происходит мгновенно. Для остальных способов оплаты возврат может занимать до нескольких дней. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Отмена платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCancelPost(paymentId: string, idempotenceKey: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Подтверждает вашу готовность принять платеж. После подтверждения платеж перейдет в статус succeeded. Это значит, что вы можете выдать товар или оказать услугу пользователю. Подтвердить можно только платеж в статусе waiting_for_capture и только в течение определенного времени (зависит от способа оплаты). Если вы не подтвердите платеж в отведенное время, он автоматически перейдет в статус canceled, и деньги вернутся пользователю. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Подтверждение платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {PaymentCaptureRequest} paymentCaptureRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCapturePost(paymentId: string, idempotenceKey: string, paymentCaptureRequest: PaymentCaptureRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору. * @summary Информация о платеже * @param {string} paymentId Идентификатор платежа. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdGet(paymentId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Чтобы принять оплату, необходимо создать объект платежа: https://yookassa.ru/developers/api#payment_object — Payment. Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус. * @summary Создание платежа * @param {string} idempotenceKey * @param {CreatePaymentRequest} createPaymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPost(idempotenceKey: string, createPaymentRequest: CreatePaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * PaymentsApi - object-oriented interface */ declare class PaymentsApi extends BaseAPI { /** * Используйте этот запрос, чтобы получить список платежей. Для выгрузки доступны платежи, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список платежей * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGte] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtGt] Фильтр по времени подтверждения платежей: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.gt=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLte] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lte=2018-07-18T10:51:18.139Z * @param {string} [capturedAtLt] Фильтр по времени подтверждения платежей: время должно быть меньше указанного значения («по такой-то момент, не включая его») Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: captured_at.lt=2018-07-18T10:51:18.139Z * @param {PaymentMethodType} [paymentMethod] Фильтр по коду способа оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all. Пример: payment_method=bank_card * @param {PaymentStatus} [status] Фильтр по статусу платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, capturedAtGte?: string, capturedAtGt?: string, capturedAtLte?: string, capturedAtLt?: string, paymentMethod?: PaymentMethodType, status?: PaymentStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Отменяет платеж, находящийся в статусе waiting_for_capture. Отмена платежа значит, что вы не готовы выдать пользователю товар или оказать услугу. Как только вы отменяете платеж, мы начинаем возвращать деньги на счет плательщика. Для платежей банковскими картами, из кошелька ЮMoney или через SberPay отмена происходит мгновенно. Для остальных способов оплаты возврат может занимать до нескольких дней. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Отмена платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCancelPost(paymentId: string, idempotenceKey: string, options?: RawAxiosRequestConfig): Promise>; /** * Подтверждает вашу готовность принять платеж. После подтверждения платеж перейдет в статус succeeded. Это значит, что вы можете выдать товар или оказать услугу пользователю. Подтвердить можно только платеж в статусе waiting_for_capture и только в течение определенного времени (зависит от способа оплаты). Если вы не подтвердите платеж в отведенное время, он автоматически перейдет в статус canceled, и деньги вернутся пользователю. Подробнее о подтверждении и отмене платежей: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel * @summary Подтверждение платежа * @param {string} paymentId Идентификатор платежа. * @param {string} idempotenceKey * @param {PaymentCaptureRequest} paymentCaptureRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdCapturePost(paymentId: string, idempotenceKey: string, paymentCaptureRequest: PaymentCaptureRequest, options?: RawAxiosRequestConfig): Promise>; /** * Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору. * @summary Информация о платеже * @param {string} paymentId Идентификатор платежа. * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPaymentIdGet(paymentId: string, options?: RawAxiosRequestConfig): Promise>; /** * Чтобы принять оплату, необходимо создать объект платежа: https://yookassa.ru/developers/api#payment_object — Payment. Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус. * @summary Создание платежа * @param {string} idempotenceKey * @param {CreatePaymentRequest} createPaymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ paymentsPost(idempotenceKey: string, createPaymentRequest: CreatePaymentRequest, options?: RawAxiosRequestConfig): Promise>; } /** * PayoutsApi - axios parameter creator */ declare const PayoutsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить список выплат. Для выгрузки доступны выплаты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {PayoutDestinationDataType} [payoutDestinationType] Фильтр по коду способа получения выплаты: https://yookassa.ru/developers/payouts/getting-started/payout-types-and-limits#types-destination. Пример: payout_destination.type=bank_card * @param {PayoutStatus} [status] Фильтр по статусу выплаты: https://yookassa.ru/developers/api#payout_object_status. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsGet: (createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, payoutDestinationType?: PayoutDestinationDataType, status?: PayoutStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии выплаты по ее уникальному идентификатору. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Информация о выплате * @param {string} payoutId * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPayoutIdGet: (payoutId: string, options?: RawAxiosRequestConfig) => Promise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект выплаты: https://yookassa.ru/developers/api#payout_object. В запросе необходимо передать сумму выплаты, данные о способе получения выплаты (например, номер кошелька ЮMoney), описание выплаты и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Передаваемые параметры и данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Создание выплаты * @param {string} idempotenceKey * @param {PayoutRequest} payoutRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPost: (idempotenceKey: string, payoutRequest: PayoutRequest, options?: RawAxiosRequestConfig) => Promise; /** * Используйте этот запрос для поиска выплат по заданным критериям. Доступно только для выплат, созданных за последние 3 месяца. Сейчас доступен поиск только по параметру metadata. Дополнительно можно указать дату и время создания выплаты (параметр created_at). Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Поиск выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {{ [key: string]: string; }} [metadata] Фильтр по объекту metadata. Строгий поиск по паре «ключ-значение»: возвращаются объекты, у которых в metadata есть точное совпадение по ключу и по значению. Ограничения: можно передать максимум одну пару «ключ-значение», имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8 в URL-encoded виде. Шаблон: metadata[key]=value Пример: metadata%5Boperation_id%5D=e2ab2e1c-776d-4376-aba8-d2099243d1f6 * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsSearchGet: (createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, metadata?: { [key: string]: string; }, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * PayoutsApi - functional programming interface */ declare const PayoutsApiFp: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить список выплат. Для выгрузки доступны выплаты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {PayoutDestinationDataType} [payoutDestinationType] Фильтр по коду способа получения выплаты: https://yookassa.ru/developers/payouts/getting-started/payout-types-and-limits#types-destination. Пример: payout_destination.type=bank_card * @param {PayoutStatus} [status] Фильтр по статусу выплаты: https://yookassa.ru/developers/api#payout_object_status. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, payoutDestinationType?: PayoutDestinationDataType, status?: PayoutStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии выплаты по ее уникальному идентификатору. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Информация о выплате * @param {string} payoutId * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPayoutIdGet(payoutId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект выплаты: https://yookassa.ru/developers/api#payout_object. В запросе необходимо передать сумму выплаты, данные о способе получения выплаты (например, номер кошелька ЮMoney), описание выплаты и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Передаваемые параметры и данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Создание выплаты * @param {string} idempotenceKey * @param {PayoutRequest} payoutRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPost(idempotenceKey: string, payoutRequest: PayoutRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Используйте этот запрос для поиска выплат по заданным критериям. Доступно только для выплат, созданных за последние 3 месяца. Сейчас доступен поиск только по параметру metadata. Дополнительно можно указать дату и время создания выплаты (параметр created_at). Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Поиск выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {{ [key: string]: string; }} [metadata] Фильтр по объекту metadata. Строгий поиск по паре «ключ-значение»: возвращаются объекты, у которых в metadata есть точное совпадение по ключу и по значению. Ограничения: можно передать максимум одну пару «ключ-значение», имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8 в URL-encoded виде. Шаблон: metadata[key]=value Пример: metadata%5Boperation_id%5D=e2ab2e1c-776d-4376-aba8-d2099243d1f6 * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsSearchGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, metadata?: { [key: string]: string; }, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PayoutsApi - factory interface */ declare const PayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Используйте этот запрос, чтобы получить список выплат. Для выгрузки доступны выплаты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {PayoutDestinationDataType} [payoutDestinationType] Фильтр по коду способа получения выплаты: https://yookassa.ru/developers/payouts/getting-started/payout-types-and-limits#types-destination. Пример: payout_destination.type=bank_card * @param {PayoutStatus} [status] Фильтр по статусу выплаты: https://yookassa.ru/developers/api#payout_object_status. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, payoutDestinationType?: PayoutDestinationDataType, status?: PayoutStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии выплаты по ее уникальному идентификатору. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Информация о выплате * @param {string} payoutId * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPayoutIdGet(payoutId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект выплаты: https://yookassa.ru/developers/api#payout_object. В запросе необходимо передать сумму выплаты, данные о способе получения выплаты (например, номер кошелька ЮMoney), описание выплаты и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Передаваемые параметры и данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Создание выплаты * @param {string} idempotenceKey * @param {PayoutRequest} payoutRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPost(idempotenceKey: string, payoutRequest: PayoutRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Используйте этот запрос для поиска выплат по заданным критериям. Доступно только для выплат, созданных за последние 3 месяца. Сейчас доступен поиск только по параметру metadata. Дополнительно можно указать дату и время создания выплаты (параметр created_at). Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Поиск выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {{ [key: string]: string; }} [metadata] Фильтр по объекту metadata. Строгий поиск по паре «ключ-значение»: возвращаются объекты, у которых в metadata есть точное совпадение по ключу и по значению. Ограничения: можно передать максимум одну пару «ключ-значение», имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8 в URL-encoded виде. Шаблон: metadata[key]=value Пример: metadata%5Boperation_id%5D=e2ab2e1c-776d-4376-aba8-d2099243d1f6 * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsSearchGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, metadata?: { [key: string]: string; }, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * PayoutsApi - object-oriented interface */ declare class PayoutsApi extends BaseAPI { /** * Используйте этот запрос, чтобы получить список выплат. Для выгрузки доступны выплаты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {PayoutDestinationDataType} [payoutDestinationType] Фильтр по коду способа получения выплаты: https://yookassa.ru/developers/payouts/getting-started/payout-types-and-limits#types-destination. Пример: payout_destination.type=bank_card * @param {PayoutStatus} [status] Фильтр по статусу выплаты: https://yookassa.ru/developers/api#payout_object_status. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, payoutDestinationType?: PayoutDestinationDataType, status?: PayoutStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Используйте этот запрос, чтобы получить информацию о текущем состоянии выплаты по ее уникальному идентификатору. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Информация о выплате * @param {string} payoutId * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPayoutIdGet(payoutId: string, options?: RawAxiosRequestConfig): Promise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект выплаты: https://yookassa.ru/developers/api#payout_object. В запросе необходимо передать сумму выплаты, данные о способе получения выплаты (например, номер кошелька ЮMoney), описание выплаты и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Передаваемые параметры и данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Создание выплаты * @param {string} idempotenceKey * @param {PayoutRequest} payoutRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsPost(idempotenceKey: string, payoutRequest: PayoutRequest, options?: RawAxiosRequestConfig): Promise>; /** * Используйте этот запрос для поиска выплат по заданным критериям. Доступно только для выплат, созданных за последние 3 месяца. Сейчас доступен поиск только по параметру metadata. Дополнительно можно указать дату и время создания выплаты (параметр created_at). Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. * @summary Поиск выплат * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {{ [key: string]: string; }} [metadata] Фильтр по объекту metadata. Строгий поиск по паре «ключ-значение»: возвращаются объекты, у которых в metadata есть точное совпадение по ключу и по значению. Ограничения: можно передать максимум одну пару «ключ-значение», имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8 в URL-encoded виде. Шаблон: metadata[key]=value Пример: metadata%5Boperation_id%5D=e2ab2e1c-776d-4376-aba8-d2099243d1f6 * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ payoutsSearchGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, metadata?: { [key: string]: string; }, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; } /** * PersonalDataApi - axios parameter creator */ declare const PersonalDataApiAxiosParamCreator: (configuration?: Configuration) => { /** * С помощью этого запроса вы можете получить информацию о текущем статусе объекта персональных данных по его уникальному идентификатору. * @summary Информация о персональных данных * @param {string} personalDataId * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPersonalDataIdGet: (personalDataId: string, options?: RawAxiosRequestConfig) => Promise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект персональных данных: https://yookassa.ru/developers/api#personal_data_object. В запросе необходимо указать тип данных (с какой целью они будут использоваться) и передать информацию о пользователе: фамилию, имя, отчество и другие — в зависимости от выбранного типа. Идентификатор созданного объекта персональных данных необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. * @summary Создание персональных данных * @param {string} idempotenceKey * @param {PersonalDataPostRequest} personalDataPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPost: (idempotenceKey: string, personalDataPostRequest: PersonalDataPostRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * PersonalDataApi - functional programming interface */ declare const PersonalDataApiFp: (configuration?: Configuration) => { /** * С помощью этого запроса вы можете получить информацию о текущем статусе объекта персональных данных по его уникальному идентификатору. * @summary Информация о персональных данных * @param {string} personalDataId * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPersonalDataIdGet(personalDataId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект персональных данных: https://yookassa.ru/developers/api#personal_data_object. В запросе необходимо указать тип данных (с какой целью они будут использоваться) и передать информацию о пользователе: фамилию, имя, отчество и другие — в зависимости от выбранного типа. Идентификатор созданного объекта персональных данных необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. * @summary Создание персональных данных * @param {string} idempotenceKey * @param {PersonalDataPostRequest} personalDataPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPost(idempotenceKey: string, personalDataPostRequest: PersonalDataPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PersonalDataApi - factory interface */ declare const PersonalDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * С помощью этого запроса вы можете получить информацию о текущем статусе объекта персональных данных по его уникальному идентификатору. * @summary Информация о персональных данных * @param {string} personalDataId * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPersonalDataIdGet(personalDataId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Используйте этот запрос, чтобы создать в ЮKassa объект персональных данных: https://yookassa.ru/developers/api#personal_data_object. В запросе необходимо указать тип данных (с какой целью они будут использоваться) и передать информацию о пользователе: фамилию, имя, отчество и другие — в зависимости от выбранного типа. Идентификатор созданного объекта персональных данных необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. * @summary Создание персональных данных * @param {string} idempotenceKey * @param {PersonalDataPostRequest} personalDataPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPost(idempotenceKey: string, personalDataPostRequest: PersonalDataPostRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * PersonalDataApi - object-oriented interface */ declare class PersonalDataApi extends BaseAPI { /** * С помощью этого запроса вы можете получить информацию о текущем статусе объекта персональных данных по его уникальному идентификатору. * @summary Информация о персональных данных * @param {string} personalDataId * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPersonalDataIdGet(personalDataId: string, options?: RawAxiosRequestConfig): Promise>; /** * Используйте этот запрос, чтобы создать в ЮKassa объект персональных данных: https://yookassa.ru/developers/api#personal_data_object. В запросе необходимо указать тип данных (с какой целью они будут использоваться) и передать информацию о пользователе: фамилию, имя, отчество и другие — в зависимости от выбранного типа. Идентификатор созданного объекта персональных данных необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. * @summary Создание персональных данных * @param {string} idempotenceKey * @param {PersonalDataPostRequest} personalDataPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ personalDataPost(idempotenceKey: string, personalDataPostRequest: PersonalDataPostRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ReceiptsApi - axios parameter creator */ declare const ReceiptsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список чеков * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {ReceiptRegistrationStatus} [status] Фильтр по статусу чека. Возможные значения: pending — в обработке, succeeded — успешно зарегистрирован, canceled — отменен. Пример: status=succeeded * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все чеки для указанного платежа). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {string} [refundId] Фильтр по идентификатору возврата: https://yookassa.ru/developers/api#refund_object_id (получить все чеки для указанного возврата). Пример: refund_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsGet: (createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, status?: ReceiptRegistrationStatus, paymentId?: string, refundId?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Используйте этот запрос при оплате с соблюдением требований 54-ФЗ: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/basics, чтобы создать чек зачета предоплаты. Если вы работаете по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment, в запросе также нужно передавать данные для формирования чека прихода и чека возврата прихода. * @summary Создание чека * @param {string} idempotenceKey * @param {PostReceiptData} postReceiptData * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsPost: (idempotenceKey: string, postReceiptData: PostReceiptData, options?: RawAxiosRequestConfig) => Promise; /** * Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору. * @summary Информация о чеке * @param {string} receiptId Идентификатор чека. * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsReceiptIdGet: (receiptId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ReceiptsApi - functional programming interface */ declare const ReceiptsApiFp: (configuration?: Configuration) => { /** * Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список чеков * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {ReceiptRegistrationStatus} [status] Фильтр по статусу чека. Возможные значения: pending — в обработке, succeeded — успешно зарегистрирован, canceled — отменен. Пример: status=succeeded * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все чеки для указанного платежа). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {string} [refundId] Фильтр по идентификатору возврата: https://yookassa.ru/developers/api#refund_object_id (получить все чеки для указанного возврата). Пример: refund_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, status?: ReceiptRegistrationStatus, paymentId?: string, refundId?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Используйте этот запрос при оплате с соблюдением требований 54-ФЗ: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/basics, чтобы создать чек зачета предоплаты. Если вы работаете по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment, в запросе также нужно передавать данные для формирования чека прихода и чека возврата прихода. * @summary Создание чека * @param {string} idempotenceKey * @param {PostReceiptData} postReceiptData * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsPost(idempotenceKey: string, postReceiptData: PostReceiptData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору. * @summary Информация о чеке * @param {string} receiptId Идентификатор чека. * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsReceiptIdGet(receiptId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReceiptsApi - factory interface */ declare const ReceiptsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список чеков * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {ReceiptRegistrationStatus} [status] Фильтр по статусу чека. Возможные значения: pending — в обработке, succeeded — успешно зарегистрирован, canceled — отменен. Пример: status=succeeded * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все чеки для указанного платежа). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {string} [refundId] Фильтр по идентификатору возврата: https://yookassa.ru/developers/api#refund_object_id (получить все чеки для указанного возврата). Пример: refund_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, status?: ReceiptRegistrationStatus, paymentId?: string, refundId?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Используйте этот запрос при оплате с соблюдением требований 54-ФЗ: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/basics, чтобы создать чек зачета предоплаты. Если вы работаете по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment, в запросе также нужно передавать данные для формирования чека прихода и чека возврата прихода. * @summary Создание чека * @param {string} idempotenceKey * @param {PostReceiptData} postReceiptData * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsPost(idempotenceKey: string, postReceiptData: PostReceiptData, options?: RawAxiosRequestConfig): AxiosPromise; /** * Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору. * @summary Информация о чеке * @param {string} receiptId Идентификатор чека. * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsReceiptIdGet(receiptId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ReceiptsApi - object-oriented interface */ declare class ReceiptsApi extends BaseAPI { /** * Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список чеков * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {ReceiptRegistrationStatus} [status] Фильтр по статусу чека. Возможные значения: pending — в обработке, succeeded — успешно зарегистрирован, canceled — отменен. Пример: status=succeeded * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все чеки для указанного платежа). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {string} [refundId] Фильтр по идентификатору возврата: https://yookassa.ru/developers/api#refund_object_id (получить все чеки для указанного возврата). Пример: refund_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата. * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, status?: ReceiptRegistrationStatus, paymentId?: string, refundId?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Используйте этот запрос при оплате с соблюдением требований 54-ФЗ: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/basics, чтобы создать чек зачета предоплаты. Если вы работаете по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment, в запросе также нужно передавать данные для формирования чека прихода и чека возврата прихода. * @summary Создание чека * @param {string} idempotenceKey * @param {PostReceiptData} postReceiptData * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsPost(idempotenceKey: string, postReceiptData: PostReceiptData, options?: RawAxiosRequestConfig): Promise>; /** * Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору. * @summary Информация о чеке * @param {string} receiptId Идентификатор чека. * @param {*} [options] Override http request option. * @throws {RequiredError} */ receiptsReceiptIdGet(receiptId: string, options?: RawAxiosRequestConfig): Promise>; } /** * RefundsApi - axios parameter creator */ declare const RefundsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить список возвратов. Для выгрузки доступны возвраты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список возвратов * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все возвраты по платежу). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 * @param {RefundStatus} [status] Фильтр по статусу возврата. Возможные значения: pending — в обработке, succeeded — успешно выполнен, canceled — отменен. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsGet: (createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, paymentId?: string, status?: RefundStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания: https://yookassa.ru/developers/api#create_payment. Комиссия ЮKassa за проведение платежа не возвращается. * @summary Создание возврата * @param {string} idempotenceKey * @param {RefundRequest} refundRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsPost: (idempotenceKey: string, refundRequest: RefundRequest, options?: RawAxiosRequestConfig) => Promise; /** * Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору. * @summary Информация о возврате * @param {string} refundId Идентификатор возврата. * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsRefundIdGet: (refundId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * RefundsApi - functional programming interface */ declare const RefundsApiFp: (configuration?: Configuration) => { /** * Используйте этот запрос, чтобы получить список возвратов. Для выгрузки доступны возвраты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список возвратов * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все возвраты по платежу). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 * @param {RefundStatus} [status] Фильтр по статусу возврата. Возможные значения: pending — в обработке, succeeded — успешно выполнен, canceled — отменен. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, paymentId?: string, status?: RefundStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания: https://yookassa.ru/developers/api#create_payment. Комиссия ЮKassa за проведение платежа не возвращается. * @summary Создание возврата * @param {string} idempotenceKey * @param {RefundRequest} refundRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsPost(idempotenceKey: string, refundRequest: RefundRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору. * @summary Информация о возврате * @param {string} refundId Идентификатор возврата. * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsRefundIdGet(refundId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RefundsApi - factory interface */ declare const RefundsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Используйте этот запрос, чтобы получить список возвратов. Для выгрузки доступны возвраты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список возвратов * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все возвраты по платежу). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 * @param {RefundStatus} [status] Фильтр по статусу возврата. Возможные значения: pending — в обработке, succeeded — успешно выполнен, canceled — отменен. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, paymentId?: string, status?: RefundStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания: https://yookassa.ru/developers/api#create_payment. Комиссия ЮKassa за проведение платежа не возвращается. * @summary Создание возврата * @param {string} idempotenceKey * @param {RefundRequest} refundRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsPost(idempotenceKey: string, refundRequest: RefundRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору. * @summary Информация о возврате * @param {string} refundId Идентификатор возврата. * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsRefundIdGet(refundId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RefundsApi - object-oriented interface */ declare class RefundsApi extends BaseAPI { /** * Используйте этот запрос, чтобы получить список возвратов. Для выгрузки доступны возвраты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists * @summary Список возвратов * @param {string} [createdAtGte] Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z * @param {string} [createdAtGt] Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z * @param {string} [createdAtLte] Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z * @param {string} [createdAtLt] Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z * @param {string} [paymentId] Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все возвраты по платежу). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 * @param {RefundStatus} [status] Фильтр по статусу возврата. Возможные значения: pending — в обработке, succeeded — успешно выполнен, canceled — отменен. Пример: status=succeeded * @param {number} [limit] Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10 * @param {string} [cursor] Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsGet(createdAtGte?: string, createdAtGt?: string, createdAtLte?: string, createdAtLt?: string, paymentId?: string, status?: RefundStatus, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания: https://yookassa.ru/developers/api#create_payment. Комиссия ЮKassa за проведение платежа не возвращается. * @summary Создание возврата * @param {string} idempotenceKey * @param {RefundRequest} refundRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsPost(idempotenceKey: string, refundRequest: RefundRequest, options?: RawAxiosRequestConfig): Promise>; /** * Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору. * @summary Информация о возврате * @param {string} refundId Идентификатор возврата. * @param {*} [options] Override http request option. * @throws {RequiredError} */ refundsRefundIdGet(refundId: string, options?: RawAxiosRequestConfig): Promise>; } /** * SbpParticipantsApi - axios parameter creator */ declare const SbpParticipantsApiAxiosParamCreator: (configuration?: Configuration) => { /** * С помощью этого запроса вы можете получить актуальный список всех участников СБП. Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. Подробнее о выплатах через СБП: https://yookassa.ru/developers/payouts/making-payouts/sbp * @summary Список участников СБП * @param {*} [options] Override http request option. * @throws {RequiredError} */ sbpBanksGet: (options?: RawAxiosRequestConfig) => Promise; }; /** * SbpParticipantsApi - functional programming interface */ declare const SbpParticipantsApiFp: (configuration?: Configuration) => { /** * С помощью этого запроса вы можете получить актуальный список всех участников СБП. Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. Подробнее о выплатах через СБП: https://yookassa.ru/developers/payouts/making-payouts/sbp * @summary Список участников СБП * @param {*} [options] Override http request option. * @throws {RequiredError} */ sbpBanksGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SbpParticipantsApi - factory interface */ declare const SbpParticipantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * С помощью этого запроса вы можете получить актуальный список всех участников СБП. Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. Подробнее о выплатах через СБП: https://yookassa.ru/developers/payouts/making-payouts/sbp * @summary Список участников СБП * @param {*} [options] Override http request option. * @throws {RequiredError} */ sbpBanksGet(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SbpParticipantsApi - object-oriented interface */ declare class SbpParticipantsApi extends BaseAPI { /** * С помощью этого запроса вы можете получить актуальный список всех участников СБП. Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать в запросе на создание выплаты: https://yookassa.ru/developers/api#create_payout. Подробнее о выплатах через СБП: https://yookassa.ru/developers/payouts/making-payouts/sbp * @summary Список участников СБП * @param {*} [options] Override http request option. * @throws {RequiredError} */ sbpBanksGet(options?: RawAxiosRequestConfig): Promise>; } /** * SettingsApi - axios parameter creator */ declare const SettingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * С помощью этого запроса вы можете получить информацию о магазине или шлюзе: Для Сплитования платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics: в запросе необходимо передать параметр on_behalf_of с идентификатором магазина продавца и ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашей платформы).; Для партнеров: https://yookassa.ru/developers/solutions-for-platforms/partners-api/basics: в запросе необходимо передать OAuth-токен магазина.; Для выплат: https://yookassa.ru/developers/payouts/overview: в запросе необходимо передать ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашего шлюза). * @summary Информация о настройках магазина или шлюза * @param {string} [onBehalfOf] Только для тех, кто использует Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. Идентификатор магазина продавца, подключенного к вашей платформе, информацию о котором вы хотите узнать. * @param {*} [options] Override http request option. * @throws {RequiredError} */ meGet: (onBehalfOf?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * SettingsApi - functional programming interface */ declare const SettingsApiFp: (configuration?: Configuration) => { /** * С помощью этого запроса вы можете получить информацию о магазине или шлюзе: Для Сплитования платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics: в запросе необходимо передать параметр on_behalf_of с идентификатором магазина продавца и ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашей платформы).; Для партнеров: https://yookassa.ru/developers/solutions-for-platforms/partners-api/basics: в запросе необходимо передать OAuth-токен магазина.; Для выплат: https://yookassa.ru/developers/payouts/overview: в запросе необходимо передать ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашего шлюза). * @summary Информация о настройках магазина или шлюза * @param {string} [onBehalfOf] Только для тех, кто использует Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. Идентификатор магазина продавца, подключенного к вашей платформе, информацию о котором вы хотите узнать. * @param {*} [options] Override http request option. * @throws {RequiredError} */ meGet(onBehalfOf?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SettingsApi - factory interface */ declare const SettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * С помощью этого запроса вы можете получить информацию о магазине или шлюзе: Для Сплитования платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics: в запросе необходимо передать параметр on_behalf_of с идентификатором магазина продавца и ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашей платформы).; Для партнеров: https://yookassa.ru/developers/solutions-for-platforms/partners-api/basics: в запросе необходимо передать OAuth-токен магазина.; Для выплат: https://yookassa.ru/developers/payouts/overview: в запросе необходимо передать ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашего шлюза). * @summary Информация о настройках магазина или шлюза * @param {string} [onBehalfOf] Только для тех, кто использует Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. Идентификатор магазина продавца, подключенного к вашей платформе, информацию о котором вы хотите узнать. * @param {*} [options] Override http request option. * @throws {RequiredError} */ meGet(onBehalfOf?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SettingsApi - object-oriented interface */ declare class SettingsApi extends BaseAPI { /** * С помощью этого запроса вы можете получить информацию о магазине или шлюзе: Для Сплитования платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics: в запросе необходимо передать параметр on_behalf_of с идентификатором магазина продавца и ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашей платформы).; Для партнеров: https://yookassa.ru/developers/solutions-for-platforms/partners-api/basics: в запросе необходимо передать OAuth-токен магазина.; Для выплат: https://yookassa.ru/developers/payouts/overview: в запросе необходимо передать ваши данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth (идентификатор и секретный ключ вашего шлюза). * @summary Информация о настройках магазина или шлюза * @param {string} [onBehalfOf] Только для тех, кто использует Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics. Идентификатор магазина продавца, подключенного к вашей платформе, информацию о котором вы хотите узнать. * @param {*} [options] Override http request option. * @throws {RequiredError} */ meGet(onBehalfOf?: string, options?: RawAxiosRequestConfig): Promise>; } /** * WebhooksApi - axios parameter creator */ declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => { /** * Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена. * @summary Список созданных webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksGet: (options?: RawAxiosRequestConfig) => Promise; /** * Запрос позволяет подписаться на уведомления о событиях: https://yookassa.ru/developers/using-api/webhooks#events (например, переход платежа в статус succeeded). C помощью webhook можно подписаться только на события платежей и возвратов. Если вы хотите получать уведомления о нескольких событиях, вам нужно для каждого из них создать свой webhook. Для каждого OAuth-токена нужно создавать свой набор webhook. * @summary Создание webhook * @param {string} idempotenceKey * @param {CreateWebhookRequest} createWebhookRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksPost: (idempotenceKey: string, createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig) => Promise; /** * Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. * @summary Удаление webhook * @param {string} webhookId Идентификатор webhook-a. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksWebhookIdDelete: (webhookId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * WebhooksApi - functional programming interface */ declare const WebhooksApiFp: (configuration?: Configuration) => { /** * Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена. * @summary Список созданных webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Запрос позволяет подписаться на уведомления о событиях: https://yookassa.ru/developers/using-api/webhooks#events (например, переход платежа в статус succeeded). C помощью webhook можно подписаться только на события платежей и возвратов. Если вы хотите получать уведомления о нескольких событиях, вам нужно для каждого из них создать свой webhook. Для каждого OAuth-токена нужно создавать свой набор webhook. * @summary Создание webhook * @param {string} idempotenceKey * @param {CreateWebhookRequest} createWebhookRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksPost(idempotenceKey: string, createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. * @summary Удаление webhook * @param {string} webhookId Идентификатор webhook-a. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksWebhookIdDelete(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebhooksApi - factory interface */ declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена. * @summary Список созданных webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksGet(options?: RawAxiosRequestConfig): AxiosPromise; /** * Запрос позволяет подписаться на уведомления о событиях: https://yookassa.ru/developers/using-api/webhooks#events (например, переход платежа в статус succeeded). C помощью webhook можно подписаться только на события платежей и возвратов. Если вы хотите получать уведомления о нескольких событиях, вам нужно для каждого из них создать свой webhook. Для каждого OAuth-токена нужно создавать свой набор webhook. * @summary Создание webhook * @param {string} idempotenceKey * @param {CreateWebhookRequest} createWebhookRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksPost(idempotenceKey: string, createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. * @summary Удаление webhook * @param {string} webhookId Идентификатор webhook-a. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksWebhookIdDelete(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * WebhooksApi - object-oriented interface */ declare class WebhooksApi extends BaseAPI { /** * Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена. * @summary Список созданных webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksGet(options?: RawAxiosRequestConfig): Promise>; /** * Запрос позволяет подписаться на уведомления о событиях: https://yookassa.ru/developers/using-api/webhooks#events (например, переход платежа в статус succeeded). C помощью webhook можно подписаться только на события платежей и возвратов. Если вы хотите получать уведомления о нескольких событиях, вам нужно для каждого из них создать свой webhook. Для каждого OAuth-токена нужно создавать свой набор webhook. * @summary Создание webhook * @param {string} idempotenceKey * @param {CreateWebhookRequest} createWebhookRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksPost(idempotenceKey: string, createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise>; /** * Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. * @summary Удаление webhook * @param {string} webhookId Идентификатор webhook-a. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksWebhookIdDelete(webhookId: string, options?: RawAxiosRequestConfig): Promise>; } //#endregion export { DealsApiFactory as $, TransferAmount as $a, RefundDealData as $i, PaymentMethodWeChat as $n, PayoutToYooMoneyDestinationDataAllOfAccountNumber as $r, MeStatusEnum as $t, ConfirmationDataRedirect as A, SbpPayerBankDetails as Aa, ReceiptItemPaymentMode as Ai, PaymentMethodDataBankCard as An, PayoutCancellationDetailsPartyEnum as Ar, GoneCodeEnum as At, CreatePaymentRequest as B, SettlementPaymentItem as Ba, ReceiptsApiFactory as Bi, PaymentMethodDataYooMoney as Bn, PayoutPayoutDestination as Br, InvoiceCancellationDetailsReasonEnum as Bt, CardRequestDataWithCsc as C, SavePaymentMethodHolder as Ca, ReceiptAdditionalUserProps as Ci, PaymentMethodB2bSberbank as Cn, PaymentStatus as Cr, FiscalizationProvider as Ct, ConfirmationDataExternal as D, SbpParticipantsApiAxiosParamCreator as Da, ReceiptItem as Di, PaymentMethodData as Dn, PaymentsApiFp as Dr, GetSbpBanksResponse as Dt, ConfirmationDataEmbedded as E, SbpParticipantsApi as Ea, ReceiptDataItem as Ei, PaymentMethodCash as En, PaymentsApiFactory as Er, ForbiddenTypeEnum as Et, ConfirmationQr as F, SettingsApiFactory as Fa, ReceiptListTypeEnum as Fi, PaymentMethodDataSberLoan as Fn, PayoutDestination as Fr, InvalidCredentialsCodeEnum as Ft, CreateWebhookRequest as G, SettlementTypeEnum as Ga, ReceiverMobileBalance as Gi, PaymentMethodQiwi as Gn, PayoutStatementRecipientPersonalDataRequest as Gr, InvoicesApiFactory as Gt, CreatePaymentRequestPaymentMethodData as H, SettlementPayoutRefund as Ha, Receiver as Hi, PaymentMethodGooglePay as Hn, PayoutRequestPayoutDestinationData as Hr, InvoiceStatus as Ht, ConfirmationRedirect as I, SettingsApiFp as Ia, ReceiptRegistrationStatus as Ii, PaymentMethodDataSberbank as In, PayoutDestinationData as Ir, InvalidCredentialsTypeEnum as It, DealListTypeEnum as J, ThreeDSecureDetails as Ja, Refund as Ji, PaymentMethodSberbank as Jn, PayoutToCardDestination as Jr, LineItem as Jt, CurrencyCode as K, Statement as Ka, ReceiverType as Ki, PaymentMethodSberBnpl as Kn, PayoutStatus as Kr, InvoicesApiFp as Kt, ConfirmationType as L, Settlement as La, ReceiptType as Li, PaymentMethodDataSbp as Ln, PayoutDestinationDataType as Lr, Invoice as Lt, ConfirmationEmbedded as M, SbpRefundMethod as Ma, ReceiptItemSupplier as Mi, PaymentMethodDataElectronicCertificate as Mn, PayoutCardData as Mr, IncomeReceipt as Mt, ConfirmationExternal as N, SettingsApi as Na, ReceiptItemSupplierWithInn as Ni, PaymentMethodDataMobileBalance as Nn, PayoutDeal as Nr, IndustryDetails as Nt, ConfirmationDataMobileApplication as O, SbpParticipantsApiFactory as Oa, ReceiptItemAgentType as Oi, PaymentMethodDataB2bSberbank as On, Payout as Or, GetSbpBanksResponseTypeEnum as Ot, ConfirmationMobileApplication as P, SettingsApiAxiosParamCreator as Pa, ReceiptList as Pi, PaymentMethodDataSberBnpl as Pn, PayoutDealInfo as Pr, InvalidCredentials as Pt, DealsApiAxiosParamCreator as Q, Transfer as Qa, RefundCancellationDetailsReasonEnum as Qi, PaymentMethodType as Qn, PayoutToYooMoneyDestinationData as Qr, Me as Qt, CreateInvoiceRequest as R, SettlementItemType as Ra, ReceiptsApi as Ri, PaymentMethodDataTinkoffBank as Rn, PayoutDestinationType as Rr, InvoiceCancellationDetails as Rt, CardRequestData as S, SavePaymentMethodDataTypeEnum as Sa, Receipt as Si, PaymentMethodApplePay as Sn, PaymentRecipient as Sr, FiscalizationData as St, ConfirmationData as T, SbpParticipantBank as Ta, ReceiptDataCustomer as Ti, PaymentMethodBankCard as Tn, PaymentsApiAxiosParamCreator as Tr, ForbiddenCodeEnum as Tt, CreatePaymentRequestReceiver as U, SettlementRefundArrayInner as Ua, ReceiverBankAccount as Ui, PaymentMethodInstallments as Un, PayoutSelfEmployed as Ur, InvoicesApi as Ut, CreatePaymentRequestConfirmation as V, SettlementPayoutPayment as Va, ReceiptsApiFp as Vi, PaymentMethodElectronicCertificate as Vn, PayoutRequest as Vr, InvoiceDeliveryMethod as Vt, CreatePaymentRequestStatementsInner as W, SettlementRefundItem as Wa, ReceiverDigitalWallet as Wi, PaymentMethodMobileBalance as Wn, PayoutSelfEmployedInfo as Wr, InvoicesApiAxiosParamCreator as Wt, DealType as X, TooManyRequestsCodeEnum as Xa, RefundCancellationDetails as Xi, PaymentMethodStatus as Xn, PayoutToSbpDestinationData as Xr, MarkCodeInfo as Xt, DealStatus as Y, TooManyRequests as Ya, RefundAuthorizationDetails as Yi, PaymentMethodSbp as Yn, PayoutToSbpDestination as Yr, Locale as Yt, DealsApi as Z, TooManyRequestsTypeEnum as Za, RefundCancellationDetailsPartyEnum as Zi, PaymentMethodTinkoffBank as Zn, PayoutToYooMoneyDestination as Zr, MarkQuantity as Zt, BankCardProduct as _, SafeDealRequest as _a, PersonalDataStatusEnum as _i, PaymentInvoiceDetails as _n, PaymentOverviewStatementDeliveryMethod as _r, ElectronicCertificateRefundDataRequest as _t, B2bSberbankCalculatedVatData as a, RefundMethodType as aa, PayoutsListTypeEnum as ai, NotFoundTypeEnum as an, TransferStatus as ao, PaymentMethodsApiFp as ar, DeliveryMethodDataSms as at, CapturePaymentDeal as b, SavePaymentMethodData as ba, PostReceiptDataItem as bi, PaymentMethod as bn, PaymentPaymentMethod as br, ElectronicCertificateRefundMethodData as bt, B2bSberbankPayerBankDetails as c, RefundSourcesData as ca, PersonalDataApi as ci, Payment as cn, WebhookListTypeEnum as co, PaymentMethodsConfirmationAttrsRedirect as cr, DeliveryMethodSelf as ct, B2bSberbankVatDataType as d, RefundStatus as da, PersonalDataApiFp as di, PaymentCancellationDetailsReasonEnum as dn, WebhooksApiFactory as do, PaymentOrderBankUtilities as dr, ElectronicCertificate as dt, RefundDealInfo as ea, PayoutsApi as ei, ModelError as en, TransferData as eo, PaymentMethodWebmoney as er, DealsApiFp as et, BadRequest as f, RefundsApi as fa, PersonalDataCancellationDetails as fi, PaymentCaptureRequest as fn, WebhooksApiFp as fo, PaymentOrderData as fr, ElectronicCertificateApprovedPaymentArticle as ft, BankCardDataSource as g, SafeDeal as ga, PersonalDataRequest as gi, PaymentDetails as gn, PaymentOverviewStatementData as gr, ElectronicCertificateRefundArticle as gt, BankCardData as h, RefundsApiFp as ha, PersonalDataPostRequest as hi, PaymentDealInfo as hn, PaymentOrderRecipientUtilities as hr, ElectronicCertificatePaymentData as ht, AuthorizationDetails as i, RefundMethodData as ia, PayoutsList as ii, NotFoundCodeEnum as in, TransferPlatformFeeAmount as io, PaymentMethodsApiFactory as ir, DeliveryMethodDataSelf as it, ConfirmationDataType as j, SbpPayoutRecipientPersonalDataRequest as ja, ReceiptItemPaymentSubject as ji, PaymentMethodDataCash as jn, PayoutCancellationDetailsReasonEnum as jr, GoneTypeEnum as jt, ConfirmationDataQr as k, SbpParticipantsApiFp as ka, ReceiptItemMeasure as ki, PaymentMethodDataB2bSberbankAllOfVatData as kn, PayoutCancellationDetails as kr, Gone as kt, B2bSberbankUntaxedVatData as l, RefundSourcesDataAmount as la, PersonalDataApiAxiosParamCreator as li, PaymentCancellationDetails as ln, WebhooksApi as lo, PaymentMethodsConfirmationRedirect as lr, DeliveryMethodSms as lt, BadRequestTypeEnum as m, RefundsApiFactory as ma, PersonalDataCancellationDetailsReasonEnum as mi, PaymentData as mn, PaymentOrderDataUtilities as mr, ElectronicCertificatePayment as mt, AirlineLeg as n, RefundListTypeEnum as na, PayoutsApiFactory as ni, MonetaryAmount as nn, TransferDataCapture as no, PaymentMethodsApi as nr, DeliveryMethodData as nt, B2bSberbankCalculatedVatDataRateEnum as o, RefundRefundMethod as oa, PayoutsPersonalData as oi, NotificationEventType as on, Webhook as oo, PaymentMethodsConfirmation as or, DeliveryMethodDataTypeEnum as ot, BadRequestCodeEnum as p, RefundsApiAxiosParamCreator as pa, PersonalDataCancellationDetailsPartyEnum as pi, PaymentConfirmation as pn, PaymentOrderDataTypeEnum as pr, ElectronicCertificateArticle as pt, DealList as q, StatementTypeEnum as qa, Recipient as qi, PaymentMethodSberLoan as qn, PayoutToBankCardDestinationData as qr, InvoicingBankCardData as qt, AirlinePassenger as r, RefundMethod as ra, PayoutsApiFp as ri, NotFound as rn, TransferDataPayment as ro, PaymentMethodsApiAxiosParamCreator as rr, DeliveryMethodDataEmail as rt, B2bSberbankMixedVatData as s, RefundRequest as sa, PersonalData as si, OperationalDetails as sn, WebhookList as so, PaymentMethodsConfirmationAttrs as sr, DeliveryMethodEmail as st, Airline as t, RefundList as ta, PayoutsApiAxiosParamCreator as ti, ModelErrorTypeEnum as tn, TransferDataAmount as to, PaymentMethodYooMoney as tr, DeliveryMethod as tt, B2bSberbankVatData as u, RefundSourcesDataPlatformFeeAmount as ua, PersonalDataApiFactory as ui, PaymentCancellationDetailsPartyEnum as un, WebhooksApiAxiosParamCreator as uo, PaymentMethodsConfirmationType as ur, DeliveryMethodTypeEnum as ut, BankCardType as v, SavePaymentMethod as va, PersonalDataType as vi, PaymentList as vn, PaymentOverviewStatementDeliveryMethodType as vr, ElectronicCertificateRefundDataResponse as vt, Confirmation as w, SavePaymentMethodType as wa, ReceiptData as wi, PaymentMethodB2bSberbankAllOfVatData as wn, PaymentsApi as wr, Forbidden as wt, CardDataForPayoutDestination as x, SavePaymentMethodDataBankCard as xa, PostReceiptItemSupplierWithInn as xi, PaymentMethodAlfabank as xn, PaymentPeriod as xr, FeeMoment as xt, BaseDeal as y, SavePaymentMethodBankCard as ya, PostReceiptData as yi, PaymentListTypeEnum as yn, PaymentOverviewStatementEmailDeliveryMethod as yr, ElectronicCertificateRefundMethod as yt, CreateInvoiceRequestDeliveryMethodData as z, SettlementPaymentArrayInner as za, ReceiptsApiAxiosParamCreator as zi, PaymentMethodDataTypeEnum as zn, PayoutMethodType as zr, InvoiceCancellationDetailsPartyEnum as zt }; //# sourceMappingURL=api-Dot7r3No.d.ts.map