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

Методы

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

к сведению

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

Пример отправки запроса на выплату:

  • Если запрос session/create передан пустым, запрос начала выплаты (session/start/payout) должен содержать все обязательные параметры.
  • Если запрос session/create содержит все обязательные параметры, указанные для операции, запрос начала выплаты (session/start/payout) может быть пустым или содержать только те параметры, значение которых вы хотите изменить.
  • Если запрос session/create содержит только некоторые обязательные параметры, запрос начала выплаты (session/start/payout) должен содержать те обязательные параметры, которые не были переданы ранее.
  • При создании сессии и выплаты одновременно (session/init/payout) все необходимые параметры должны быть переданы сразу.

Проведение операций

recurrent/disable

Отключение токена

Метод отключает токен для рекуррентных платежей. Для этого отправьте токен в запросе. В ответе вы получите параметр is_active: false, это значит, что с этим токеном больше нельзя проводить рекуррентные платежи.

После отключения токена в параметре finished_at может отображаться дата, относящаяся к 2000 году. Проигнорируйте это значение.

Адрес для отправки запроса

/api/v1/recurrent/disable

Параметры запроса

НазваниеОбязательностьТипОписание
recurrent+objectТокен
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/recurrent/disable \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"recurrent": {
"token": "97417d4a9a23da9c2401c510a3fc45c2d1752f68ac9fd2a366698d70293b6427"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
recurrent+objectТокен
Пример ответа
{
"recurrent": {
"token": "97417d4a9a23da9c2401c510a3fc45c2d1752f68ac9fd2a366698d70293b6427",
"created_at": "2025-07-14T13:17:11+03:00",
"finished_at": "2025-07-31T16:05:42+03:00",
"is_active": false,
"type": "recurrent_token"
},
"status": "ok"
}

session/cancel

Отмена операции

Метод для отмены выплаты или платежа после получения вебхука ready_to_confirm или ready_to_capture от Банка 131.

Адрес для отправки запроса

/api/v1/session/cancel

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор сессии
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/cancel \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2025",
"status": "pending",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}

session/capture

Списание захолдированной суммы

Метод для списания ранее захолдированных средств после получения вебхука ready_to_capture от Банка 131. Вы можете списать как полную сумму, так и ее часть.

Адрес для отправки запроса

/api/v1/session/capture

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор сессии
amount_details-objectСумма. Может быть меньше захолдированной, но обязательно больше 0. Если параметр отсутствует, захолдированная сумма будет списана полностью
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/capture \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2024-05-27T02:03:00.000000Z",
"updated_at": "2024-05-27T02:03:00.000000Z",
"acquiring_payments": [{
"id": "pm_1313",
"status": "succeeded",
"created_at": "2024-05-27T02:03:00.000000Z",
"finished_at": "2024-05-27T02:03:00.000000Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "card",
"card": {
"brand": "visa",
"last4": "4242"
}
},
"amount_details": {
"amount": 10000,
"currency": "usd"
},
"refunds": [{
"id": "rf_23",
"status": "in_progress",
"created_at": "2024-05-27T02:03:00.000000Z",
"amount_details": {
"amount": 10000,
"currency": "usd"
}
}]
}]
}
}

session/confirm

Подтверждение операции

Метод для подтверждения выплаты или платежа после получения вебхука ready_to_confirm или ready_to_capture от Банка 131. Запрос нужно отправить в течение 4 часов с момента создания операции, иначе вернется ошибка confirm_timeout.

Адрес для отправки запроса

/api/v1/session/confirm

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор сессии
confirm_information- (обязательно при операциях с расчетным и номинальным счетами, а также при денежных переводах)objectИнформация для подтверждения операции
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/confirm \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2025",
"status": "pending",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}

session/create

Создание платежной сессии

Метод для создания платежной сессии. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.

Этот метод обязателен при платежах через виджет, так как для генерации публичного токена нужен session_id. Токен связывает данные карты, введенные пользователем, с конкретной сессией. Без этого Банк 131 не сможет определить, к какому платежу относятся введенные данные и вебхуки.

Если вы принимаете платеж через СБП, обязательно передайте faster_payment_system в payment_details.

Вы можете создать сессию и запустить выплату/платеж одновременно с помощью метода session/init. Не рекомендуем использовать этот способ.

Адрес для отправки запроса

/api/v1/session/create

Параметры запроса

НазваниеОбязательностьТипОписание
payment_method-objectПлатежные данные для зачисления средств
payment_details-objectПлатежные данные для списания средств
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
fiscalization_details-objectДанные для фискализации
participant_details- (обязательно для выплат)objectИнформация об отправителе и получателе
customer- (обязательно для платежей)objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/create \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "order123"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "created",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z"
}
}

session/init/payment

Создание сессии с одновременным запуском платежа

Метод для проведения платежа без отдельного создания сессии. В этом случае вы передаете все данные сразу.

В ответе возвращаются параметры созданной сессии с информацией о платеже (acquiring_payments/payment_list).

Адрес для отправки запроса

/api/v1/session/init/payment

Параметры запроса

НазваниеОбязательностьТипОписание
payment_details+objectПлатежные данные для списания средств
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details-objectИнформация об отправителе и получателе
customer+objectДанные плательщика в вашей системе
payment_options-objectДополнительные параметры платежа
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/init/payment \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_details": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242",
"expiration_month": "05",
"expiration_year": "22",
"security_code": "123"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"customer": {
"reference": "lucky"
},
"payment_options": {
"return_url": "https://131.ru"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"acquiring_payments": [{
"id": "pm_203",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "card",
"card": {
"brand": "visa",
"last4": "4242"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"payment_options": {
"return_url": "https://131.ru"
}
}]
}
}

session/init/payment/sync

Не рекомендуем использовать этот метод.

Метод для платежа одним запросом. Подходит, если вы не используете виджет.

При использовании этого метода вебхуки не отправляются. Результат платежа возвращается в ответе на этот же запрос.

Подробнее о платеже одним запросом >

Адрес для отправки запроса

/api/v1/session/init/payment/sync

Параметры запроса

НазваниеОбязательностьТипОписание
payment_details+objectПлатежные данные для списания средств
  type+stringТип способа оплаты. Значение: card
  card+objectДанные банковской карты
    type+stringСпособ передачи данных карты. Значение: bank_card
    bank_card+objectДанные карты в открытом виде
      number+stringНомер карты
      expiration_month+stringМесяц, до которого действует карта, в формате ММ. Например 01
      expiration_year+stringГод, до которого действует карта, в формате ГГ. Например 22
      security_code+stringСекретный код CVC или CVV
amount_details+objectСумма
  amount+intЗначение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
  currency+stringКод валюты согласно ISO 4217. Регистр не важен. Пример: rub
participant_details-objectИнформация об отправителе и получателе
customer+objectДанные плательщика в вашей системе
  reference+stringИдентификатор плательщика в вашей системе
payment_options+objectДополнительные параметры платежа
  return_url+stringВалидный URL для перенаправления пользователя после оплаты
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/init/payment/sync \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_details": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242",
"expiration_month": "01",
"expiration_year": "22",
"security_code": "123"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"customer": {
"reference": "lucky"
},
"payment_options": {
"return_url": "https://131.ru"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "accepted",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"acquiring_payments": [{
"id": "pm_203",
"status": "succeeded",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "card",
"card": {
"brand": "visa",
"last4": "4242"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"payment_options": {
"return_url": "https://131.ru"
}
}]
}
}

session/init/payout

Создание сессии с одновременным запуском выплаты

Метод для проведения выплаты без отдельного создания сессии. В этом случае вы передаете все данные сразу.

В ответе возвращаются параметры созданной сессии и информация о выплате (payments/payout_list).

Адрес для отправки запроса

/api/v1/session/init/payout

Параметры запроса

