Объекты
AcquiringPayment
Объект со всеми данными платежа.
Название | Обязательность | Тип | Описание |
---|---|---|---|
id | + | string | Уникальный идентификатор платежа |
status | + | string | Статус платежа. Возможные варианты: succeeded , in_progress , pending , failed |
created_at | + | string | Дата создания в формате ISO 8601 |
payment_details | + | PaymentDetails | Платежные данные |
amount_details | + | AmountDetails | Сумма |
finished_at | - | string | Дата завершения в формате ISO 8601 |
customer | - | Customer | Данные пользователя (отправителя платежа) |
recurrent | - | RecurrentTokenInfo | Данные для проведения повторного платежа |
participant_details | - | ParticipantDetails | Данные об участниках |
refunds | - | array<Refund> | Список возвратов |
customer_interaction | - | Customer | Данные для взаимодействия с пользователем |
metadata | - | object | Дополнительная информация. Любые данные, которые вам необходимы для проведения операции. Возвращаются в ответах и вебхуках |
error | - | Error | Описание ошибки |
status
)
Статусы платежа (in_progress
— в обработке;pending
— ожидает вашего подтверждения (confirm_request
) или отмены (cancel_request
);succeeded
— оплата прошла успешно;failed
— оплата не прошла из-за ошибки.
AcquiringWidgetMetadata
Объект с настройками виджета платежной формы: для проведения платежей банковской картой.
Название | Обязательность | Тип | Описание |
---|---|---|---|
session_id | + | string | Идентификатор платежной сессии, по которой будет производиться оплата |
show_recurrent_checkbox | - | bool | Нужно ли отображать в интерфейсе виджета чекбокс Соглашаюсь на автоплатежи |
success_return_url | - | string | URL, на который нужно перенаправить пользователя после успешного платежа |
failure_return_url | - | string | URL, на который нужно перенаправить пользователя после ошибки при оплате |
success_on_hold | - | bool | Нужно ли показывать плательщику сообщение об успешном платеже на этапе холдирования. По умолчанию false и виджет показывает экран загрузки до завершения холда. |
AmountDetails
Объект суммы.
Название | Обязательность | Тип | Описание |
---|---|---|---|
amount | + | int | Значение суммы в минорных единицах валюты (в копейках). Если сумма платежа 100 рублей, передавайте 10000 |
currency | + | string | Код валюты согласно ISO 4217. Регистр не важен. Варианты: rub , eur |
BankAccountPaymentMethod
Объект с описанием банковского счета получателя выплаты.
Название | Обязательность | Тип | Описание |
---|---|---|---|
system_type | + | string | Система банковских платежей. Варианты: ru , faster_payment_system , faster_payment_system_verification |
ru | - | BankAccountRU | Счет получателя в российском банке (регион ru) |
faster_payment_system | - | FasterPaymentSystem | Данные получателя в Системе быстрых платежей |
faster_payment_system_verification | - | FasterPaymentSystemVerification | Даные для проверки регистрации получателя в Системе быстрых платежей |
BankAccountRU
Объект с данными банковского счета в российском банке (в регионе ru).
Название | Обязательность | Тип | Описание |
---|---|---|---|
bik | + | string | БИК банка получателя |
account | + | string | Банковский счет получателя |
full_name | + | string | ФИО физического лица. В случае выплаты на счет ИП, передается в следующем формате: ИП <ФИО>. При выплате юридическому лицу — наименование юрлица, если предусмотрено договором. Важно: если наименование или ФИО указано некорректно, банк-получатель может отказать в зачислении и деньги вернутся на счет отправителя. |
description | + | string | Назначение выплаты |
inn | - (обязательно при выплатах на счет юридического лица или ИП) | string | ИНН получателя, 10 цифр для юридических лиц, 12 цифр - для физических, в том числе для ИП. |
kpp | - (обязательно при выплатах на счет юридического лица) | string | KПП получателя, 9 цифр. |
is_fast | - | bool | Показывает, нужно ли проводить срочную выплату (через БЭСП). Срочная выплата проходит в течение часа, обычная — за 1—3 банковских дня. |
BankCard
Объект карты в открытом виде (можно использовать, если у вас есть PCI DSS).
Название | Обязательность | Тип | Описание |
---|---|---|---|
number | + | string | Номер карты |
expiration_month | - | string | Месяц |
expiration_year | - | string | Год |
security_code | - | string | Секретный код CVC |
cardholder_name | - | string | Имя владельца карты |
CardPaymentMethod
Объект с данными банковской карты получателя выплаты.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип передачи данных карты. Возможные варианты: bank_card , encrypted_card |
bank_card | - | BankCard | Карта в открытом виде |
encrypted_card | - | EncryptedCard | Карта с шифрованными полями (токенизированная) |
brand | - | string | Информация о карте. Возвращается в уведомлениях, нужна для отображения пользователям |
last4 | - | string | Информация о карте. Возвращается в уведомлениях, нужна для отображения пользователям |
CardTokenInfo
Объект с данными о токенизированной банковской карте.
Название | Обязательность | Тип | Описание |
---|---|---|---|
number_hash | + | string | Токен (токенизированный номер карты) |
brand | + | string | Платежная система, например visa |
last4 | + | string | Последние 4 цифры номера карты |
ConfirmInformation
Объект с информацией для подтверждения операции по номинальному счету.
Название | Обязательность | Тип | Описание |
---|---|---|---|
transfer_details | + | TransferDetails | Информация о переводе |
Customer
Данные о пользователе (получателе выплаты или отправителе платежа) в вашей системе. Например, логин, по которому вы сможете идентифицировать пользователя, и его контактная информация.
Название | Обязательность | Тип | Описание |
---|---|---|---|
reference | + | string | Идентификатор пользователя (получателя выплаты или отправителя платежа) в вашей системе |
contacts | - | array<CustomerContact> | Список контактов пользователя |
CustomerContact
Контакты пользователя (получателя выплаты или отправителя платежа).
Название | Обязательность | Тип | Описание |
---|---|---|---|
- | string | Электронная почта пользователя | |
phone | - | string | Телефон пользователя |
CustomerInteraction
Объект, описывающий взаимодействие с пользователем.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип взаимодействия с пользователем. Возможные значения: redirect , inform |
redirect | - | CustomerInteractionRedirect | Объект с данными для перенаправления пользователя |
inform | - | CustomerInteractionInform | Объект с информацией о способе платежа |
CustomerInteractionInform
Объект с информацией о способе платежа
Название | Обязательность | Тип | Описание |
---|---|---|---|
qr | - | QRInformInteraction | Объект с QR-кодом для оплаты по СБП |
CustomerInteractionRedirect
Объект с данными для редиректа (перенаправления пользователя).
Название | Обязательность | Тип | Описание |
---|---|---|---|
url | + | string | Адрес для редиректа вместе с GET-параметрами |
base_url | + | string | Адрес для редиректа |
method | + | string | Метод отправки. Например, POST |
qs | - | map<string,string> | Набор GET-параметров для редиректа |
params | - | map<string,*> | Набор параметров для тела сообщения при редиректе |
EncryptedCard
Карта с шифрованными полями (токенизированная). Передается при проведении выплаты или оплаты через виджет.
Название | Обязательность | Тип | Описание |
---|---|---|---|
number_hash | + | string | Хэш номера карты |
expiration_date_hash | - | string | Хэш срока действия |
security_code_hash | - | string | Хэш секретного кода CVC |
cardholder_name_hash | - | string | Хэш имени владельца карты |
Error
Объект с описанием ошибки.
Название | Обязательность | Тип | Описание |
---|---|---|---|
code | - | string | Код ошибки |
description | - | string | Описание ошибки |
FasterPaymentSystem
Объект с данными пользователя Системы быстрых платежей.
Название | Обязательность | Тип | Описание |
---|---|---|---|
phone | + | string | Телефон получателя |
bank_id | + | string | Идентификатор банка получателя в СБП |
description | + | string | Назначение выплаты |
FasterPaymentSystemVerification
Объект с данными для проверки регистрации пользователя в Системе быстрых платежей.
Название | Обязательность | Тип | Описание |
---|---|---|---|
phone | + | string | Телефон получателя |
bank_id | + | string | Идентификатор банка получателя в СБП |
FiscalizationDetails
Объект с данными для фискализации.
Название | Обязательность | Тип | Описание |
---|---|---|---|
professional_income_taxpayer | + | ProfessionalIncomeTaxpayer | Данные для фискализации самозанятого |
FiscalizationReceipt
Объект с данными чека, созданного при фискализации.
Название | Обязательность | Тип | Описание |
---|---|---|---|
id | + | string | Идентификатор чека |
link | - | string | Ссылка на чек |
FiscalizationService
Объект с описанием услуги, за которую отправляется выплата, для фискализации. В одном объекте может содержаться не более 6 услуг.
Название | Обязательность | Тип | Описание |
---|---|---|---|
name | + | string | Название услуги |
amount_details | + | AmountDetails | Цена услуги |
quantity | - | integer | Количество услуг. По умолчанию 1 |
Важно: произведение цены услуги и количества услуг должно быть равно сумме выплаты.
InternalTransferInfo
Объект с информацией о внутреннем переводе.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип перевода. Возможные значения: transfer_from_nominal_account , transfer_from_bank_account |
transfer_from_nominal_account | - | TransferFromNominalAccount | Информация о переводе с номинального счета |
transfer_from_bank_account | - | TransferFromBankAccount | Информация о переводе с расчетного счета |
NominalPaymentParticipant
Данные о плательщике и получателеле выплаты c номинального счета.
Название | Обязательность | Тип | Описание |
---|---|---|---|
account_number | - | string | Номер счета |
name | - | string | ФИО или наименование |
bank_name | - | string | Наименование банка |
bik | - | string | БИК банка |
correspondent_account_number | - | string | Номер корреспондентского счета |
NotificationCountInformation
Объект с количеством непрочитанных самозанятыми оповещений из ФНС.
Название | Обязательность | Тип | Описание |
---|---|---|---|
tax_reference | + | string | ИНН самозанятого |
count | - | int | Количество непрочитанных оповещений для ИНН из параметра tax_reference |
NotificationInformation
Объект с общей информацией самозанятыми оповещений из ФНС.
Название | Обязательность | Тип | Описание |
---|---|---|---|
tax_reference | + | string | ИНН самозанятого |
notifications | - | array<Notifications> | Оповещения для ИНН из tax_reference |
Notifications
Массив с подробной информацией об оповещениях, которые ФНС рассылает самозанятым.
Название | Обязательность | Тип | Описание |
---|---|---|---|
id | + | string | Идентификатор оповещения |
title | + | string | Заголовок оповещения |
message | + | string | Тело оповещения |
status | + | string | Статус оповещения. Возможные варианты: "NEW" — новое "непрочитанное" уведомление; "ACKNOWLEDGED" — прочитанное уведомление; "ARCHIVED" — уведомление, отправленное в архив. |
created_at | + | dateTime | Дата создания оповещения |
Notifications_list
Массив с данными для уведомления ФНС о статусе оповещений для самозанятых.
Название | Обязательность | Тип | Описание |
---|---|---|---|
message_id_list | - | array<string> | Массив с ID оповещений |
tax_reference | + | string | ИНН самозанятого |
Participant
Данные участника выплаты — отправителя или получателя. Набор необходимых данных зависит от способа получения выплаты.
Название | Обязательность | Тип | Описание |
---|---|---|---|
full_name | - (обязательно для Participant.recipient при выплатах на любые карты) | string | Имя |
company_name | - | string | Название компании |
reference | - | string | Идентификатор получателя на вашей стороне |
tax_reference | - | string | Идентификатор налогоплательщика |
beneficiary_id | - (обязательно при платежах и выплатах, у которых есть бенефициар или выгодоприобретатель) | string | ИНН бенефициара или выгодоприобретателя |
country_iso3 | - | string | Страна (ISO-3166-1 alpha-3) |
account | - (обязательно для Participant.sender при выплатах с номинального счета) | string | Номер банковского номинального счета, с которого будет осуществляться выплата. |
ParticipantDetails
Данные об участниках выплаты.
Название | Обязательность | Тип | Описание |
---|---|---|---|
sender | - | Participant | Данные отправителя |
recipient | - | Participant | Данные получателя |
Payment
Объект со всеми данными выплаты.
Название | Обязательность | Тип | Описание |
---|---|---|---|
id | + | string | Идентификатор выплаты |
status | + | string | Статус. Возможные варианты: succeeded , in_progress , pending , failed |
created_at | + | string | Дата создания в формате ISO 8601 |
payment_method | + | PaymentMethod | Способ получения выплаты |
amount_details | + | AmountDetails | Сумма |
finished_at | - | string | Дата завершения в формате ISO 8601 |
customer | - | Customer | Данные получателя в вашей системе. Например, логин, по которому вы сможете идентифицировать получателя на своей стороне |
fiscalization_details | - | FiscalizationDetails | Данные для фискализации |
participant_details | - | ParticipantDetails | Данные об участниках выплаты, которые нужны для ее проведения. Например, имя и адрес отправителя и получателя |
refunds | - | array<Refund> | Список возвратов |
metadata | - | object | Дополнительная информация. Любые данные, которые вам необходимы для проведения операции. Возвращаются в ответах и вебхуках |
error | - | Error | Описание ошибки |
status
)
Статусы выплаты (in_progress
— в обработке;pending
— ожидает вашего подтверждения (confirm_request
) или отмены (cancel_request
);succeeded
— выплата прошла успешно;failed
— выплата не прошла из-за ошибки.
PaymentDetails
Объект с описанием способа проведения платежа.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип способа оплаты. Возможные варианты: card , recurrent , internal_transfer , secured_card , faster_payment_system |
card | - | CardPaymentMethod | Данные банковской карты |
recurrent | - | RecurrentTokenInfo | Данные для повтора платежа по токену |
internal_transfer | - | InternalTransferInfo | Данные для внутреннего перевода |
faster_payment_system | - | Платеж через СБП |
PaymentMethod
Объект с описанием способа получения выплаты.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип способа получения выплаты. Возможные варианты: card , bank_account , wallet |
card | - | CardPaymentMethod | Банковская карта получателя |
bank_account | - | BankAccountPaymentMethod | Банковский счет получателя |
wallet | - | WalletPaymentMethod | Электронный кошелек получателя |
tax | - | TaxPaymentMethod | Платежи в налоговую |
PaymentOptions
Параметры для проведения платежа.
Название | Обязательность | Тип | Описание |
---|---|---|---|
return_url | - | string | URL, на который нужно перенаправить пользователя после проведения платежа. URL должен быть валидным. |
recurrent | - | bool | Нужно ли провести платеж с помощью сохраненного токена |
expiration_at | - | datetimeimmutable | Кастомное время жизни инвойса, актуально только для кошельков QIWI. Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС |
PaymentSession
Контейнер с данными о всех операциях, которые проводились в рамках одной платежной сессии.
Сессия необходима для проведения платежных операций. В рамках сессии может проходить одна или несколько операций одного или разных типов (например, несколько выплат, платеж и возврат, оплата с последующим разделением платежей).
Название | Обязательность | Тип | Описание |
---|---|---|---|
id | + | string | Идентификатор сессии |
status | + | string | Статус. Возможные значения: created , in_progress , accepted , cancelled , error |
created_at | + | string | Дата создания в формате ISO 8601 |
updated_at | + | string | Дата обновления в формате ISO 8601 |
payments | - | array<Payment> | Список выплат, которые проводились в рамках этой сессии |
acquiring_payments | - | array<AcquiringPayment> | Список платежей, которые проводились в рамках этой сессии |
next_action | - | string | Метка, указывающая на действия для успешного прохождения транзакции. Возможные значения: confirm , capture |
error | - | Error | Описание ошибки |
status
)
Статусы платежной сессии (created
— cессия создана, ожидает старта или отмены;in_progress
— в обработке;accepted
— успешно завершена;cancelled
— отменена;error
— в процессе работы произошла непредвиденная ошибка. Финальный статус неизвестен. Необходимо обратиться в поддержку Банка 131.
next_action
)
Дальнейшие действия (Если это поле не пустое, значит, Банк 131 ждет от вас определенных действий, чтобы продолжить операцию:
- confirm — вам нужно подтвердить операцию (
confirm_request
) или отменить ее (cancel_request
); - capture — вам нужно провести списание (
session/capture
) или отменить его (cancel_request
).
ProfessionalIncomeTaxpayer
Объект с данными для фискализации самозанятого.
Название | Обязательность | Тип | Описание |
---|---|---|---|
services | + | array<FiscalizationService> | Список оказанных услуг (не более 6) |
tax_reference | + | string | ИНН самозанятого |
receipt | - | FiscalizationReceipt | Фискальный чек. Возвращается в уведомлениях |
payer_type | - | string | Тип плательщика (тот, кто платит самозанятому). Возможные варианты: legal , individual , foreign |
payer_tax_number | - | string | ИНН плательщика. Обязателен для payer_type: legal |
payer_name | - | string | Имя или название плательщика. Обязателен для payer_type: legal |
payer_type
Тип плательщика Тип плательщика. Возможные варианты:
legal
— юридическое лицо;individual
— физическое лицо;foreign
— нерезидент РФ.
PublicToken
Объект с информацией о публичном токене.
Название | Обязательность | Тип | Описание |
---|---|---|---|
token | + | string | Токен |
PublicTokenInfo
Объект с информацией о публичном токене.
Название | Обязательность | Тип | Описание |
---|---|---|---|
token | + | string | Токен |
created_at | + | string | Дата создания в формате ISO 8601 |
finished_at | + | string | Дата завершения в формате ISO 8601 |
is_active | + | bool | Можно ли проводить операции по этому токену: true — можно, false — нельзя |
QiwiWalletPaymentMethod
Объект с данными кошелька QIWI.
Название | Обязательность | Тип | Описание |
---|---|---|---|
account | + | string | Идентификатор кошелька QIWI — номер телефона его владельца в международном формате (без плюса). Пример: 79210010203 |
description | - | string | Назначение платежа, до 1000 символов (если будет больше, операция не пройдет) |
QRInformInteraction
Объект, в котором содержится QR-код для оплаты по СБП
Название | Обязательность | Тип | Описание |
---|---|---|---|
content | + | string | Ссылка на QR-код |
img | + | string | Содержимое QR-кода |
RecurrentToken
Объект с информацией о рекуррентном токене.
Название | Обязательность | Тип | Описание |
---|---|---|---|
token | + | string | Токен |
RecurrentTokenInfo
Объект с информацией о рекуррентном токене. Подробнее о рекуррентных платежах и настройках токена здесь.
Название | Обязательность | Тип | Описание |
---|---|---|---|
token | + | string | Токен |
created_at | + | string | Дата создания в формате ISO 8601. |
finished_at | + | string | Дата завершения в формате ISO 8601. Не обрабатывается Банком и не влияет на срок действия токена. |
is_active | + | bool | Можно ли проводить операции по этому токену: true — можно, false — нельзя |
Refund
Объект с информацией о возврате.
Название | Обязательность | Тип | Описание |
---|---|---|---|
id | + | string | Уникальный идентификатор возврата |
status | + | string | Статус возврата. Возможные значения: in_progress , accepted , declined , error |
amount_details | + | AmountDetails | Объект с суммой возврата |
created_at | + | string | Дата создания |
finished_at | - | string | Дата завершения |
is_chargeback | - | bool | Показывает, совершен ли возврат в рамках чарджбека |
status
)
Статусы возврата (in_progress
— в обработке;accepted
— возврат прошел успешно;declined
— Банк 131 отклонил возврат;error
— возврат не прошел из-за ошибки.
SelfEmployedWidgetMetadata
Объект с настройками виджета для привязки самозанятого к Банку 131.
Название | Обязательность | Тип | Описание |
---|---|---|---|
tax_reference | + | string | ИНН самозанятого |
TaxDetails
Объект с данными для платежей в налоговую.
Название | Обязательность | Тип | Описание |
---|---|---|---|
period | - (Обязательно для выплаты с расширенным набором параметров) | string | Период. Формат ввода описан ниже |
kbk | - (Обязательно для выплаты с расширенным набором параметров) | string | Код бюджетной классификации, 20 цифр |
oktmo | - (Обязательно для выплаты с расширенным набором параметров) | string | Общероссийский классификатор территорий муниципальных образований, 8 или 11 цифр |
payment_reason | - (Обязательно для выплаты с расширенным набором параметров) | string | Основание платежа. Формат ввода описан ниже. |
document_number | - (Обязательно для выплаты с расширенным набором параметров) | string | Номер документа. Формат ввода описан ниже. |
document_date | - (Обязательно для выплаты с расширенным набором параметров) | string | Дата документа. Формат ввода описан ниже. |
Формат ввода для поля period при запросе с расширенным набором параметров
- Если в поле
payment_reason
указано «ТП» или «ЗД», то указывается периодичность уплаты налога, установленная законодательно, в одном из нижеприведенных форматов:- для ежемесячных уплат: «МС.ХХ.ГГГГ», где ХХ – номер месяца (от 01 до 12), а ГГГГ – год, за который производится платеж (например, при уплате НДФЛ с зарплаты работников за февраль 2020 г. нужно проставить «МС.02.2020»);
- для налогов, уплачиваемых ежеквартально: «КВ.ХХ.ГГГГ», где ХХ – номер квартала (от 01 до 04), ГГГГ – год, за который уплачивается налог;
- для полугодовых налогов (к примеру, ЕСХН): «ПЛ.ХХ.ГГГГ», где ХХ – номер полугодия (01 или 02), ГГГГ – год, за который перечисляется налог;
- для годовых платежей: «ГД.00.ГГГГ», где ГГГГ – год, за который уплачивается налог (например, производя окончательный расчет по налогу на прибыль за 2019 год, нужно будет поставить «ГД.00.2019»).
- Если в поле
payment_reason
стоит «ТР», то отражается дата требования. - Если в поле
payment_reason
стоит «АП», то ставится «0».
Формат ввода для поля payment_reason при запросе с расширенным набором параметров
- «ТП» — при уплате налога/взноса за текущий период;
- ЗД» — при добровольном погашении задолженности по налогам/взносам;
- «ТР» — при погашении задолженности по выставленному требованию ИФНС или ФСС;
- «АП» — при погашении задолженности по акту проверки (до выставления требования).
Формат ввода для поля document_number при запросе с расширенным набором параметров
- Если в поле
payment_reason
стоит «ТП» или «ЗД», то «0».- Если в поле
payment_reason
стоит «ТР», то номер налогового требования об уплате. - Если в поле
payment_reason
стоит «АП», то номер решения, вынесенного по результатам проверки.
- Если в поле
Формат ввода для поля document_date при запросе с расширенным набором параметров
- Если Если в поле
payment_reason
стоит «ТП», то дата подписания декларации или «0», если дата не указана. - Если в поле
payment_reason
стоит «ЗД», то «0». - Если в поле
payment_reason
стоит «ТР», то дата требования об уплате. - Если в поле
payment_reason
стоит «АП», то дата послепроверочного решения.
TaxFull
Объект с данными для уплаты налогов с расширенным набором полей.
Название | Обязательность | Тип | Описание |
---|---|---|---|
uin | + | string | Уникальный идентификатор начисления. Для платежей в налоговую всегда 0 . |
description | + | string | Назначение выплаты |
tax_details | + | string | Данные о платеже в налоговую |
payer | + | TaxPayer | Данные отправителя для платежа в налоговую |
payee | + | TaxPayee | Данные получателя для платежа в налоговую |
TaxPaymentMethod
Объект с данными для уплаты налогов.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип налога или способ оплаты. Варианты: tax_short , tax_full |
tax_full | + | TaxFull | Данные для платежей в налоговую с расширенным набором параметров |
tax_details | - (необходимо для выплаты с минимальным набором полей) | TaxDetails | Данные для платежей в налоговую с минимальным набором полей |
TaxPeriod
Объект с данными для описания периода, за который нужно перечислить платеж в налоговую.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип периода. Варианты: month (налог за месяц), quarter (налог за квартал) |
number | + | number | Зависит от типа периода. Для month — номер месяца (от 1 до 12), для quarter — номер квартала (от 1 до 4) |
year | + | string | Год, 4 цифры. Пример: 2021 |
TaxRuPayee
Объект с данными получателя для платежей в налоговую с расширенными параметрами.
Название | Обязательность | Тип | Описание |
---|---|---|---|
bik | + | string | БИК банка получателя |
account | + | string | Номер счета |
account_eks | + | string | Единый казначейский счет |
name | + | string | Наименование получателя |
inn | + | string | ИНН получателя, 10 цифр. |
TaxRuPayer
Объект с данными отправителя для платежей в налоговую с расширенными параметрами.
Название | Обязательность | Тип | Описание |
---|---|---|---|
kpp | + | string | KПП отправителя, 9 цифр. |
inn | + | string | ИНН получателя, 10 цифр. |
TokenizeWidgetMetadata
Объект с настройками для виджета токенизации.
Название | Обязательность | Тип | Описание |
---|---|---|---|
access | + | bool | Может ли этот публичный ключ использовать виджет токенизации |
TransferDetails
Объект с информацией о переводе.
Название | Обязательность | Тип | Описание |
---|---|---|---|
payment_method | + | CardPaymentMethod | Способ получения выплаты. |
customer | + | NominalPaymentParticipant | Информация о плательщике |
recipient | + | NominalPaymentParticipant | Информация о получателе |
purpose | + | string | Назначение выплаты в следующем формате: <описание>; card:<маска карты> |
amount | + | AmountDetails | Сумма |
TransferFromBankAccount
Объект с информацией о переводе с расчетного счета.
Название | Обязательность | Тип | Описание |
---|---|---|---|
description | + | string | Описание |
TransferFromNominalAccount
Объект с информацией о переводе с номинального счета.
Название | Обязательность | Тип | Описание |
---|---|---|---|
description | + | string | Описание |
WalletDetails
Данные о вашем балансе (счете обеспечения) для отправки выплат.
Название | Обязательность | Тип | Описание |
---|---|---|---|
id | + | string | Идентификатор баланса |
amount_details | + | AmountDetails | Текущий баланс |
WalletPaymentMethod
Объект с данными электронного кошелька.
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип кошелька. Возможные значения: qiwi , yoomoney |
qiwi | - | QiwiWalletPaymentMethod | Данные кошелька QIWI |
yoomoney | - | YooMoneyWalletPaymentMethod | Данные кошелька ЮMoney (Яндекс.Деньги) |
YooMoneyWalletPaymentMethod
Объект с данными кошелька ЮMoney (Яндекс.Деньги).
Название | Обязательность | Тип | Описание |
---|---|---|---|
account | + | string | Номер кошелька ЮMoney, 11–20 цифр. Пример: 4100175017397 |
description | - | string | Назначение платежа, максимум 128 символов. Если будет больше, операция не пройдет |
Amounts
Объект с подробными данными суммы к оплате.
Название | Обязательность | Тип | Описание |
---|---|---|---|
net | Net | Сумма после уплаты комиссии | |
gross | Gross | Сумма до уплаты комиссии |
Net
Объект с суммой платежа после уплаты комиссии и валютой платежа.
Название | Обязательность | Тип | Описание |
---|---|---|---|
amount | + | int | Значение суммы в минорных единицах валюты (в копейках). Если сумма платежа 100 рублей, передавайте 10000 |
currency | + | string | Код валюты согласно ISO 4217. Регистр не важен. Варианты: rub |
Gross
Объект с суммой платежа до уплаты комиссии и валютой платежа.
Название | Обязательность | Тип | Описание |
---|---|---|---|
amount | + | int | Значение суммы в минорных единицах валюты (в копейках). Если сумма платежа 100 рублей, передавайте 10000 |
currency | + | string | Код валюты согласно ISO 4217. Регистр не важен. Варианты: rub |