Перейти к основному содержимому

Объекты

accept_code​

Данные для отправки кода.

НазваниеОбязательностьТипОписание
rest_of_attempts+stringКоличество попыток ввода кода
active_to+stringКак долго будет активен код
callback_url+stringАдрес, на который надо послать код от плательщика

account_details​

Информация о счетах отправителя и получателя.

НазваниеОбязательностьТипОписание
sender+objectИнформация о счете отправителя
recipient+objectИнформация о счете получателя

account_statement​

Детали выписки.

НазваниеОбязательностьТипОписание
date_from+dateДата начала выписки
date_to+dateДата окончания выписки
account_number+stringНомер счёта (20 цифр), по которому сформирована выписка
total_turnover-objectИнформация по движению средств
total_balance-objectИнформация по балансу
transactions-objectСписок транзакций

acquiring_payments​

Массив со всеми данными платежа.

НазваниеОбязательностьТипОписание
id+stringУникальный идентификатор платежа
status+stringСтатус платежа. Возможные варианты: succeeded, in_progress, pending, failed
created_at+stringДата создания в формате ISO 8601
payment_details+objectПлатежные данные
amount_details+objectСумма
amounts-objectКомиссия за операцию
finished_at-stringДата завершения в формате ISO 8601
customer+objectДанные пользователя (отправителя платежа)
recurrent-objectДанные для проведения повторного платежа
participant_details-objectДанные об участниках
refunds-arrayСписок возвратов
customer_interaction-objectДанные для взаимодействия с пользователем
transaction_info-objectДанные о транзакции
metadata-objectДополнительная информация. Любые данные, которые вам необходимы для проведения операции. Возвращаются в ответах и вебхуках
error-objectОписание ошибки
 

Статусы платежа (status)​

  • in_progress — в обработке.
  • pending — ожидает вашего подтверждения (session/confirm) или отмены (session/cancel).
  • succeeded — оплата прошла успешно.
  • failed — оплата не прошла из-за ошибки.

acquiring_widget​

Настройки виджета платежной формы: для проведения платежей банковской картой.

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии, по которой будет производиться оплата
show_recurrent_checkbox-boolНужно ли отображать в интерфейсе виджета чекбокс Соглашаюсь на автоплатежи
success_return_url-stringURL, на который нужно перенаправить пользователя после успешного платежа
failure_return_url-stringURL, на который нужно перенаправить пользователя после ошибки при оплате
success_on_hold-boolНужно ли показывать плательщику сообщение об успешном платеже на этапе холдирования. По умолчанию false и виджет показывает экран загрузки до завершения холда
redirect_target-stringПравило, как будет открываться ссылка при редиректе после платежа:
- top — поверх всех фреймов,
- self — в том же фрейме,
- parent — во фрейме выше уровнем, если фреймы вложены один в другой.
Значение по умолчанию: top

amount​

Информация о сумме.

НазваниеОбязательностьТипОписание
amount+intЗначение суммы в минорных единицах валюты (в копейках). Чтобы передать 100 рублей, укажите 10000
currency+stringКод валюты согласно ISO 4217. Регистр не важен. Варианты: rub, eur

amount_details​

Информация о сумме.

НазваниеОбязательностьТипОписание
amount+intЗначение суммы в минорных единицах валюты (в копейках). Чтобы передать 100 рублей, укажите 10000
currency+stringКод валюты согласно ISO 4217. Регистр не важен. Варианты: rub, eur

amounts​

Информация о комиссии за транзакцию.

НазваниеОбязательностьТипОписание
fee-objectДанные о взимаемой комиссии

balance​

Информация о балансе счета.

НазваниеОбязательностьТипОписание
current_balance-stringТекущий остаток по счету (Может быть положительным или равным 0). Значение указывается в минорных единицах валюты (в копейках). Если баланс 100 рублей, передается 10000

bank_account​

Описание банковского счета получателя выплаты.

НазваниеОбязательностьТипОписание
system_type+stringСистема банковских платежей. Варианты: ru, faster_payment_system, faster_payment_system_verification
ru- (обязателен для system_type = ru)objectСчет получателя в российском банке (регион ru)
faster_payment_system- (обязателен для system_type = faster_payment_system)objectДанные получателя в Системе быстрых платежей
faster_payment_system_verification- (обязателен для system_type = faster_payment_system_verification)objectДанные для проверки регистрации получателя в Системе быстрых платежей

bank_account_ru​

Данные банковского счета.

НазваниеОбязательностьТипОписание
bik- (обязательно для метода /api/v1/tokenize)stringБИК банка получателя
account- (обязательно для метода /api/v1/tokenize)stringБанковский счет получателя
token- (обязательно для метода /api/v1/token/info)stringТокен банковского счета

bank_card​