НазваниеОбязательностьТипОписание
payment_method+objectПлатежные данные для зачисления средств
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
fiscalization_details-objectДанные для фискализации
participant_details-objectИнформация об отправителе и получателе
customer-objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/init/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242"
}
}
},
"amount_details": {
"amount": 1000,
"currency": "rub"
},
"participant_details": {
"recipient": {
"full_name": "Ivanov Ivan"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}

session/init/payout/fiscalization

Создание сессии с одновременным запуском выплаты с фискализацией

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

В ответе возвращаются параметры созданной сессии и информация о выплате (payments/payout_list) с данными для отправки чека.

Адрес для отправки запроса

/api/v1/session/init/payout/fiscalization

НазваниеОбязательностьТипОписание
payment_method-objectПлатежные данные для зачисления средств
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
fiscalization_details-objectДанные для фискализации
participant_details-objectИнформация об отправителе и получателе
customer-objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/init/payout/fiscalization \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"fiscalization_details": {
"professional_income_taxpayer": {
"tax_reference": "590000000000",
"payer_type": "legal",
"payer_tax_number": "3300000000",
"payer_name": "Vector LLC",
"services": [{
"name": "Service description",
"amount_details": {
"amount": 10000,
"currency": "rub"
}
}]
}
},
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "order123",
"participant_details": {
"recipient": {
"full_name": "Ivanov Ivan"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "created",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2909",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "4242"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"fiscalization_details": {
"professional_income_taxpayer": {
"tax_reference": "590000000000",
"payer_type": "legal",
"payer_tax_number": "3300000000",
"payer_name": "Vector LLC",
"services": [{
"name": "Service description",
"amount_details": {
"amount": 10000,
"currency": "rub"
}
}]
}
},
"metadata": "order123",
"participant_details": {
"recipient": {
"full_name": "Ivanov Ivan"
}
}
}]
}
}

session/refund

Возврат платежа

Метод для возврата денег пользователю после успешного платежа. Можно вернуть всю сумму или часть. Отменить возврат нельзя — перед отправкой запроса убедитесь, что это действительно необходимо.

После проведения возврата Банк 131 отправит вам вебхук payment_refunded с результатом возврата.

Адрес для отправки запроса

/api/v1/session/refund

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор сессии из платежа, который нужно вернуть
amount_details-objectСумма. Если не указать, вернется вся сумма платежа
metadata-*Дополнительная информация
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/refund \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"acquiring_payments": [{
"id": "pm_2705",
"status": "succeeded",
"created_at": "2025-05-27T02:03:00.000000Z",
"finished_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "card",
"card": {
"brand": "visa",
"last4": "4242"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"refunds": [{
"id": "rf_23",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"amount_details": {
"amount": 10000,
"currency": "rub"
}
}]
}]
}
}

session/start/payment

Запуск платежа

Метод для запуска платежа в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.

Адрес для отправки запроса

/api/v1/session/start/payment

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
payment_details-objectПлатежные данные для списания средств
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details-objectИнформация об отправителе и получателе
customer-objectДанные плательщика в вашей системе
payment_options-objectДополнительные параметры
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/start/payment \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230",
"payment_details": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242",
"expiration_month": "01",
"expiration_year": "26",
"security_code": "123"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"customer": {
"reference": "lucky"
},
"payment_options": {
"return_url": "https://www.131.ru"
},
"metadata": "good"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2024-08-21T06:21:36.913863Z",
"updated_at": "2024-08-21T06:21:56.832509Z",
"acquiring_payments": [{
"id": "pm_3232",
"status": "in_progress",
"created_at": "2024-08-21T06:21:56.846204Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa",
"country_iso3": "RUS"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"payment_options": {
"return_url": "https://www.131.ru"
},
"metadata": "good"
}]
}
}

session/start/payout

Запуск выплаты

Метод для запуска выплаты в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.

Адрес для отправки запроса

/api/v1/session/start/payout

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
payment_method-objectПлатежные данные для зачисления средств
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details-objectИнформация об отправителе и получателе
customer-objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/start/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}

session/start/payout/fiscalization

Запуск выплаты с фискализацией

Метод для запуска выплаты самозанятому с фискализацией в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.

Адрес для отправки запроса

/api/v1/session/start/payout/fiscalization

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
payment_method-objectПлатежные данные для зачисления средств
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
fiscalization_details-objectДанные для фискализации
participant_details-objectИнформация об отправителе и получателе
customer-objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/start/payout/fiscalization \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230",
"fiscalization_details": {
"professional_income_taxpayer": {
"tax_reference": "590000000000",
"payer_type": "legal",
"payer_tax_number": "330000000000",
"payer_name": "ООО Вектор",
"services": [{
"name": "Доставка товара",
"amount_details": {
"amount": 5000,
"currency": "rub"
}
}]
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_203",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "4242"
}
},
"amount_details": {
"amount": 5000,
"currency": "rub"
},
"fiscalization_details": {
"professional_income_taxpayer": {
"services": [{
"name": "Доставка товара",
"amount_details": {
"amount": 5000,
"currency": "rub"
},
"quantity": 1
}],
"tax_reference": "590613976192",
"payer_type": "legal",
"payer_tax_number": "3316004710",
"payer_name": "ООО Вектор"
}
}
}]
}
}

token

Получение публичного токена для виджетов

Для работы с виджетами нужен публичный токен. Он действует 24 часа и предназначен для одной операции.

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

Адрес для отправки запроса

/api/v1/token

Параметры запроса

НазваниеОбязательностьТипОписание
tokenize_widget-objectДанные для виджета токенизации
self_employed_widget-objectДанные для виджета регистрации самозанятого
acquiring_widget-objectДанные для виджета платежной формы
Пример запроса токена для выплаты с получением данных карты через виджет и с подключением самозанятого
curl -X POST \
https://demo.bank131.ru/api/v1/token \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"tokenize_widget": {
"access": true
},
"self_employed_widget": {
"tax_reference": "111111111111"
}
}'
Пример запроса токена для платежа с оплатой через платежную форму
curl -X POST \
https://demo.bank131.ru/api/v1/token \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"acquiring_widget": {
"session_id": "ps_123456"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
public_token-stringПубличный токен
error-objectОшибка
Примеры ответов
{
"status": "ok",
"public_token": "e065c2f1328e74156a883c00e210a4b1b1451782bbfdd18ae8d05715e05d8539"
}

tokenize

Токенизация банковского счета

Метод для получения токена банковского счета получателя выплаты. В ответе также возвращается маскированный номер счета. Токен не имеет срока действия.

Если счет не проходит проверку на соответствие разрешенному списку счетов, возвращается ошибка «Введите другой номер счета».

Адрес для отправки запроса

/api/v1/tokenize

Параметры запроса

ПараметрТипОписание
typestringТип банковского счета
bank_account_ruobjectДополнительная информация о банковском счете
  bikstringБИК банка
  accountstringНомер счета
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/tokenize \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"type": "bank_account_ru",
"bank_account_ru": {
"bik": "044525974",
"account": "40817810400003869535"
}
}'

Параметры ответа

ПараметрТипОписание
statusstringТип банковского счета
tokenstringТокен
dataobjectДанные маскированного счета
errorobjectОшибка
Примеры ответов
{
"status": "ok",
"token": "2c6ebe1368407b922057efee0fed58360dae1d28af50fa6734bb54c61a763c24",
"data": {
"masked_account": "40817***9535"
}
}

tokenize/elements

Токенизация номера банковской карты

Метод для получения токена номера банковской карты получателя выплаты. В результате номер карты сохраняется в системе Банка 131. В ответе возвращается токен для многократных выплат на эту карту. Срок действия токена не ограничен.

Чтобы использовать метод, обратитесь к персональному менеджеру в Банке 131.

Адрес для отправки запроса

/api/v1/tokenize/elements

Параметры запроса

НазваниеОбязательностьТипОписание
card_elements+objectНомер банковской карты для токенизации
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/tokenize/elements \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"card_elements": [
{
"ref": "number",
"type": "card_number",
"card_number": "4242424242424242"
}
]
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
data+objectДанные карты
error-objectОшибка
Примеры ответов
{
"status": "ok",
"data": {
"number": {
"token": "adb0eb0ac3f1f5f627f15aa8ca47b13483325ec42baab5e87cbff5f784dca919",
"info": {
"masked_card_number": "424242******4242",
"card_network": "visa",
"card_type": "visa"
}
}
}
}

Информация

fps/banks

Получение списка банков — участников СБП

Метод для получения списка банков с их наименованиями и идентификаторами для отправки выплат через Систему быстрых платежей.

Адрес для отправки запроса

/api/v1/fps/banks

Пример запроса
curl -X GET \
https://demo.bank131.ru/api/v1/fps/banks \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{}'
Пример ответа
{
"banks": [{
"id": "100000000243",
"eng_name": "National Standard Bank",
"ru_name": "Национальный стандарт"
},
{
"id": "100000000056",
"eng_name": "Khlynov",
"ru_name": "Хлынов"
},...]
}

fps/customer_verification

Проверка получателя в СБП

Метод для проверки регистрации получателя выплаты в Системе быстрых платежей. Если пользователь найден — сессия завершится успешно; если нет — сессия отменится.

Операция не тарифицируется и не требует подтверждения (вебхук ready_to_confirm не отправляется).

Адрес для отправки запроса

/api/v1/fps/customer_verification

Параметры запроса

