Объекты

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 ждет от вас определенных действий, чтобы продолжить операцию:

Payment

Объект со всеми данными выплаты.

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

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

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

AcquiringPayment

Объект со всеми данными платежа.

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

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

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

Refund

Объект с информацией о возврате.

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

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

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

PaymentMethod

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

НазваниеОбязательностьТипОписание
type+stringТип спсоба получения выплаты. Возможные варианты: card, bank_account, wallet
card-CardPaymentMethodБанковская карта получателя
bank_account-BankAccountPaymentMethodБанковский счет получателя
wallet-WalletPaymentMethodЭлектронный кошелек получателя
tax-TaxPaymentMethodПлатежи в налоговую

PaymentDetails

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

НазваниеОбязательностьТипОписание
type+stringТип способа оплаты. Возможные варианты: card, recurrent, internal_transfer, secured_card, faster_payment_system
card-CardPaymentMethodДанные банковской карты
recurrent-RecurrentTokenInfoДанные для повтора платежа по токену
internal_transfer-InternalTransferInfoДанные для внутреннего перевода
secured_card-SecuredCardДанные для платежа с токенизированной карты
faster_payment_system-Платеж через СБП

PaymentOptions

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

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

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- (обязательно при выплатах на счет юридического лица)stringKПП получателя, 9 цифр.
is_fast-boolПоказывает, нужно ли проводить срочную выплату (через БЭСП). Срочная выплата проходит в течение часа, обычная — за 1—3 банковских дня.

FasterPaymentSystem

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

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

FasterPaymentSystemVerification

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

НазваниеОбязательностьТипОписание
phone+stringТелефон получателя
bank_id+stringИдентификатор банка получателя в СБП

CardPaymentMethod

Объект с данными банковской карты получателя выплаты.

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

BankCard

Объект карты в открытом виде (можно использовать, если у вас есть PCI DSS).

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

EncryptedCard

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

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

WalletPaymentMethod

Объект с данными электронного кошелька.

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

QiwiWalletPaymentMethod

Объект с данными кошелька QIWI.

НазваниеОбязательностьТипОписание
account+stringИдентификатор кошелька QIWI — номер телефона его владельца в международном формате (без плюса). Пример: 79210010203

YooMoneyWalletPaymentMethod

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

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

TaxPaymentMethod

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

НазваниеОбязательностьТипОписание
type+stringТип налога или способ оплаты. Варианты: tax_short
tax_short+TaxShortДанные для платежей в налоговую с минимальным набором полей

TaxShort

Объект с данными для уплаты налогов с минимальным набором полей.

НазваниеОбязательностьТипОписание
tax_details+TaxDetailsДанные для платежей в налоговую

PublicToken

Объект с информацией о публичном токене.

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

RecurrentToken

Объект с информацией о рекуррентном токене.

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

CardTokenInfo

Объект с данными о токенизированной банковской карте.

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

PublicTokenInfo

Объект с информацией о публичном токене.

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

RecurrentTokenInfo

Объект с информацией о рекуррентном токене. Подробнее о рекуррентных платежах и настройках токена здесь.

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

InternalTransferInfo

Объект с информацией о внутреннем переводе.

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

SecuredCard

Объект с информацией о токенизированной карте.

НазваниеОбязательностьТипОписание
type+stringТип перевода. Возможные значения: google_pay
google_pay-GooglePayInfoИнформация о платеже с кошелька Google Pay

TransferFromNominalAccount

Объект с информацией о переводе с номинального счета.

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

GooglePayInfo

Объект с информацией о переводе с помощью Google Pay.

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

AmountDetails

Объект суммы.

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

TaxDetails

Объект с данными для платежей в налоговую.

НазваниеОбязательностьТипОписание
period+TaxPeriodОбъект с описанием периода, за который вам нужно заплатить налог

TaxPeriod

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

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

Customer

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

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

CustomerContact

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

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

CustomerInteraction

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

НазваниеОбязательностьТипОписание
type+stringТип взаимодействия с пользователем. Возможные значения: redirect, inform
redirect-CustomerInteractionRedirectОбъект с данными для перенаправления пользователя
inform-CustomerInteractionInformОбъект с информацией о способе платежа

CustomerInteractionRedirect

Объект с данными для редиректа (перенаправления пользователя).

НазваниеОбязательностьТипОписание
url+stringАдрес для редиректа вместе с GET-параметрами
base_url+stringАдрес для редиректа
method+stringМетод отправки. Например, POST
qs-map<string,string>Набор GET-параметров для редиректа
params-map<string,*>Набор параметров для тела сообщения при редиректе

CustomerInteractionInform

Объект с информацией о способе платежа

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

QRInformInteraction

Объект, в котором содержится QR-код для оплаты по СБП

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

FiscalizationDetails

Объект с данными для фискализации.

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

FiscalizationReceipt

Объект с данными чека, созданного при фискализации.

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

FiscalizationService

Объект с описанием услуги, за которую отправляется выплата, для фискализации.

НазваниеОбязательностьТипОписание
name+stringНазвание услуги
amount_details+AmountDetailsЦена услуги
quantity-integerКоличество услуг. По умолчанию 1

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

Participant

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

НазваниеОбязательностьТипОписание
full_name- (обязательно для Participant.recipient при выплатах на любые карты)stringИмя
company_name-stringНазвание компании
reference-stringИдентификатор получателя на вашей стороне
tax_reference-stringИдентификатор налогоплательщика
beneficiary_id- (обязательно при платежах и выплатах, у которых есть бенефициар или выгодоприобретатель)stringИНН бенефициара или выгодоприобретателя
country_iso2-stringСтрана (ISO-3166-1 alpha-2)

ParticipantDetails

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

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

ProfessionalIncomeTaxpayer

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

НазваниеОбязательностьТипОписание
services+array<FiscalizationService>Список оказанных услуг
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 — нерезидент РФ.

WalletDetails

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

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

TokenizeWidgetMetadata

Объект с настройками для виджета токенизации.

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

SelfEmployedWidgetMetadata

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

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

AcquiringWidgetMetadata

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

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

СonfirmInformation

Объект с информацией для подтверждения операции по номинальному счету.

НазваниеОбязательностьТипОписание
transfer_details+TransferDetailsИнформация о переводе

TransferDetails

Объект с информацией о переводе.

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

NominalPaymentParticipant

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

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

Error

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

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

Коды ошибок

← АктМетоды →