Объект карты в открытом виде.

НазваниеОбязательностьТипОписание
number+stringНомер карты
expiration_month- (обязателен для приема платежей при наличии на карте)stringМесяц
expiration_year- (обязателен для приема платежей при наличии на карте)stringГод
security_code- (обязателен для приема платежей при наличии на карте)stringСекретный код CVC
cardholder_name-stringИмя владельца карты

card​

Данные банковской карты получателя выплаты.

НазваниеОбязательностьТипОписание
type+stringТип передачи данных карты. Возможные варианты: bank_card, encrypted_card, tokenized_card
bank_card- (обязателен для type = bank_card)objectКарта в открытом виде
encrypted_card- (обязателен для type = encrypted_card)objectКарта с шифрованными полями (токенизированная)
tokenized_card- (обязателен для type = tokenized_card)objectТокенизированный номер карты
brand-stringИнформация о карте. Возвращается в уведомлениях, нужна для отображения пользователям
last4-stringИнформация о карте. Возвращается в уведомлениях, нужна для отображения пользователям
bin-stringБанковский идентификационный номер (БИН) (первые шесть цифр номера карты)
card_id-stringСквозной идентификатор карты

card_elements​

Данные банковской карты для токенизации.

НазваниеОбязательностьТипОписание
ref+stringФиксированное значение, всегда number
type+stringФиксированное значение, всегда card_number

cash_details​

Данные банковской карты для токенизации.

НазваниеОбязательностьТипОписание
shift+stringНомер кассовой смены

confirm_information​

Информация для подтверждения операции по номинальному счету.

НазваниеОбязательностьТипОписание
transfer_details+ (для выплат на карты)objectИнформация о переводе
account_details+ (для выплат на счета)objectИнформация о счетах отправителя и получателя

contacts​

Массив с контактами пользователя (получателя выплаты или отправителя платежа).

Входит в объекты: customer.

НазваниеОбязательностьТипОписание
email-stringЭлектронная почта пользователя
phone-stringТелефон пользователя

contacts (для денежных переводов)​

Контакты пользователя (отправителя или получателя денежного перевода).

Входит в объекты: sender, recipient.

НазваниеОбязательностьТипОписание
email-stringЭлектронная почта пользователя
phone-objectДанные телефона пользователя

counter_party​

Информация о контрагенте.

НазваниеОбязательностьТипОписание
kpp-stringКПП контрагента
inn-stringИНН контрагента
name+stringНаименование контрагента
account_number+stringНомер счета контрагента
bank_code+stringБИК банка контрагента

customer (пользователь в системе)​

Данные о пользователе (получателе выплаты или отправителе платежа) в вашей системе. Например, логин, по которому вы сможете идентифицировать пользователя, и его контактная информация.

Входит в объекты: acquiring_payments, payments.

НазваниеОбязательностьТипОписание
reference+stringИдентификатор пользователя (получателя выплаты или отправителя платежа) в вашей системе (до 128 символов)
contacts-arrayСписок контактов пользователя

customer (плательщик)​

Данные о плательщике выплаты c номинального счета.

Входит в объекты: transfer_details.

НазваниеОбязательностьТипОписание
account_number-stringНомер счета
name-stringФИО или наименование
bank_name-stringНаименование банка
bik-stringБИК банка
correspondent_account_number-stringНомер корреспондентского счета
inn-stringИНН банка (только для РКО)
kpp-stringКПП банка (только для РКО)

customer_authorization​

Информация, необходимая при платежах картами Humo/Uzcard.

НазваниеОбязательностьТипОписание
type+stringТип аутентификации. Всегда: sms
suspend_key+stringКлюч для подтверждения при отправке кода
accept_code+objectДанные для отправки кода
resend_sms+objectДанные для запроса нового кода

customer_interaction​

Объект, описывающий взаимодействие с пользователем.

НазваниеОбязательностьТипОписание
type+stringТип взаимодействия с пользователем. Возможные значения: redirect, inform
redirect- (обязателен для type = redirect)objectДанные для перенаправления пользователя
inform- (обязателен для type = inform)objectИнформация о способе платежа

data (счет пользователя)​

Маскированный счет пользователя.

НазваниеОбязательностьТипОписание
masked_account+stringПервые 5 и последние 4 цифры счета

data (токен и номер карты)​

Токен и токенизированный номер карты.

Возвращается в ответ на запрос tokenize/elements.

НазваниеОбязательностьТипОписание
number+objectДанные о токене

documents_foreigner​

Параметры документа отправителя-нерезидента.