НазваниеОбязательностьТипОписание
payment_method+objectПлатежные данные для зачисления средств
participant_details+objectИнформация об отправителе и получателе
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/fps/customer_verification \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "faster_payment_system_verification",
"faster_payment_system_verification": {
"phone": "79261234567",
"bank_id": "100000000069"
}
}
},
"participant_details": {
"recipient": {
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_109941",
"status": "in_progress",
"created_at": "2022-03-01T11:57:31.652396Z",
"updated_at": "2022-03-01T11:57:31.861329Z",
"payments": [{
"id": "po_31668",
"status": "in_progress",
"created_at": "2022-03-01T11:57:31.895773Z",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "faster_payment_system_verification",
"faster_payment_system_verification": {
"phone": "79261234567",
"bank_id": "100000000069"
}
}
},
"participant_details": {
"recipient": {
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович"
}
}
}]
}
}

report/account_balance

Проверка баланса

Метод для получения текущего остатка по расчетному или номинальному счету.

Адрес для отправки запроса

/api/v1/report/account_balance

Параметры запроса

НазваниеОбязательностьТипОписание
account_number+stringНомер счета. Счет должен начинаться с цифр: 40702, 40703, 40802, 40807, 40701
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/report/account_balance \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"account_number": "40702810400000000333"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
account_number-stringНомер счета
account_currency-stringВалюта счета согласно ISO 4217 (например, RUB)
balance-objectИнформация о балансе
error-objectОшибка
Примеры ответов
{
"status": "ok",
"account_number": "40702810400000000333",
"account_currency": "RUB",
"balance": {
"current_balance": 20900
}
}

report/account_statement

Получение выписки

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

Адрес для отправки запроса

/api/v1/report/account_statement

Параметры запроса

НазваниеОбязательностьТипОписание
account_number+stringНомер счета (20 цифр), по которому запрашивается выписка
date_from+dateДата начала выписки. Пример: 2023-06-01
date_to+dateДата окончания выписки. Пример: 2023-06-01. Значения в date_from и date_to должны совпадать
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/report/account_statement \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"date_from": "2023-06-01",
"date_to": "2023-06-01",
"account_number": "40702810600200000014"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
method+objectИнформация о методе
  name+stringНазвание метода account_statement
  account_statement+objectДетали выписки
    date_from+dateДата начала выписки
    date_to+dateДата окончания выписки
    account_number+stringНомер счета (20 цифр), по которому сформирована выписка
    total_turnover+objectИнформация по движению средств
      debet+intСумма списаний по счету за период выписки
      credit+intСумма пополнений по счету за период выписки
    total_balance+objectИнформация по балансу
      opening+intВходящий остаток по счету на дату начала выписки
      closing+intИсходящий остаток по счету на дату окончания выписки
    transactions+arrayСписок операций
      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Информация о контрагенте
        kpp-stringКПП контрагента
        inn-stringИНН контрагента
        name+stringНаименование контрагента
        account_number+stringНомер счета контрагента
        bank_code+stringБИК банка контрагента
      type+stringТип транзакции. Может принимать значения credit (для операции пополнения) или debet (для операции списания)
Пример успешного ответа
{
"status": "ok",
"method": {
"name": "account_statement",
"account_statement": {
"date_from": "2022-11-12T18:19:32.487+0000",
"date_to": "2022-11-13T18:19:32.487+0000",
"account_number": "40703810500000000025",
"total_turnover": {
"debet": 0,
"debet_base": null,
"credit": 100,
"credit_base": null
},
"total_balance": {
"opening": 0,
"opening_base": null,
"closing": 100,
"closing_base": null
},
"transactions": [{
"amount": 10000,
"base_amount": null,
"currency": "RUB",
"payment_date": "2022-11-13",
"bank_system_id": "2080040097819020",
"transaction_id": "c7b923ec-844f-4d98-ad02-795d62fe1989",
"session_id": "ps_3230",
"purpose": "Пополнение счета для тестов",
"counter_party": {
"kpp": "165501001",
"inn": "1655415696",
"name": "Плата за услуги процессинга по переводам без открытия счета",
"account_number": "70606810600004710401",
"bank_code": "049205131"
},
"type": "credit"
}]
}
}
}
Примеры неуспешных ответов

date_from не равна date_to

{
"status": "error",
"error": {
"description": "Invalid input request parameters: (max interval is 1 day)",
"code": "invalid_request"
}
}

date_from больше date_to

{
"status": "error",
"error": {
"description": "Invalid input request parameters: (date_to must be greater than date_from); (max interval is 1 day)",
"code": "invalid_request"
}
}

Невалидная дата в date_from

{
"status": "error",
"error": {
"description": "Invalid value in date_from",
"code": "invalid_request"
}
}

Невалидная дата в date_to

{
"status": "error",
"error": {
"description": "Invalid value in date_to",
"code": "invalid_request"
}
}

session/status

Получение информации о сессии

Метод для получения полной информации о платежной сессии. Например, вы можете проверить статус выплаты или узнать, можно ли списать захолдированную сумму.

Адрес для отправки запроса

/api/v1/session/status

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"next_action": "confirm",
"payments": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa",
"bin": "220220"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"transaction_info": {
"rrn": "425307614918",
"auth_code": "057441"
},
"metadata": "good"
}]
}
}

token/info

Получение информации о токене

Метод для получения информации о токене: как о привязанном средстве оплаты, так и о его технических параметрах.

С помощью запроса вы можете получить следующую информацию:

  • по карте — маскированный номер и тип платежной системы;
  • по счету — маскированный номер счета;
  • по самому токену — тип, дата и время создания, срок действия и активен ли он на момент запроса.

Адрес для отправки запроса

/api/v1/token/info

Параметры запроса

НазваниеОбязательностьТипОписание
type+stringТип токена, по которому нужна информация. Значения: card, public_token, recurrent_token, bank_account_ru
card- (обязателен для type = card)objectДанные банковской карты
public_token- (обязателен для type = public_token)objectДанные публичного токена виджета
recurrent_token- (обязателен для type = recurrent_token)objectДанные токена для рекуррентных платежей и выплат
bank_account_ru- (обязателен для type = bank_account_ru)objectДанные банковского счета
Примеры запросов информации

Вы отправляете хеш-номер банковской карты и получаете информацию по карте.

curl -X POST \
https://demo.bank131.ru/api/v1/token/info \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"type": "card",
"card": {
"type": "encrypted_card",
"encrypted_card": {
"number_hash": "card_number_hash"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
info-objectИнформация о токене, зависит от типа запроса (type): токенизированная банковская карта, публичный токен, токен для рекуррентных платежей или выплат или токен банковского счета
error-objectОшибка
Примеры ответов
{
"status": "ok",
"info": {
"number_hash": "card_number_hash",
"brand": "visa",
"last4": "4242",
"type": "card"
}
}

wallet/balance

Проверка баланса

Метод для получения текущего остатка по обеспечительному счету. Используйте его, чтобы убедиться, что на обеспечительном счете достаточно средств для выплат и возвратов. Если денег недостаточно — пополните счет.

примечание

Баланс по эквайрингу можно узнать в вашем аккаунте интернет-банка в разделе Выписки.

Адрес для отправки запроса

/api/v1/wallet/balance

Параметры запроса

НазваниеОбязательностьТипОписание
request_datetime+stringДата и время отправки запроса согласно ISO 8601
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/wallet/balance \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_datetime": "2025-10-14T19:53:00+03:00"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
wallets-objectСписок доступных депозитов в Банке 131
error-objectОшибка
Примеры ответов
{
"status": "ok",
"wallets": [{
"id": "131",
"amount_details": {
"amount": 13100,
"currency": "rub"
}
}]
}

Самозанятые

npd/accruals и npd/request/status

Подробная проверка налоговой задолженности и бонуса самозанятого

Метод для получения подробной информации о налоговой задолженности и остатке налогового бонуса у самозанятого.

Состоит из двух шагов:

  1. Отправьте запрос npd/accruals с ИНН самозанятого. В ответе придет request_id.
  2. Передайте этот request_id в метод npd/request/status. В ответе вернется информация о задолженности и остатке бонуса.

Адрес для отправки запроса npd/accruals

/api/v1/npd/accruals

Параметры запроса npd/accruals

НазваниеОбязательностьТипОписание
tax_reference_list+arrayСписок ИНН самозанятых. Не более 100 ИНН в одном запросе
Пример запроса npd/accruals
curl -X POST \
https://demo.bank131.ru/api/v1/npd/accruals \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"tax_reference_list": [
"111111111111"
]
}'

Параметры ответа на запрос npd/accruals

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/accruals
Пример ответа на запрос npd/accruals
{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}