НазваниеОбязательностьТипОписание
id_type+stringТип документа, удостоверяющего личность отправителя-нерезидента. Возможные значения:
- Вид на жительство,
- Разрешение на временное проживание,
- Миграционная карта,
- Виза
issued_by-stringНазвание органа, выдавшего документ, удостоверяющий личность отправителя-нерезидента
issue_date+stringДата начала срока действия документа, удостоверяющего личность отправителя-нерезидента, в формате ГГГГ-ММ-ДД
id_expiration_date+stringДата окончания срока действия документа, удостоверяющего личность отправителя-нерезидента, в формате ГГГГ-ММ-ДД

encrypted_card​

Карта с шифрованными полями (токенизированная). Передается при проведении выплаты или оплаты через виджет.

НазваниеОбязательностьТипОписание
number_hash+stringХэш номера карты
expiration_date_hash-stringХэш срока действия
security_code_hash-stringХэш секретного кода CVC
cardholder_name_hash-stringХэш имени владельца карты

error​

Описание ошибки.

НазваниеОбязательностьТипОписание
code-stringКод ошибки
description-stringОписание ошибки

Коды ошибок

faster_payment_system​

Данные пользователя Системы быстрых платежей.

НазваниеОбязательностьТипОписание
phone+stringТелефон получателя
bank_id+stringИдентификатор банка получателя в СБП. Чтобы получить идентификатор, используйте метод fps/banks
description+stringНазначение выплаты

faster_payment_system_verification​

Данные для проверки регистрации пользователя в Системе быстрых платежей.

НазваниеОбязательностьТипОписание
phone+stringТелефон получателя
bank_id+stringИдентификатор банка получателя в СБП. Чтобы получить идентификатор, используйте метод fps/banks

fee​

Информация о взимаемой комиссии. Количество объектов соответствует количеству применяемых комиссий.

НазваниеОбязательностьТипОписание
amount+intЗначение суммы в минорных единицах валюты (в копейках). Чтобы передать 100 рублей, укажите 10000
currency+stringКод валюты согласно ISO 4217. Регистр не важен. Варианты: rub, eur

fiscalization_details​

Данные для фискализации.

НазваниеОбязательностьТипОписание
professional_income_taxpayer+objectДанные для фискализации самозанятого

identity_document​

Данные документа, удостоверяющего личность отправителя денежного перевода.

НазваниеОбязательностьТипОписание
id_type+stringТип документа, удостоверяющего личность отправителя. Возможные значения:
- Паспорт иностранного гражданина
- Паспорт гражданина Российской Федерации
id_number+stringСерия и номер документа, удостоверяющего личность отправителя (без пробелов)
issue_date+stringДата выдачи документа, удостоверяющего личность отправителя, в формате ГГГГ-ММ-ДД
id_expiration_date-stringДата окончания срока действия документа, удостоверяющего личность отправителя, в формате ГГГГ-ММ-ДД. Обязательно для заполнения при наличии в документе. Если его нет, просто не передавайте это поле
division_code-stringКод подразделения, выдавшего документ, удостоверяющий личность отправителя. Обязательно для заполнения при наличии в документе
issued_by-stringНазвание подразделения, выдавшего документ, удостоверяющий личность отправителя. Обязательно для заполнения при наличии в документе

info (токен банковского счета)​

Информация о токене банковского счета.

НазваниеОбязательностьТипОписание
created_at+stringДата создания в формате ISO 8601
finished_at+stringДата завершения в формате ISO 8601
masked_account+stringМаскированный банковский счет
type+stringВид токена. Всегда: bank_account_ru

info (токенизированная карта)​

Данные о токенизированной банковской карте.

НазваниеОбязательностьТипОписание
number_hash+stringТокен (токенизированный номер карты)
brand+stringПлатежная система, например visa
last4+stringПоследние 4 цифры номера карты
type+stringВид токена. Всегда: card

info (количество оповещений ФНС)​

Количество непрочитанных самозанятыми оповещений из ФНС.

НазваниеОбязательностьТипОписание
tax_reference+stringИНН самозанятого
count-intКоличество непрочитанных оповещений для ИНН из параметра tax_reference

info (данные об оповещениях ФНС)​

Информация об оповещениях, которые ФНС рассылает самозанятым.

НазваниеОбязательностьТипОписание
tax_reference+stringИНН самозанятого
notifications-arrayОповещения для ИНН из tax_reference

info (публичный токен)​

Информация о публичном токене.

НазваниеОбязательностьТипОписание
token+stringТокен
created_at+stringДата создания в формате ISO 8601
finished_at+stringДата завершения в формате ISO 8601
is_active+boolМожно ли проводить операции по этому токену: true — можно,  false — нельзя
type+stringВид токена. Всегда: public_token

info (токен для рекуррентных платежей и выплат)​

Информация о токене для рекуррентных платежей и выплат. Подробнее о рекуррентных платежах и настройках токена.

Возвращается в ответ на запрос token/info.