Адрес для отправки запроса npd/request/status

/api/v1/npd/request/status

Параметры запроса npd/request/status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/accruals
Пример запроса npd/request/status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/request/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}'

Параметры ответа на запрос npd/request/status

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok, pending
accruals-jagged array
  tax_charge_list-arrayСписок налоговых начислений
    amount-stringСумма начисления
    due_date-stringСрок оплаты
    tax_period_id-stringНалоговый период в формате ГГГГММ
    oktmo-stringОКТМО региона ведения деятельности
    kbk-stringКод бюджетной классификации
    paid_amount-stringСумма оплат, поступивших по данному начислению
    create_time-stringДата и время создания начисления
    id-stringВнутренний идентификатор начисления в ПП НПД
  krsb_list-arrayСписок задолженностей по карточкам расчетов с бюджетом
    debt-stringСумма задолженности по карточке
    penalty-stringСумма пени по карточке
    overpayment-stringСумма переплаты по карточке
    oktmo-stringОКТМО, связанный с КРСБ
    kbk-stringКБК, связанный с КРСБ
    tax_organ_code-stringКод налогового органа, связанного с КРСБ
    update_time-stringДата и время обновления информации по карточке в ПП НПД
    id-stringВнутренний идентификатор карточки в ПП НПД
  inn-stringИНН самозанятого, по которому получены данные
Пример ответа на запрос npd/request/status
{
"status": "ok",
"accruals": [{
"tax_charge_list": [{
"amount": "",
"due_date": "",
"tax_period_id": "",
"oktmo": "",
"kbk": "",
"paid_amount": "",
"create_time": "",
"id": ""
}],
"krsb_list": [{
"debt": "",
"penalty": "",
"overpayment": "",
"oktmo": "",
"kbk": "",
"tax_organ_code": "",
"update_time": "",
"id": ""
}],
"inn": "111111111111"
}]
}

npd/notifications/count и npd/request/status

Проверка количества непрочитанных оповещений ФНС для самозанятого

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

Состоит из двух шагов:

  1. Отправьте запрос npd/notifications/count с ИНН самозанятого. В ответе придет request_id.
  2. Передайте этот request_id в метод npd/request/status. В ответе вернется количество непрочитанных оповещений. Если статус pending, повторите запрос позже.

Адрес для отправки запроса npd/notifications/count

/api/v1/npd/notifications/count

Параметры запроса npd/notifications/count

НазваниеОбязательностьТипОписание
tax_reference_list+arrayСписок ИНН (не более 1000 в одном запросе)
Пример запроса npd/notifications/count
curl -X POST \
https://demo.bank131.ru/api/v1/npd/notifications/count \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"tax_reference_list": [
"123456789012"
]
}'

Параметры ответа на запрос npd/notifications/count

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/count
Пример ответа на запрос npd/notifications/count
{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}

Адрес для отправки запроса npd/request/status

/api/v1/npd/request/status

Параметры запроса npd/request/status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/count
Пример запроса npd/request/status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/request/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}'

Параметры ответа на запрос npd/request/status

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok, pending
info-arrayКоличество оповещений
Пример ответа на запрос npd/request/status
{
"status": "ok",
"info": [{
"tax_reference": "",
"count": 0
}]
}

npd/notifications/mark_as_delivered и npd/request/status

Отправка уведомления в ФНС о доставке оповещения самозанятому

Метод для отправки в ФНС подтверждения, что оповещение было доставлено самозанятому. Вызывается после метода npd/notifications/read.

Состоит из двух шагов:

  1. Отправьте запрос npd/notifications/mark_as_delivered с данными самозанятого. В ответе придет request_id.
  2. Передайте этот request_id в метод npd/request/status. В ответе вернется статус доставки.

Адрес для отправки запроса npd/notifications/mark_as_delivered

/api/v1/npd/notifications/mark_as_delivered

Параметры запроса npd/notifications/mark_as_delivered

НазваниеОбязательностьТипОписание
notification_list+arrayСписок оповещений с их идентификаторами
Пример запроса npd/notifications/mark_as_delivered
curl -X POST \
https://demo.bank131.ru/api/v1/npd/notifications/mark_as_delivered \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"notification_list": [{
"message_id_list": [
"123",
"234"
],
"tax_reference": "123456789012"
}]
}'

Параметры ответа на запрос npd/notifications/mark_as_delivered

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/mark_as_delivered
Пример ответа на запрос npd/notifications/mark_as_delivered
{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}

Адрес для отправки запроса npd/request/status

/api/v1/npd/request/status

Параметры запроса npd/request/status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/mark_as_delivered
Пример запроса npd/request/status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/request/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}'

Параметры ответа на запрос npd/request/status

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok, pending
Пример ответа на запрос npd/request/status
{
"status": "ok"
}

npd/notifications/read и npd/request/status

Получение подробной информации о непрочитанных оповещениях ФНС для самозанятого

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

Состоит из двух шагов:

  1. Отправьте запрос npd/notifications/read с ИНН самозанятого. В ответе придет request_id.
  2. Передайте этот request_id в метод npd/request/status. В ответе вернется информация о непрочитанных оповещениях. Если статус pending — повторите запрос позже.

Адрес для отправки запроса npd/notifications/read

/api/v1/npd/notifications/read

Параметры запроса npd/notifications/read

НазваниеОбязательностьТипОписание
tax_reference_list+arrayСписок ИНН самозанятых для получения оповещений
get_read+booleanВключать в ответ уже прочитанные оповещения: true — да; false — нет
get_archived+booleanВключать в ответ архивные оповещения: true — да; false — нет
Пример запроса npd/notifications/read
curl -X POST \
https://demo.bank131.ru/api/v1/npd/notifications/read \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"tax_reference_list": [
"123456789012"
],
"get_read": false,
"get_archived": false
}'

Параметры ответа на запрос npd/notifications/read

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/read
Пример ответа на запрос npd/notifications/read
{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}

Адрес для отправки запроса npd/request/status

/api/v1/npd/request/status

Параметры запроса npd/request/status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/read
Пример запроса npd/request/status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/request/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}'

Параметры ответа на запрос npd/request/status

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
info-arrayСписок параметров для ИНН
Пример ответа на запрос npd/request/status
{
"status": "ok",
"info": [{
"tax_reference": "123456789012",
"notifications": [{
"id": "132313",
"title": "131.ru запрашивает разрешение на осуществление определенных действий от Вашего имени",
"message": "131.ru запросил у Вас разрешение на осуществление определенных действий от Вашего имени. Вы можете ознакомиться с перечнем запрошенных разрешений и дать свое согласие (уполномочить 131.ru), нажав кнопку \"Разрешить\", или отказать ему, нажав кнопку \"Отказать\".",
"status": "NEW",
"created_at": "2023-03-22T13:29:55+00:00"
}]
}]
}

npd/notifications/update и npd/request/status

Отправка уведомления в ФНС о прочтении оповещения самозанятым

Метод для подтверждения в ФНС, что оповещение было прочитано самозанятым. Вызывается после метода npd/notifications/mark_as_delivered.

Состоит из двух шагов:

  1. Отправьте запрос npd/notifications/update с данными самозанятого. В ответе придет request_id.
  2. Передайте этот request_id в метод npd/request/status. В ответе вернется статус отправки уведомления.

Адрес для отправки запроса npd/notifications/update

/api/v1/npd/notifications/update

Параметры запроса npd/notifications/update

НазваниеОбязательностьТипОписание
notification_list+arrayДанные об оповещениях
Пример запроса npd/notifications/update
curl -X POST \
https://demo.bank131.ru/api/v1/npd/notifications/update \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"notification_list": [{
"tax_reference": "123456789012"
}]
}'

Параметры ответа на запрос npd/notifications/update

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/update
Пример ответа на запрос npd/notifications/update
{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}

Адрес для отправки запроса npd/request/status

/api/v1/npd/request/status

Параметры запроса npd/request/status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/notifications/update
Пример запроса npd/request/status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/request/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}'

Параметры ответа на запрос npd/request/status

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok, pending
Пример ответа на запрос npd/request/status
{
"status": "ok"
}

npd/taxpayer/account_status и npd/request/status

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

Метод для получения общей информации о наличии налоговой задолженности и остатке налогового бонуса у самозанятого.

Состоит из двух шагов:

  1. Отправьте запрос npd/taxpayer/account_status с данными самозанятого. В ответе придет request_id.
  2. Передайте этот request_id в метод npd/request/status. В ответе вернется общая информация о задолженности и остатке бонуса.

Адрес для отправки запроса npd/taxpayer/account_status

/api/v1/npd/taxpayer/account_status