НазваниеОбязательностьТипОписание
token+stringТокен
created_at+stringДата создания в формате ISO 8601
finished_at+stringДата завершения в формате ISO 8601. Не обрабатывается Банком и не влияет на срок действия токена
is_active+boolМожно ли проводить операции по этому токену: true — можно,  false — нельзя
initiator-stringВид рекуррентного платежа. Возможные значения: merchant — платеж MIT (по умолчанию), client — платеж CIT
type+stringВид токена. Всегда: recurrent_token

info (данные токенизированной карты)​

Данные токенизированной карты. Возвращается в ответ на запрос tokenize/elements.

Входит в объекты: number.

НазваниеОбязательностьТипОписание
masked_card_number+stringМаскированный номер карты
card_network+stringПлатежная система карты
card_type+stringТип карты

inform​

Информация о способе платежа.

НазваниеОбязательностьТипОписание
qr-objectQR-код для оплаты по СБП

internal_transfer​

Информация о внутреннем переводе.

НазваниеОбязательностьТипОписание
type+stringТип перевода. Возможные значения: transfer_from_nominal_account, transfer_from_bank_account
transfer_from_nominal_account- (обязателен для type = transfer_from_nominal_account)objectИнформация о переводе с номинального счета
transfer_from_bank_account- (обязателен для type = transfer_from_bank_account)objectИнформация о переводе с расчетного счета

internet_banking​

Информация об оплате через платежные системы.

НазваниеОбязательностьТипОписание
type+stringПлатежная система. Возможные значения: sber_pay
sber_pay+objectИнформация об оплате через SberPay

method​

Информация о методе.

НазваниеОбязательностьТипОписание
name+stringНазвание метода account_statement
account_statement+objectДетали выписки

notification_list​

Массив с данными для уведомления ФНС о статусе оповещений для самозанятых.

НазваниеОбязательностьТипОписание
message_id_list-array[string]Массив с ID оповещений
tax_reference+stringИНН самозанятого

notifications​

Массив с подробной информацией об оповещениях, которые ФНС рассылает самозанятым.

НазваниеОбязательностьТипОписание
id+stringИдентификатор оповещения
title+stringЗаголовок оповещения
message+stringТело оповещения
status+stringСтатус оповещения. Возможные варианты:
NEW — новое «непрочитанное» уведомление;
ACKNOWLEDGED — прочитанное уведомление;
ARCHIVED — уведомление, отправленное в архив
created_at+dateTimeДата создания оповещения

number​

Токен и данные токенизированной карты.

НазваниеОбязательностьТипОписание
token+stringТокен
info+objectДанные о карте

participant_details​

Данные об участниках выплаты.

НазваниеОбязательностьТипОписание
sender-objectДанные отправителя
recipient-objectДанные получателя

payee​

Данные получателя для платежей в налоговую с расширенными параметрами.

НазваниеОбязательностьТипОписание
bik+stringБИК банка получателя
account+stringНомер счета
account_eks+stringЕдиный казначейский счет
name+stringНаименование получателя
inn+stringИНН получателя, 10 цифр

payer​

Данные отправителя для платежей в налоговую с расширенными параметрами.

НазваниеОбязательностьТипОписание
kpp+stringКПП отправителя, 9 цифр
inn+stringИНН получателя, 10 цифр

payment_details​

Описание способа проведения платежа.

НазваниеОбязательностьТипОписание
type+stringТип способа оплаты. Возможные варианты: card, recurrent, internal_transfer, faster_payment_system, wallet, moneysend
card- (обязателен для type = card)objectДанные банковской карты
recurrent- (обязателен для type = recurrent)objectДанные для повтора платежа по токену
internal_transfer- (обязателен для type = internal_transfer)objectДанные для внутреннего перевода
faster_payment_system- (обязателен для type = faster_payment_system)objectПлатеж через СБП
wallet- (обязателен для type = wallet)objectПлатеж через кошелек
moneysend- (обязателен для type = moneysend)objectДанные для платежа через Moneysend

payment_method​

Описание способа получения выплаты.

НазваниеОбязательностьТипОписание
type+stringТип способа получения выплаты. Возможные варианты: card, bank_account, wallet, tax , recurrent, tokenized_card, moneysend
card- (обязателен для type = card)objectБанковская карта получателя
bank_account- (обязателен для type = bank_account)objectБанковский счет получателя
wallet- (обязателен для type = wallet)objectЭлектронный кошелек получателя
tax- (обязателен для type = tax)objectВыплата в налоговую
recurrent- (обязателен для type = recurrent)objectВыплата с использованием токена
tokenized_card- (обязателен для type = tokenized_card)objectВыплата с использованием токенизированного номера карты
moneysend- (обязателен для type = moneysend)objectДанные для платежа через Moneysend

payment_options​

Параметры для проведения платежа.

НазваниеОбязательностьТипОписание
return_url-stringURL, на который нужно перенаправить пользователя после проведения платежа. URL должен быть валидным
recurrent-boolНужно ли провести платеж с помощью сохраненного токена

payments​

Массив с данными выплаты.

НазваниеОбязательностьТипОписание
id+stringИдентификатор выплаты
status+stringСтатус. Возможные варианты: succeeded, in_progress, pending, failed
created_at+stringДата создания в формате ISO 8601
finished_at-stringДата завершения в формате ISO 8601
customer-objectДанные получателя в вашей системе. Например, логин, по которому вы сможете идентифицировать получателя на своей стороне
payment_method+objectСпособ получения выплаты
amount_details+objectСумма
amounts-objectКомиссия за операцию
fiscalization_details-objectДанные для фискализации
participant_details-objectДанные об участниках выплаты, которые нужны для ее проведения. Например, имя и адрес отправителя и получателя
refunds-arrayСписок возвратов
transaction_info-objectДанные о транзакции
metadata-objectДополнительная информация. Любые данные, которые вам необходимы для проведения операции. Возвращаются в ответах и вебхуках
error-objectОписание ошибки
 

Статусы выплаты (status)​

  • in_progress — в обработке.
  • pending — ожидает вашего подтверждения (session/confirm) или отмены (session/cancel).
  • succeeded — выплата прошла успешно.
  • failed — выплата не прошла из-за ошибки.

period​

Данные для описания периода, за который нужно перечислить платеж в налоговую.

НазваниеОбязательностьТипОписание
type+stringТип периода. Варианты: month (налог за месяц), quarter (налог за квартал)
number+numberЗависит от типа периода. Для month — номер месяца (от 1 до 12), для quarter — номер квартала (от 1 до 4)
year+stringГод, 4 цифры. Пример: 2021

phone​

Номер телефона пользователя (получателя или отправителя денежного перевода).

НазваниеОбязательностьТипОписание
full_number+stringПолный номер телефона пользователя в формате +<код страны><номер>
country_iso3+stringКод страны, к которой относится номер телефона пользователя (ISO 3166-1 alpha-3)
operator_code+stringКод оператора телефонного номера пользователя
short_number+stringНомер телефона пользователя без кода оператора

professional_income_taxpayer​

Данные для фискализации самозанятого.

НазваниеОбязательностьТипОписание
services+arrayСписок оказанных услуг (не более 6)
tax_reference+stringИНН самозанятого
receipt-objectФискальный чек. Возвращается в уведомлениях
payer_type-stringТип плательщика (тот, кто платит самозанятому). Возможные варианты: legal, individual, foreign
payer_tax_number- (обязателен для payer_type = legal)stringИНН плательщика
payer_name- (обязателен для payer_type = legal)stringИмя или название плательщика

 Тип плательщика payer_type​

Тип плательщика. Возможные варианты:

  • legal — юридическое лицо,
  • individual — физическое лицо,
  • foreign — нерезидент РФ.

public_token​

Информация о публичном токене.

НазваниеОбязательностьТипОписание
token+stringТокен

qr​

QR-код для оплаты по СБП.

НазваниеОбязательностьТипОписание
content+stringСсылка на QR-код
img+stringСодержимое QR-кода

receipt​

Данные чека, созданного при фискализации.

НазваниеОбязательностьТипОписание
id+stringИдентификатор чека
link-stringСсылка на чек

recipient (получатель выплаты с номинального счета)​

Данные о получателе выплаты c номинального счета.

Входит в объекты: transfer_details.

НазваниеОбязательностьТипОписание
account_number-stringНомер счета
name-stringФИО или наименование
bank_name-stringНаименование банка
bik-stringБИК банка
correspondent_account_number-stringНомер корреспондентского счета
inn-stringИНН банка (только для РКО)
kpp-stringКПП банка (только для РКО)

recipient (данные получателя выплаты)​

Данные получателя выплаты. Набор необходимых данных зависит от способа получения выплаты.

Входит в объекты: participant_details.

НазваниеОбязательностьТипОписание
full_name- (обязательно при выплатах на любые карты)stringПолное имя
first_name-stringИмя
last_name-stringФамилия
middle_name-stringОтчество
company_name-stringНазвание компании
reference-stringИдентификатор получателя на вашей стороне
tax_reference-stringИдентификатор налогоплательщика
beneficiary_id- (обязательно при платежах и выплатах, у которых есть бенефициар или выгодоприобретатель)stringИНН бенефициара или выгодоприобретателя
country_iso3-stringСтрана (ISO 3166-1 alpha-3)
account-stringНомер банковского номинального счета, с которого будет осуществляться выплата
date_of_birth-stringДата рождения получателя в формате ГГГГ-ММ-ДД. Убедитесь, что возраст получателя 18+
currency+ (Обязательно при денежном переводе)stringВалюта выплаты. Возможные значения: TRY, USD
contacts- (обязательно при денежном переводе)objectКонтакты получателя