Параметры запроса npd/taxpayer/account_status

НазваниеОбязательностьТипОписание
tax_reference+stringИНН самозанятого. Только один ИНН в запросе
Пример запроса npd/taxpayer/account_status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/taxpayer/account_status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"tax_reference": "123456789012"
}'

Параметры ответа на запрос npd/taxpayer/account_status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/taxpayer/account_status
Пример ответа на запрос npd/taxpayer/account_status
{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}

Адрес для отправки запроса npd/request/status

/api/v1/npd/request/status

Параметры запроса npd/request/status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/taxpayer/account_status
Пример запроса npd/request/status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/request/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}'

Параметры ответа на запрос npd/request/status

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok, pending
bonus_amount-stringОстаток налогового бонуса
unpaid_amount-stringОбщая сумма неоплаченных платежей
debt_amount-stringСумма задолженности (включена в общую сумму неоплаченных платежей)
Пример ответа на запрос npd/request/status
{
"status": "ok",
"bonus_amount": "9972.3624",
"unpaid_amount": "0",
"debt_amount": "0"
}

npd/taxpayer/check_personal_info и npd/request/status

Проверка соответствия данных самозанятого данным ФНС

Метод для проверки данных (ИНН, ФИО, номер телефона) самозанятого с теми, которые хранятся в ФНС.

Состоит из двух шагов:

  1. Отправьте запрос npd/taxpayer/check_personal_info с ИНН, ФИО и номером телефона самозанятого. В ответе придет request_id.
  2. Передайте этот request_id в метод npd/request/status. В ответе вернется информация о расхождениях с данными ФНС. Если статус pending — повторите запрос позже.

Адрес для отправки запроса npd/taxpayer/check_personal_info

/api/v1/npd/taxpayer/check_personal_info

Параметры запроса npd/taxpayer/check_personal_info

НазваниеОбязательностьТипОписание
first_name+stringИмя самозанятого
second_name+stringФамилия самозанятого
patronymic+stringОтчество самозанятого
tax_reference+stringИНН самозанятого
phone+stringНомер телефона самозанятого в формате 7ХХХХХХХХХХ
Пример запроса npd/taxpayer/check_personal_info
curl -X POST \
https://demo.bank131.ru/api/v1/npd/taxpayer/check_personal_info \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"first_name": "Иван",
"second_name": "Иванов",
"patronymic": "Иванович",
"tax_reference": "123456789012",
"phone": "71234567890"
}'

Параметры ответа на запрос npd/taxpayer/check_personal_info

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok, pending
request_id-stringИдентификатор, который пришел в ответ на запрос npd/taxpayer/check_personal_info
Пример ответа на запрос npd/taxpayer/check_personal_info
{
"status": "ok",
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}

Адрес для отправки запроса npd/request/status

/api/v1/npd/request/status

Параметры запроса npd/request/status

НазваниеОбязательностьТипОписание
request_id+stringИдентификатор, который пришел в ответ на запрос npd/taxpayer/check_personal_info
Пример запроса npd/request/status
curl -X POST \
https://demo.bank131.ru/api/v1/npd/request/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"request_id": "07adcced-8eb8-49c6-82ce-c3ded0b5bda6"
}'

Параметры ответа на запрос npd/request/status

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok, pending
success-booleanРезультат проверки. true — расхождений нет; false — найдены расхождения
violations-array[string]Список параметров, в которых обнаружены расхождения. Возможные значения: "first_name", "second_name", "patronymic", "tax_reference", "phone"
error-objectОшибка
Пример ответа на запрос npd/request/status
{
"status": "ok",
"success": false,
"violations": [
"first_name",
"second_name",
"phone"
]
}

Номинальный счет

session/create/nominal

Создание платежной сессии

Метод создания платежной сессии для выплаты на банковский счет. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.

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

Вы можете создать сессию и запустить выплату одновременно с помощью метода session/init/payout/nominal. Не рекомендуем использовать этот способ.

Адрес для отправки запроса

/api/v1/session/create/nominal

Параметры запроса

НазваниеОбязательностьТипОписание
payment_method-objectПлатежные данные для зачисления средств
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details-objectИнформация об отправителе и получателе
fiscalization_details-objectДанные для фискализации
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/create/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_method": {
"type": "bank_account",
"bank_account": {
"ru": {
"bik": "044525974",
"account": "40817810400003869535",
"full_name": "Иванов Иван Иванович",
"description": "Перевод средств по договору № 5015553111 Иванов Иван Иванович НДС не облагается"
},
"system_type": "ru"
}
},
"amount_details": {
"amount": 300,
"currency": "rub"
},
"participant_details": {
"sender": {
"account": "40702810300200000013"
},
"recipient": {
"beneficiary_id": "1234567890"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_12345",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.586072Z",
"updated_at": "2023-05-10T16:58:43.705620Z",
"payments": [{
"id": "po_72265",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.781934Z",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810900000000001",
"full_name": "Наименование организации",
"description": "Перечисление денежных средств по договору № 1 НС от 01.09.2021 комиссия площадки за декабрь 2022 г. НДС не облагается.",
"is_fast": false,
"kpp": "156605001",
"inn": "3111104710"
}
}
},
"amount_details": {
"amount": 300,
"currency": "rub"
},
"paymentMetadata": {},
"participant_details": {
"sender": {
"account": "40702810300200000013"
},
"recipient": {
"beneficiary_id": "1234567890"
}
}
}]
}
}

session/init/payout/nominal

Создание сессии с одновременным запуском выплаты на банковский счет

Метод для проведения выплаты на банковский счет, в том числе через СБП, без отдельного создания сессии. В этом случае вы передаете все данные сразу.

Адрес для отправки запроса

/api/v1/session/init/payout/nominal

Параметры запроса

НазваниеОбязательностьТипОписание
payment_method+objectПлатежные данные для зачисления средств
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details+objectИнформация об отправителе и получателе
fiscalization_details-objectДанные для фискализации
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Примеры запросов
curl -X POST \
https://demo.bank131.ru/api/v1/session/init/payout/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
// для выплаты через СБП используйте объект faster_payment_system
"ru": {
"bik": "044525974",
"account": "40817810400003869535",
"full_name": "Иванов Иван Иванович",
"description": "Перевод средств по договору № 5015553111 Иванов Иван Иванович НДС не облагается"
}
}
},
"amount_details": {
"amount": 300,
"currency": "rub"
},
"participant_details": {
"sender": {
"account": "40702810300200000013"
},
"recipient": {
"beneficiary_id": "1234567890"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_12345",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.586072Z",
"updated_at": "2023-05-10T16:58:43.705620Z",
"payments": [{
"id": "po_72265",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.781934Z",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810900000000001",
"full_name": "Наименование организации",
"description": "Перечисление денежных средств по договору № 1 НС от 01.09.2021 комиссия площадки за декабрь 2022 г. НДС не облагается.",
"is_fast": false,
"kpp": "156605001",
"inn": "3111104710"
}
}
},
"amount_details": {
"amount": 300,
"currency": "rub"
},
"paymentMetadata": {},
"participant_details": {
"sender": {
"account": "40702810300200000013"
},
"recipient": {
"beneficiary_id": "1234567890"
}
}
}]
}
}

session/multi/create/nominal

Создание платежной сессии

Метод создания платежной сессии для выплаты на карту. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.

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

Вы можете создать сессию и запустить выплату одновременно с помощью метода session/multi/init/payment/nominal. Не рекомендуем использовать этот способ.

Адрес для отправки запроса

/api/v1/session/multi/create/nominal

Параметры запроса

НазваниеОбязательностьТипОписание
payment_details-objectПлатежные данные для списания средств
payment_method-objectПлатежные данные для зачисления средств
fiscalization_details-objectДанные для фискализации
participant_details-objectИнформация об отправителе и получателе
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer-objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/multi/create/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_nominal_account",
"transfer_from_nominal_account": {
"description": "Назначение платежа"
}
}
},
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "****************"
}
}
},
"participant_details": {
"sender": {
"full_name": "Данные отправителя",
"beneficiary_id": "1234567890"
},
"recipient": {
"full_name": "Иванов Иван Иванович"
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"customer": {
"reference": "123456789012"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_12345",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.274416Z",
"updated_at": "2021-08-06T11:34:51.466550Z",
"payments": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "0002"
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}],
"acquiring_payments": [{
"id": "pm_15174",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545232Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_nominal_account",
"transfer_from_nominal_account": {
"description": "test payout",
"card_mask": "400000******0002"
}
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}]
}
}

session/multi/init/payment/nominal

Создание сессии с одновременным запуском выплаты на банковскую карту