recurrent (токен для рекуррентных платежей и выплат)​

Токен для рекуррентных платежей и выплат.

Входит в объекты: payment_method.

При каждом новом платеже одной и той же картой генерируется новый рекуррентный токен. Он привязан не к карте, а к платежу. Если нужно идентифицировать карту, можно использовать сквозной идентификатор карты.

НазваниеОбязательностьТипОписание
token+stringТокен

recurrent (информация о токене для рекуррентных платежей и выплат)​

Информация о токене для рекуррентных платежей и выплат. Подробнее о рекуррентных платежах и настройках токена.

Входит в объекты: acquiring_payments, payment_details.

НазваниеОбязательностьТипОписание
token+stringТокен
created_at+ (необязательный для payment_details)stringДата создания в формате ISO 8601
finished_at+ (необязательный для payment_details)stringДата завершения в формате ISO 8601. Не обрабатывается Банком и не влияет на срок действия токена
is_active+ (необязательный для payment_details)boolМожно ли проводить операции по этому токену: true — можно,  false — нельзя
initiator-stringВид рекуррентного платежа. Возможные значения: merchant — платеж MIT (по умолчанию), client — платеж CIT

recurrent_token​

Токен для рекуррентных платежей и выплат.

НазваниеОбязательностьТипОписание
token+stringТокен

redirect​

Данные для редиректа (перенаправления пользователя).

НазваниеОбязательностьТипОписание
url+stringАдрес для редиректа вместе с GET-параметрами
base_url+stringАдрес для редиректа
method+stringМетод отправки. Возможные значения: GET, POST
qs-map<string,string>Набор параметров в зависимости от способа прохождения операции
params-map<string,*>Набор параметров в зависимости от способа прохождения операции
  • Проверьте, есть ли какие-либо параметры в объектах qs и params.
  • Перенаправьте пользователя на адрес из base_url при помощи метода, указанного в method, включив все необходимые параметры в URL или в тело запроса.

refunds​

Массив с информацией о возврате.

НазваниеОбязательностьТипОписание
id+stringУникальный идентификатор возврата
status+stringСтатус возврата. Возможные значения: in_progress, accepted, declined, error
amount_details+objectСумма возврата
created_at+stringДата создания
finished_at-stringДата завершения
is_chargeback-boolПоказывает, совершен ли возврат в рамках чарджбека
transaction_info-objectДанные о транзакции

Статусы возврата (status)​

  • in_progress — в обработке.
  • accepted — возврат прошел успешно.
  • declined — Банк 131 отклонил возврат.
  • error — возврат не прошел из-за ошибки.

resend_sms​

Данные для запроса нового кода.

НазваниеОбязательностьТипОписание
rest_of_attempts+stringКоличество оставшихся попыток запросить код
allowed_from+stringС какого времени можно вызвать переотправку кода
callback_url+stringАдрес, на который надо послать запрос кода

ru​

Данные банковского счета в российском банке (в регионе ru).

НазваниеОбязательностьТипОписание
bik- (обязательно при выплатах без токена)stringБИК банка получателя
account- (обязательно при выплатах без токена)stringБанковский счет получателя
token- (обязательно при выплатах по токену)stringТокен банковского счета
full_name+stringФИО физического лица. В случае выплаты на счет ИП, передается в следующем формате: ИП <ФИО>. При выплате юридическому лицу — наименование юрлица, если предусмотрено договором. Важно: если наименование или ФИО указано некорректно, банк-получатель может отказать в зачислении и деньги вернутся на счет отправителя
description+stringНазначение выплаты
inn- (обязательно при выплатах на счет юридического лица или ИП)stringИНН получателя, 10 цифр для юридических лиц, 12 цифр - для физических, в том числе для ИП
kpp- (обязательно при выплатах на счет юридического лица)stringКПП получателя, 9 цифр
is_fast-boolПоказывает, нужно ли проводить срочную выплату (через БЭСП). Срочная выплата проходит в течение часа, обычная — за 1—3 банковских дня

sber_pay​

Информация для оплаты через SberPay.

НазваниеОбязательностьТипОписание
phone-stringНомер телефона для отправки PUSH или СМС. Формат: 7**********
channel+ENUMКанал приема оплаты через SberPay. Возможные значения: app, mobile_web, web

self_employed_widget​

Настройки виджета для привязки самозанятого к Банку 131.

НазваниеОбязательностьТипОписание
tax_reference- (если передан phone)stringИНН самозанятого
phone- (если передан tax_reference)stringТелефон самозанятого

sender (плательщик выплаты c номинального счета)​

Данные о плательщике выплаты c номинального счета.

Входит в объекты: transfer_details.

НазваниеОбязательностьТипОписание
account_number-stringНомер счета
name-stringФИО или наименование
bank_name-stringНаименование банка
bik-stringБИК банка
correspondent_account_number-stringНомер корреспондентского счета
inn-stringИНН банка (только для РКО)
kpp-stringКПП банка (только для РКО)

sender (данные отправителя выплаты)​

Данные отправителя выплаты. Набор необходимых данных зависит от способа получения выплаты.

Входит в объекты: participant_details.

НазваниеОбязательностьТипОписание
full_name-stringПолное имя
first_name-stringИмя
last_name-stringФамилия
middle_name-stringОтчество
company_name-stringНазвание компании
reference-stringИдентификатор получателя на вашей стороне
tax_reference-stringИдентификатор налогоплательщика
beneficiary_id- (обязательно при платежах и выплатах, у которых есть бенефициар или выгодоприобретатель)stringИНН бенефициара или выгодоприобретателя
country_iso3-stringСтрана (ISO 3166-1 alpha-3)
account- (обязательно при выплатах с номинального счета)stringНомер банковского номинального счета, с которого будет осуществляться выплата
citizenship_country_iso3+ (обязательно при денежном переводе)stringСтрана гражданства отправителя по стандарту ISO 3166-1 alpha-3
state-stringРегион или район регистрации отправителя
city- (обязательно при денежном переводе)stringНаселенный пункт регистрации отправителя
postal_code-stringПочтовый индекс места регистрации отправителя
street-stringНазвание улицы места регистрации отправителя
building- (обязательно при денежном переводе)stringНомер дома места регистрации отправителя
flat-stringКвартира места регистрации отправителя
tax_reference-string12-значный ИНН отправителя
date_of_birth- (обязательно при денежном переводе)stringДата рождения отправителя в формате ГГГГ-ММ-ДД. Убедитесь, что возраст отправителя 18+
contacts- (обязательно при денежном переводе)objectКонтакты отправителя
identity_document- (обязательно при денежном переводе)objectДанные документа, удостоверяющего личность отправителя
documents_foreigner-objectПараметры документа отправителя-нерезидента. Обязательно для заполнения, если отправитель является иностранным гражданином
source_of_money-stringИсточник поступления средств отправителя
description-stringДополнительная информация об отправителе
service_point- (обязательно при денежном переводе)objectТочка приема денежных средств

service_point​

Данные о точке приема денежных средств

НазваниеОбязательностьТипОписание
id-stringID точки приёма
name-stringНазвание точки приема
country_iso3+stringСтрана точки приема. Формат ISO 3166-1 alpha-3
state-stringРегион/район нахождения точки приема
city+stringНаселенный пункт нахождения точки приема
oktmo+stringКод ОКТМО расположения точки приема средств
street-stringУлица нахождения точки приема
house-stringЗдание нахождения точки приема
terminal_id-stringНомер терминала/кассы

services​

Массив с описанием услуги, за которую отправляется выплата, для фискализации. В одном массиве может содержаться не более 6 услуг.

  • Ограничение на количество услуг устанавливается со стороны ФНС и не контролируется Банком.
  • Что можно сделать, если услуг больше шести:
    • разбить их на несколько чеков,
    • объединить их.
      Пример: если было оказано 10 консультационных услуг по 10 000 рублей за каждую, то можно указать 10 услуг по 10 000 каждая одним пунктом, а не каждую услугу отдельно.
НазваниеОбязательностьТипОписание
name+stringНазвание услуги (не более 256 символов)
amount_details+objectЦена услуги
quantity-integerКоличество услуг. По умолчанию 1

Важно: произведение цены услуги и количества услуг должно быть равно сумме выплаты.

session​

Контейнер с данными обо всех операциях, которые проводились в рамках одной платежной сессии.

Сессия необходима для проведения платежных операций. В рамках сессии может проходить одна или несколько операций одного или разных типов (например, несколько выплат, платеж и возврат, оплата с последующим разделением платежей).

НазваниеОбязательностьТипОписание
id+stringИдентификатор сессии
status+stringСтатус. Возможные значения: created, in_progress, accepted, cancelled, error
created_at+stringДата создания в формате ISO 8601
updated_at+stringДата обновления в формате ISO 8601
payments-arrayСписок выплат, которые проводились в рамках этой сессии
acquiring_payments-arrayСписок платежей, которые проводились в рамках этой сессии
next_action-stringМетка, указывающая на действия для успешного прохождения транзакции. Возможные значения: confirm, capture
error- (обязателен для status = cancelled и status = error)objectОписание ошибки