Метод для проведения выплаты на банковскую карту без отдельного создания сессии. В этом случае вы передаете все данные сразу.

Адрес для отправки запроса

/api/v1/session/multi/init/payment/nominal

Параметры запроса

НазваниеОбязательностьТипОписание
payment_details+objectПлатежные данные для списания средств
payment_method+objectПлатежные данные для зачисления средств
fiscalization_details-objectДанные для фискализации
participant_details+objectИнформация об отправителе и получателе
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer+objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/multi/init/payment/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_nominal_account",
"transfer_from_nominal_account": {
"description": "test payout"
}
}
},
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242"
}
}
},
"participant_details": {
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"beneficiary_id": "123412341234"
},
"sender": {
"full_name": "Ivan Ivanovich Ivanov",
"beneficiary_id": "123412341234"
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"customer": {
"reference": "test"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_12345",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.274416Z",
"updated_at": "2021-08-06T11:34:51.466550Z",
"payments": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "0002"
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}],
"acquiring_payments": [{
"id": "pm_15174",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545232Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_nominal_account",
"transfer_from_nominal_account": {
"description": "test payout",
"card_mask": "400000******0002"
}
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}]
}
}

session/multi/start/payment/nominal

Запуск выплаты на банковскую карту

Метод для запуска выплаты в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.

Адрес для отправки запроса

/api/v1/session/multi/start/payment/nominal

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
payment_details+objectПлатежные данные для списания средств
payment_method+objectПлатежные данные для зачисления средств
fiscalization_details-objectДанные для фискализации
participant_details+objectИнформация об отправителе и получателе
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer+objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/multi/start/payment/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_12345",
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_nominal_account",
"transfer_from_nominal_account": {
"description": "test payout"
}
}
},
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242"
}
}
},
"participant_details": {
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"beneficiary_id": "123412341234"
},
"sender": {
"full_name": "Ivan Ivanovich Ivanov",
"beneficiary_id": "123412341234"
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"customer": {
"reference": "test"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_72974",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.274416Z",
"updated_at": "2021-08-06T11:34:51.466550Z",
"payments": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "0002"
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}],
"acquiring_payments": [{
"id": "pm_15174",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545232Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_nominal_account",
"transfer_from_nominal_account": {
"description": "test payout",
"card_mask": "400000******0002"
}
}
},
"amount_details": {
"amount": 30000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}]
}
}

session/start/payout/nominal

Запуск выплаты на банковский счет

Метод для запуска выплаты на банковский счет, в том числе через СБП, в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.

Адрес для отправки запроса

/api/v1/session/start/payout/nominal

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
payment_method+objectПлатежные данные для зачисления средств
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details+objectИнформация об отправителе и получателе
fiscalization_details-objectДанные для фискализации
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Примеры запросов
curl -X POST \
https://demo.bank131.ru/api/v1/session/start/payout/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_12345",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
// для выплаты через СБП используйте объект faster_payment_system
"ru": {
"bik": "044525974",
"account": "40817810400003869535",
"full_name": "Иванов Иван Иванович",
"description": "Перевод средств по договору № 5015553111 Иванов Иван Иванович НДС не облагается"
}
}
},
"amount_details": {
"amount": 30000,
"currency": "rub"
},
"participant_details": {
"sender": {
"account": "40702810300200000013"
},
"recipient": {
"beneficiary_id": "1234567890"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_12345",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.586072Z",
"updated_at": "2023-05-10T16:58:43.705620Z",
"payments": [{
"id": "po_72265",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.781934Z",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810900000000001",
"full_name": "Наименование организации",
"description": "Перечисление денежных средств по договору № 1 НС от 01.09.2021 комиссия площадки за декабрь 2022 г. НДС не облагается.",
"is_fast": false,
"kpp": "156605001",
"inn": "3111104710"
}
}
},
"amount_details": {
"amount": 30000,
"currency": "rub"
},
"paymentMetadata": {},
"participant_details": {
"sender": {
"account": "40702810300200000013"
},
"recipient": {
"beneficiary_id": "1234567890"
}
}
}]
}
}

Расчетный счет

session/create/rko

Создание платежной сессии

Метод создания платежной сессии для выплаты на банковский счет. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.

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

Вы можете создать сессию и запустить выплату одновременно с помощью метода session/init. Не рекомендуем использовать этот способ.

Адрес для отправки запроса

/api/v1/session/create/rko

Параметры запроса

НазваниеОбязательностьТипОписание
payment_method-objectПлатежные данные для зачисления средств
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details-objectИнформация об отправителе и получателе
fiscalization_details-objectДанные для фискализации
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/create/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810300000000006",
"full_name": "Вектор",
"inn": "1234567890",
"kpp": "165801002",
"description": "Перевод с расчетного счета на счет другого ЮЛ, открытого в Банке 131"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"participant_details": {
"sender": {
"account": "40702810900000000011"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810300000000006",
"full_name": "Вектор",
"inn": "1234567890",
"kpp": "165801002",
"description": "Перевод с расчетного счета на счет другого ЮЛ, открытого в Банке 131"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}

session/init/payout/rko

Создание сессии с одновременным запуском выплаты на банковский счет

Метод для проведения выплаты на банковский счет, в том числе через СБП, без отдельного создания сессии. В этом случае вы передаете все данные сразу.

Адрес для отправки запроса

/api/v1/session/init/payout/rko

Параметры запроса

НазваниеОбязательностьТипОписание
payment_method+objectПлатежные данные для зачисления средств
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details+objectИнформация об отправителе и получателе
fiscalization_details-objectДанные для фискализации
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/init/payout/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810300000000006",
"full_name": "Вектор",
"inn": "1234567890",
"kpp": "165801002",
"description": "Перевод с расчетного счета на счет другого ЮЛ, открытого в Банке 131"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"participant_details": {
"sender": {
"account": "40702810900000000011"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810300000000006",
"full_name": "Вектор",
"inn": "1234567890",
"kpp": "165801002",
"description": "Перевод с расчетного счета на счет другого ЮЛ, открытого в Банке 131"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}

session/multi/create/rko

Создание платежной сессии

Метод создания платежной сессии для выплаты на банковскую карту. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.

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

Вы можете создать сессию и запустить выплату одновременно с помощью метода session/init. Не рекомендуем использовать этот способ.

Адрес для отправки запроса

/api/v1/session/multi/create/rko

Параметры запроса

НазваниеОбязательностьТипОписание
payment_details-objectПлатежные данные для списания средств
payment_method-objectПлатежные данные для зачисления средств
fiscalization_details-objectДанные для фискализации
participant_details-objectИнформация об отправителе и получателе
amount_details-objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer-objectДанные получателя в вашей системе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/multi/create/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_bank_account",
"transfer_from_bank_account": {
"description": "Назначение платежа"
}
}
},
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "****************"
}
}
},
"participant_details": {
"sender": {
"full_name": "Данные отправителя"
},
"recipient": {
"full_name": "Иванов Иван Иванович"
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"customer": {
"reference": "123456789012"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_12345",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.274416Z",
"updated_at": "2021-08-06T11:34:51.466550Z",
"payments": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "0002"
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}],
"acquiring_payments": [{
"id": "pm_15174",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545232Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_bank_account",
"transfer_from_bank_account": {
"description": "test payout",
"card_mask": "400000******0002"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}]
}
}

session/multi/init/payment/rko

Создание сессии с одновременным запуском выплаты на банковскую карту

Метод для проведения выплаты на банковскую карту без отдельного создания сессии. В этом случае вы передаете все данные сразу.

Адрес для отправки запроса

/api/v1/session/multi/init/payment/rko

Параметры запроса

НазваниеОбязательностьТипОписание
payment_details+objectПлатежные данные для списания средств
payment_method+objectПлатежные данные для зачисления средств
customer+objectДанные получателя в вашей системе
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
fiscalization_details-objectДанные для фискализации
participant_details+objectИнформация об отправителе и получателе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/multi/init/payment/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_bank_account",
"transfer_from_bank_account": {
"description": "test payout"
}
}
},
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242"
}
}
},
"participant_details": {
"recipient": {
"full_name": "Ivan Ivanovich Ivanov"
},
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"customer": {
"reference": "test"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.274416Z",
"updated_at": "2021-08-06T11:34:51.466550Z",
"payments": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "0002"
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}],
"acquiring_payments": [{
"id": "pm_15174",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545232Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_bank_account",
"transfer_from_bank_account": {
"description": "test payout",
"card_mask": "400000******0002"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}]
}
}

session/multi/start/payment/rko

Запуск выплаты на банковскую карту

Метод для запуска выплаты в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.