Статусы платежной сессии (status)​

  • created — сессия создана, ожидает старта или отмены.
  • in_progress — в обработке.
  • accepted — успешно завершена.
  • cancelled — отменена.
  • error — в процессе работы произошла непредвиденная ошибка.

    Внимание! Данный статус не является финальным. Обратитесь в поддержку Банка 131 и дождитесь финального статуса транзакции.

Дальнейшие действия (next_action)​

Если это поле не пустое, значит, Банк 131 ждет от вас определенных действий, чтобы продолжить операцию:

tax​

Данные для уплаты налогов.

НазваниеОбязательностьТипОписание
type+stringТип налога или способ оплаты. Варианты: tax_short, tax_full
tax_full- (обязателен для type = tax_full)objectДанные для платежей в налоговую с расширенным набором параметров
tax_details- (обязателен для type = tax_short)objectДанные для платежей в налоговую с минимальным набором полей

tax_details​

Данные для платежей в налоговую.

НазваниеОбязательностьТипОписание
period- (обязательно для выплаты с расширенным набором параметров)stringПериод. Формат ввода описан ниже
period- (используется только для type = tax_short)objectПериод
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 стоит АП, то дата послепроверочного решения.

tax_full​

Данные для уплаты налогов с расширенным набором полей.

НазваниеОбязательностьТипОписание
uin+stringУникальный идентификатор начисления. Для платежей в налоговую всегда 0
description+stringНазначение выплаты
tax_details+stringДанные о платеже в налоговую
payer+objectДанные отправителя для платежа в налоговую
payee+objectДанные получателя для платежа в налоговую

tokenize_widget​

Настройки для виджета токенизации.

НазваниеОбязательностьТипОписание
access+boolМожет ли этот публичный ключ использовать виджет токенизации

tokenized_card​

Токенизированный номер карты.

НазваниеОбязательностьТипОписание
token+stringТокен

total_balance​

Информация по балансу.

НазваниеОбязательностьТипОписание
opening+intВходящий остаток по счёту на дату начала выписки
closing+intИсходящий остаток по счёту на дату окончания выписки

total_turnover​

Информация по движению средств.

НазваниеОбязательностьТипОписание
debet+intСумма списаний по счёту за период выписки
credit+intСумма пополнений по счёту за период выписки

transaction_info​

Информация о транзакции.

НазваниеОбязательностьТипОписание
rrn+stringУникальный идентификатор транзакции (Retrieval Reference Number)
arn-stringУникальный номер операции с кредитными картами (Acquirer Reference Number)
auth_code-stringКод авторизации

transactions​

Массив со списком транзакций.

НазваниеОбязательностьТипОписание
amount+intСумма транзакции (только неотрицательные значения)
base_amount-intСумма операции в валюте. Заполняется только для транзакций в валюте, отличной от рублей. При использовании базовой валюты (RUB) параметр является необязательным
currency+stringВалюта операции
payment_date+dateДата операции
bank_system_id+stringИдентификатор платежа. Указывается для любого движения денежных средств по счету:
- для платежей, отправленных по API
- для переводов из другого банка
- для платежей, совершенных через интернет-банк
transaction_id-stringИдентификатор транзакции. Передается для платежей, отправленных по API
session_id-stringИдентификатор сессии. Передается для платежей, отправленных по API
purpose+stringНазначение платежа
counter_party+objectИнформация о плательщике
type+stringТип транзакции. Может принимать значения credit (для операции пополнения) или debet (для операции списания)

transfer_details​

Информация о переводе.

НазваниеОбязательностьТипОписание
payment_method+objectСпособ получения выплаты
customer+objectИнформация о плательщике
recipient+objectИнформация о получателе
purpose+stringНазначение выплаты в следующем формате: <описание>; card:<маска карты>
amount+objectСумма

transfer_from_bank_account​

Информация о переводе с расчетного счета.

НазваниеОбязательностьТипОписание
description+stringОписание

transfer_from_nominal_account​

Информация о переводе с номинального счета.

НазваниеОбязательностьТипОписание
description+stringОписание

wallet​

Данные электронного кошелька.

НазваниеОбязательностьТипОписание
type+stringТип кошелька. Возможные значения: yoomoney
yoomoney-objectДанные кошелька ЮMoney (Яндекс.Деньги)

wallets​

Данные о вашем балансе (счете обеспечения) для отправки выплат.

НазваниеОбязательностьТипОписание
id+stringИдентификатор баланса
amount_details+objectТекущий баланс

yoomoney​

Данные кошелька ЮMoney (Яндекс.Деньги).

НазваниеОбязательностьТипОписание
account+stringНомер кошелька ЮMoney, 11–20 цифр. Пример: 4100175017397
description-stringНазначение платежа, максимум 128 символов. Если будет больше, операция не пройдет