Адрес для отправки запроса

/api/v1/session/multi/start/payment/rko

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
payment_details+objectПлатежные данные для списания средств
payment_method+objectПлатежные данные для зачисления средств
customer+objectДанные получателя в вашей системе
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
fiscalization_details-objectДанные для фискализации
participant_details+objectИнформация об отправителе и получателе
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/multi/start/payment/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_12345",
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_bank_account",
"transfer_from_bank_account": {
"description": "test payout"
}
}
},
"payment_method": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242"
}
}
},
"participant_details": {
"recipient": {
"full_name": "Ivan Ivanovich Ivanov"
},
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"customer": {
"reference": "test"
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_12345",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.274416Z",
"updated_at": "2021-08-06T11:34:51.466550Z",
"payments": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payment_method": {
"type": "card",
"card": {
"brand": "visa",
"last4": "0002"
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}],
"acquiring_payments": [{
"id": "pm_15174",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545232Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "internal_transfer",
"internal_transfer": {
"type": "transfer_from_bank_account",
"transfer_from_bank_account": {
"description": "test payout",
"card_mask": "400000******0002"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "RUB"
},
"metadata": {
"key": "value"
},
"participant_details": {
"sender": {
"full_name": "Ivan Ivanovich Ivanov"
},
"recipient": {
"full_name": "Ivan Ivanovich Ivanov",
"reference": "1234"
}
}
}]
}
}

session/start/payout/rko

Запуск выплаты на банковский счет

Метод для запуска выплаты на банковский счет, в том числе через СБП, в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.

Адрес для отправки запроса

/api/v1/session/start/payout/rko

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии
payment_method+objectПлатежные данные для зачисления средств
amount_details+objectСумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details+objectИнформация об отправителе и получателе
fiscalization_details-objectДанные для фискализации
metadata-*Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v1/session/start/payout/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810300000000006",
"full_name": "Вектор",
"inn": "1234567890",
"kpp": "165801002",
"description": "Перевод с расчетного счета на счет другого ЮЛ, открытого в Банке 131"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"participant_details": {
"sender": {
"account": "40702810900000000011"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session-objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"updated_at": "2025-05-27T02:03:00.000000Z",
"payments": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "049205131",
"account": "40702810300000000006",
"full_name": "Вектор",
"inn": "1234567890",
"kpp": "165801002",
"description": "Перевод с расчетного счета на счет другого ЮЛ, открытого в Банке 131"
}
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}

Денежные переводы

calculate

Конвертация валюты при денежном переводе

Метод для расчета конвертации валюты для денежного перевода.

Конвертация может проходить по прямому или обратному курсу:

  • Прямой курс — укажите сумму перевода в рублях, чтобы рассчитать сумму к получению в целевой валюте.
  • Обратный курс — укажите сумму к получению в целевой валюте, чтобы рассчитать, сколько рублей нужно отправить.

Адрес для отправки запроса

/api/v1/calculate

Параметры запроса

НазваниеОбязательностьТип данныхОписание
amounts+objectСумма и валюта конвертации
  source+objectСумма и валюта списания с отправителя
    amount+numberСумма списания в минорных единицах валюты. Для прямого курса — сумма к списанию; для обратного — null
    currency+stringКод валюты согласно ISO 4217. Регистр не важен. Значение rub обязательно должно быть указано в одном из объектов: source.currency или destination.currency
  destination+objectСумма и валюта зачисления получателю
    amount+numberСумма зачисления в минорных единицах валюты. Для обратного курса — сумма к получению; для прямого — null
    currency+stringКод валюты согласно ISO 4217. Регистр не важен. Значение rub обязательно должно быть указано в одном из объектов: source.currency или destination.currency
Примеры запросов
curl -X POST \
https://demo.bank131.ru/api/v1/calculate \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"amounts": {
"source": {
"amount": 357912,
"currency": "RUB"
},
"destination": {
"amount": null,
"currency": "TRY"
}
}
}'

Параметры ответа

НазваниеОбязательностьТипОписание
amounts+objectРасчет суммы конвертации
  source+objectСумма и валюта списания с отправителя
    amount+numberСумма списания в валюте отправителя (рублях)
    currency+stringКод валюты списания согласно ISO 4217. Регистр не важен
  destination+objectСумма и валюта зачисления получателю
    amount+numberСумма к получению в целевой валюте
    currency+stringКод валюты получения согласно ISO 4217. Регистр не важен
  transfer_fee+objectКомиссия за перевод, списывается с отправителя
    amount+numberСумма комиссии за перевод
    currency+stringКод валюты согласно ISO 4217. Регистр не важен. Пример: rub
  sms_fee+objectКомиссия за СМС-уведомление получателю
    amount+numberСумма комиссии за СМС
    currency+stringКод валюты согласно ISO 4217. Регистр не важен. Пример: rub
  payment+objectИтоговая сумма к списанию с отправителя
    amount+numberСумма к списанию с учетом всех комиссий: source + transfer_fee + sms_fee
    currency+stringКод валюты согласно ISO 4217. Регистр не важен. Пример: rub
exchanges+objectДанные о курсе конвертации
  source+objectСумма и валюта списания, переданные в запросе
    amount+numberСумма списания в минорных единицах валюты. Для обратного курса — null
    currency+stringКод валюты согласно ISO 4217. Регистр не важен
  destination+objectСумма и валюта зачисления, переданные в запросе
    amount+numberСумма зачисления в минорных единицах валюты. Для прямого курса — null
    currency+stringКод валюты согласно ISO 4217. Регистр не важен
  rate+objectКурс валюты
    fx_rate+numberКурс валюты получения к валюте списания, с четырьмя знаками после запятой. Например: 75.0145
    quantity+numberКоличество единиц валюты. Для части валют расчет ведется десятками, сотнями или тысячами единиц — актуальные значения на сайте ЦБ РФ
error-objectОшибка
Примеры ответов
{
"amounts": {
"source": {
"amount": 357913,
"currency": "RUB"
},
"destination": {
"amount": 131426,
"currency": "TRY"
},
"transfer_fee": {
"amount": 0,
"currency": "RUB"
},
"sms_fee": {
"amount": 0,
"currency": "RUB"
},
"payment": {
"amount": 5400,
"currency": "RUB"
}
},
"exchanges": {
"source": {
"amount": 357912,
"currency": "RUB"
},
"destination": {
"amount": null,
"currency": "TRY"
},
"rate": {
"fx_rate": 2.7233,
"quantity": 1
}
}
}

session/multi/init

Создание мультисессии с одновременным запуском трансграничного перевода

Метод для создания мультисессии и запуска трансграничного перевода — списания средств с отправителя и выплаты получателю без отдельного создания сессии.

Адрес для отправки запроса

/api/v2/session/multi/init

Параметры запроса

НазваниеОбязательностьТип данныхОписание
payment_list+arrayСписок операций списания с отправителя
  amount_details+objectСумма. Дублирует payout_list.amount_details
    amount+numberЗначение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
    currency+stringКод валюты согласно ISO 4217. Регистр не важен
  customer+objectДанные пользователя в вашей системе
    reference+stringИдентификатор пользователя в вашей системе
  participant_details+objectИнформация об отправителе перевода
    sender+objectДанные отправителя
      first_name+stringИмя
      last_name+stringФамилия
      middle_name-stringОтчество
      tax_reference+string12-значный ИНН отправителя
      date_of_birth+stringДата рождения отправителя в формате ГГГГ-ММ-ДД. Отправителю должно быть 18+
      identity_document+objectДанные документа, удостоверяющего личность отправителя
        id_type+stringТип документа:
- Паспорт гражданина Российской Федерации
- Паспорт иностранного гражданина
        id_number+stringСерия и номер документа (без пробелов)
        issue_date+stringДата выдачи документа в формате ГГГГ-ММ-ДД
        id_expiration_date-stringДата окончания срока действия документа нерезидента в формате ГГГГ-ММ-ДД
        division_code-stringКод подразделения, выдавшего документ. Обязателен, если указан в документе
        issued_by-stringНазвание подразделения, выдавшего документ. Обязательно, если указано в документе
      citizenship_country_iso3+stringСтрана гражданства отправителя согласно ISO 3166-1 alpha-3
      contacts+arrayКонтакты отправителя
        email-stringЭлектронная почта
        phone+objectДанные телефона
          full_number+stringПолный номер телефона в формате +<код страны><номер>
          country_iso3-stringКод страны номера телефона согласно ISO 3166-1 alpha-3. Только для переводов в Турцию с выдачей наличных
          operator_code-stringКод оператора. Только для переводов в Турцию с выдачей наличных
          short_number-stringНомер без кода оператора. Только для переводов в Турцию с выдачей наличных
      country_iso3+stringКод страны согласно ISO 3166-1 alpha-3
      postal_code-stringПочтовый индекс места регистрации отправителя
      state-stringРегион или район регистрации отправителя
      city+stringНаселенный пункт регистрации отправителя
      street-stringУлица регистрации отправителя
      building+stringНомер дома регистрации отправителя
      flat-stringКвартира регистрации отправителя
  payment_options-objectДополнительные параметры платежа
    return_url-stringВалидный URL для перенаправления пользователя после платежа
    recurrent-booleanПровести платеж по сохраненному токену карты. Токен указывается в payment_details
  payment_details+objectДанные для списания средств
    type+stringСпособ списания:
- card — банковская карта,
- recurrent — транзакция по ранее сохраненной карте
    card-objectДанные банковской карты для type = card
    recurrent-objectТокен банковской карты для type = recurrent
payout_list+arrayСписок операций выплаты получателю
  amount_details+objectСумма. Дублирует payment_list.amount_details
    amount+numberСумма в минорных единицах валюты. Чтобы передать 100 рублей, укажите 10000
    currency+stringКод валюты согласно ISO 4217. Регистр не важен
  participant_details+objectИнформация о получателе перевода
    recipient+objectДанные получателя
      first_name+stringИмя
      last_name+stringФамилия
      middle_name-stringОтчество
      tax_reference-string12-значный ИНН получателя
      date_of_birth-stringДата рождения в формате ГГГГ-ММ-ДД. Получателю должно быть 18+
      identity_document-objectДанные документа, удостоверяющего личность
        id_type+stringТип документа:
- Паспорт гражданина Российской Федерации
- Паспорт иностранного гражданина
        id_number+stringСерия и номер документа (без пробелов)
        issue_date+stringДата выдачи документа в формате ГГГГ-ММ-ДД
        id_expiration_date-stringДата окончания срока действия документа нерезидента в формате ГГГГ-ММ-ДД
        division_code-stringКод подразделения, выдавшего документ. Обязателен, если указан в документе
        issued_by-stringНазвание подразделения, выдавшего документ. Обязательно, если указано в документе
      citizenship_country_iso3+stringСтрана гражданства согласно ISO 3166-1 alpha-3
      contacts+arrayКонтакты получателя
        email-stringЭлектронная почта
        phone+objectДанные телефона
          full_number+stringПолный номер телефона в формате +<код страны><номер>
          country_iso3-stringКод страны номера телефона согласно ISO 3166-1 alpha-3. Только для переводов в Турцию с выдачей наличных
          operator_code-stringКод оператора. Только для переводов в Турцию с выдачей наличных
          short_number-stringНомер без кода оператора. Только для переводов в Турцию с выдачей наличных
      purpose-stringНазначение перевода. Для recipient.country_iso3 = AZE:
- gift (подарок),
- donation (пожертвование),
- support (помощь),
- education (оплата за образование),
- other (другое)
      country_iso3-stringКод страны согласно ISO 3166-1 alpha-3
      postal_code-stringПочтовый индекс места регистрации получателя
      state-stringРегион или район регистрации получателя
      city-stringНаселенный пункт регистрации получателя
      street-stringУлица регистрации получателя
      building-stringНомер дома регистрации получателя
      flat-stringКвартира регистрации получателя
  payout_details+objectДанные для зачисления средств
    type+stringСпособ получения выплаты:
- card (на банковскую карту),
- bank_account (по IBAN),
- tokenized_card (на ранее сохраненную банковскую карту),
- moneysend (наличными)
    card-objectДанные банковской карты для type = card
    bank_account-objectДанные IBAN для type = bank_account
    tokenized_card-objectТокен банковской карты для type = tokenized_card
    moneysend-objectОбъект для перевода наличными. Передается пустым: {}
Примеры запросов
curl -X POST \
https://demo.bank131.ru/api/v2/session/multi/init \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payment_list": [{
"amount_details": { // Дублируется в payout_list, суммы и валюта должны совпасть
"amount": 37700,
"currency": "TJS"
},
"customer": {
"reference": "lucky"
},
"participant_details": {
"sender": {
"citizenship_country_iso3": "TRY",
"first_name": "Ольга",
"last_name": "Зайцева",
"middle_name": "Александровна",
"country_iso3": "RUS",
"state": "Московская область",
"city": "Уренгой",
"postal_code": "119900",
"street": "Конаковская",
"building": "99",
"flat": "1",
"date_of_birth": "1998-03-15",
"identity_document": {
"id_type": "Паспорт иностранного гражданина",
"id_number": "8008 579120",
"issue_date": "2025-03-01"
},
"contacts": {
"phone": {
"full_number": "+79376151530",
"country_iso3": "TJK",
"operator_code": "937",
"short_number": "6151530"
},
"email": "sender@test.com"
}
}
},
"payment_options": {
"return_url": "https://www.131.ru/"
},
"payment_details": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4111111111111111"
}
}
}
}],
"payout_list": [{ // Дублируется в payment_list, суммы и валюта должны совпасть
"amount_details": {
"amount": 37700,
"currency": "TJS"
},
"participant_details": {
"recipient": {
"first_name": "Sidor",
"last_name": "Sidorov",
"middle_name": "Sidorovich",
"date_of_birth": "2000-11-08",
"country_iso3": "TJK",
"citizenship_country_iso3": "TJK",
"contacts": {
"phone": {
"full_number": "+43523452345",
"country_iso3": "TJK",
"operator_code": "352",
"short_number": "3452345"
},
"email": "recipient@test.tr"
}
}
},
"payout_details": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "2204320396205389"
}
}
}
}]
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
session+objectПлатежная сессия
error-objectОшибка
Примеры ответов
{
"status": "ok",
"session": {
"id": "ps_3808365",
"status": "in_progress",
"created_at": "2025-08-08T12:39:15.668563Z",
"updated_at": "2025-08-08T12:39:16.388348Z",
"payout_list": [{
"id": "po_955259",
"status": "in_progress",
"created_at": "2025-08-08T12:39:16.439833Z",
"payout_details": {
"type": "card",
"card": {
"brand": "mir",
"last4": "5389",
"country_iso3": "RUS"
}
},
"amount_details": {
"amount": 37700,
"currency": "TJS"
},
"amounts": {},
"payment_metadata": {},
"participant_details": {
"recipient": {
"full_name": "Sidor Sidorov Sidorovich",
"first_name": "Sidor",
"last_name": "Sidorov",
"middle_name": "Sidorovich",
"country_iso3": "TJK",
"date_of_birth": "2000-11-08",
"citizenship_country_iso3": "TJK",
"contacts": {
"phone": {
"full_number": "+43523452345",
"country_iso3": "TJK",
"operator_code": "352",
"short_number": "3452345"
},
"email": "recipient@test.tr"
}
}
}
}],
"payment_list": [{
"id": "pm_2765898",
"status": "in_progress",
"created_at": "2025-08-08T12:39:16.439730Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "card",
"card": {
"brand": "visa",
"last4": "1111",
"country_iso3": "POL"
}
},
"amount_details": {
"amount": 37700,
"currency": "TJS"
},
"amounts": {},
"participant_details": {
"sender": {
"full_name": "Ольга Зайцева Александровна",
"first_name": "Ольга",
"last_name": "Зайцева",
"middle_name": "Александровна",
"country_iso3": "RUS",
"city": "Уренгой",
"postal_code": "119900",
"building": "99",
"date_of_birth": "1998-03-15",
"street": "Конаковская",
"flat": "1",
"state": "Московская область",
"identity_document": {
"id_type": "Паспорт иностранного гражданина",
"id_number": "8008 579120",
"issue_date": "2025-03-01"
},
"citizenship_country_iso3": "TRY",
"contacts": {
"phone": {
"full_number": "+79376151530",
"country_iso3": "TJK",
"operator_code": "937",
"short_number": "6151530"
},
"email": "sender@test.com"
}
}
},
"payment_options": {
"return_url": "https://www.131.ru/",
"recurrent": false
}
}]
}
}

Прочее

sberpay/push

Проверка статуса оплаты

Метод для запроса статуса оплаты через SberPay.

Адрес для отправки запроса

/api/v1/sberpay/push

Параметры запроса

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор сессии
phone+stringНомер телефона для отправки push-уведомления
Пример запроса
curl -X GET \
https://demo.bank131.ru/api/v1/sberpay/push \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_75459435",
"phone": "+79638594ххх"
}'

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус. Возможные значения: error, ok
error-objectОшибка
Примеры ответов
{
"status": "ok"
}