Методы
При обработке запросов проверяются корректность переданных данных, наличие обязательных заголовков, а также права пользователя на выполнение действий.
В документации указано, какие параметры являются обязательными для каждой операции. Но их необязательно передавать в теле этого конкретного запроса — их можно передать заранее при создании сессии.
Пример отправки запроса на выплату:
- Если запрос
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
- PHP
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"
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->disableRecurrentRequestBuilder()
->setRecurrentToken('e9876f32bcd947f79c324cf2da5726304a894f6ae2037de7705fdb3e0a134d39')
->build();
$response = $client->recurrent()->disable($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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
- API v2
Адрес для отправки запроса
/api/v1/session/cancel
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии |
Пример запроса
- cURL
- PHP
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"
}'
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->cancel('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/cancel
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/session/cancel \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->cancel('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payout_list": [{
"id": "po_2025",
"status": "pending",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/capture
Списание захолдированной суммы
Метод для списания ранее захолдированных средств после получения вебхука ready_to_capture от Банка 131. Вы можете списать как полную сумму, так и ее часть.
- API v1
- API v2
Адрес для отправки запроса
/api/v1/session/capture
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии |
amount_details | - | object | Сумма. Может быть меньше захолдированной, но обязательно больше 0. Если параметр отсутствует, захолдированная сумма будет списана полностью |
Пример запроса
- cURL
- PHP
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"
}'
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->capture('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}
}]
}]
}
}
{
"error": {
"code": "error code",
"description": "error description"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/capture
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии |
amount_details | - | object | Сумма. Может быть меньше захолдированной, но обязательно больше 0. Если параметр отсутствует, захолдированная сумма будет списана полностью |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/session/capture \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->capture('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payment_list": [{
"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"
}
}]
}]
}
}
{
"error": {
"code": "error code",
"description": "error description"
},
"status": "error"
}
session/confirm
Подтверждение операции
Метод для подтверждения выплаты или платежа после получения вебхука ready_to_confirm или ready_to_capture от Банка 131. Запрос нужно отправить в течение 4 часов с момента создания операции, иначе вернется ошибка confirm_timeout.
- API v1
- API v2
Адрес для отправки запроса
/api/v1/session/confirm
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии |
confirm_information | - (обязательно при операциях с расчетным и номинальным счетами, а также при денежных переводах) | object | Информация для подтверждения операции |
Пример запроса
- cURL
- PHP
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"
}'
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->confirm('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/confirm
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии |
confirm_information | - (обязательно при операциях с расчетным и номинальным счетами, а также при денежных переводах) | object | Информация для подтверждения операции |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/session/confirm \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->confirm('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payout_list": [{
"id": "po_2025",
"status": "pending",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/create
Создание платежной сессии
Метод для создания платежной сессии. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.
Этот метод обязателен при платежах через виджет, так как для генерации публичного токена нужен session_id. Токен связывает данные карты, введенные пользователем, с конкретной сессией. Без этого Банк 131 не сможет определить, к какому платежу относятся введенные данные и вебхуки.
Если вы принимаете платеж через СБП, обязательно передайте faster_payment_system в payment_details.
Вы можете создать сессию и запустить выплату/платеж одновременно с помощью метода
session/init. Не рекомендуем использовать этот способ.
- API v1
- API v2
Адрес для отправки запроса
/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
- PHP
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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->createPaymentSession() //OR ->createPayoutSession()
->setAmount(10000, 'rub')
->setMetadata('order123')
->build();
$response = $client->session()->create($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}
}
{
"error": {
"code": "invalid_request",
"description": "customer.reference.not_blank"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/create
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | - | object | Платежные данные для зачисления средств |
payment_details | - | object | Платежные данные для списания средств |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
fiscalization_details | - | object | Данные для фискализации |
participant_details | - (обязательно для выплат) | object | Информация об отправителе и получателе |
customer | - (обязательно для платежей) | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->createPaymentSession() //OR ->createPayoutSession()
->setAmount(10000, 'rub')
->setMetadata('order123')
->build();
$response = $client->session()->create($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}
}
{
"error": {
"code": "invalid_request",
"description": "customer.reference.not_blank"
},
"status": "error"
}
session/init/payment
Создание сессии с одновременным запуском платежа
Метод для проведения платежа без отдельного создания сессии. В этом случае вы передаете все данные сразу.
В ответе возвращаются параметры созданной сессии с информацией о платеже (acquiring_payments/payment_list).
- API v1
- API v2
Адрес для отправки запроса
/api/v1/session/init/payment
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payment_details | + | object | Платежные данные для списания средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | - | object | Информация об отправителе и получателе |
customer | + | object | Данные плательщика в вашей системе |
payment_options | - | object | Дополнительные параметры платежа |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
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"
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
use Bank131\SDK\DTO\Customer;
use Bank131\SDK\DTO\PaymentOptions;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$paymentOptions = new PaymentOptions();
$paymentOptions->setReturnUrl('http://bank131.ru');
$request = RequestBuilderFactory::create()
->initPaymentSession()
->setCard(new BankCard('4242424242424242', '05', '22', '123'))
->setAmount(10000, 'rub')
->setCustomer(new Customer('lucky'))
->setPaymentOptions($paymentOptions)
->build();
$response = $client->session()->initPayment($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}
}]
}
}
{
"error": {
"code": "invalid_request",
"description": "customer.reference.not_blank"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/init/payment
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payment_details | + | object | Платежные данные для списания средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | - | object | Информация об отправителе и получателе |
customer | + | object | Данные плательщика в вашей системе |
payment_options | - | object | Дополнительные параметры платежа |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
use Bank131\SDK\DTO\Customer;
use Bank131\SDK\DTO\PaymentOptions;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$paymentOptions = new PaymentOptions();
$paymentOptions->setReturnUrl('http://bank131.ru');
$request = RequestBuilderFactory::create()
->initPaymentSession()
->setCard(new BankCard('4242424242424242', '05', '22', '123'))
->setAmount(10000, 'rub')
->setCustomer(new Customer('lucky'))
->setPaymentOptions($paymentOptions)
->build();
$response = $client->session()->initPayment($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payment_list": [{
"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"
}
}]
}
}
{
"error": {
"code": "invalid_request",
"description": "customer.reference.not_blank"
},
"status": "error"
}
session/init/payment/sync
Не рекомендуем использовать этот метод.
Метод для платежа одним запросом. Подходит, если вы не используете виджет.
При использовании этого метода вебхуки не отправляются. Результат платежа возвращается в ответе на этот же запрос.
Подробнее о платеже одним запросом >
- API v1
- API v2
Адрес для отправки запроса
/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
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"
}
}]
}
}
{
"error": {
"code": "invalid_request",
"description": "customer.reference.not_blank"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/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
curl -X POST \
https://demo.bank131.ru/api/v2/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",
"payment_list": [{
"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"
}
}]
}
}
{
"error": {
"code": "invalid_request",
"description": "customer.reference.not_blank"
},
"status": "error"
}
session/init/payout
Создание сессии с одновременным запуском выплаты
Метод для проведения выплаты без отдельного создания сессии. В этом случае вы передаете все данные сразу.
В ответе возвращаются параметры созданной сессии и информация о выплате (payments/payout_list).
- API v1
- API v2
Адрес для отправки запроса
/api/v1/session/init/payout
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payment_method | + | object | Платежные данные для зачисления средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
fiscalization_details | - | object | Данные для фискализации |
participant_details | - | object | Информация об отправителе и получателе |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
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"
}
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->initPayoutSession()
->setCard(new BankCard('4242424242424242'))
->setAmount(1000, 'rub')
->build();
$response = $client->session()->initPayout($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/init/payout
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | + | object | Платежные данные для зачисления средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
fiscalization_details | - | object | Данные для фискализации |
participant_details | - | object | Информация об отправителе и получателе |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/session/init/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payout_details": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242424242424242"
}
}
},
"amount_details": {
"amount": 1000,
"currency": "rub"
},
"participant_details": {
"recipient": {
"full_name": "Ivanov Ivan"
}
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->initPayoutSession()
->setCard(new BankCard('4242424242424242'))
->setAmount(1000, 'rub')
->build();
$response = $client->session()->initPayout($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payout_list": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/init/payout/fiscalization
Создание сессии с одновременным запуском выплаты с фискализацией
Метод для проведения выплаты самозанятому с фискализацией без отдельного создания сессии. В этом случае вы передаете все данные сразу, включая информацию для фискализации.
В ответе возвращаются параметры созданной сессии и информация о выплате (payments/payout_list) с данными для отправки чека.
- API v1
- API v2
Адрес для отправки запроса
/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
- PHP
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"
}
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
use Bank131\SDK\DTO\Collection\FiscalizationServiceCollection;
use Bank131\SDK\DTO\FiscalizationService;
use Bank131\SDK\DTO\Participant;
use Bank131\SDK\DTO\ProfessionalIncomeTaxpayer;
use Bank131\SDK\DTO\Amount;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$services = new FiscalizationServiceCollection();
$services[] = new FiscalizationService(
'Доставка товара',
new Amount(5000, 'rub'),
1
);
$incomeInformation = new ProfessionalIncomeTaxpayer(
$services,
'590000000000'
);
$incomeInformation->setPayerName('ООО Вектор');
$incomeInformation->setPayerType('legal');
$incomeInformation->setPayerTaxNumber('330000000000');
$recipient = new Participant();
$recipient->setFullName('Ivanov Ivan');
$request = RequestBuilderFactory::create()
->initPayoutSessionWithFiscalization()
->setIncomeInformation($incomeInformation)
->setCard(new BankCard('4242424242424242'))
->setAmount(5000, 'rub')
->setRecipient($recipient)
->setMetadata('good')
->build();
$response = $client->session()->initPayoutWithFiscalization($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}
}
}]
}
}
{
"error": {
"code": "invalid_request",
"description": "participant_details.recipient.full_name.not_blank"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/init/payout/fiscalization
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | - | object | Платежные данные для зачисления средств |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
fiscalization_details | - | object | Данные для фискализации |
participant_details | - | object | Информация об отправителе и получателе |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}
}]
}
},
"payout_details": {
"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"
}
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
use Bank131\SDK\DTO\Collection\FiscalizationServiceCollection;
use Bank131\SDK\DTO\FiscalizationService;
use Bank131\SDK\DTO\Participant;
use Bank131\SDK\DTO\ProfessionalIncomeTaxpayer;
use Bank131\SDK\DTO\Amount;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$services = new FiscalizationServiceCollection();
$services[] = new FiscalizationService(
'Доставка товара',
new Amount(5000, 'rub'),
1
);
$incomeInformation = new ProfessionalIncomeTaxpayer(
$services,
'590000000000'
);
$incomeInformation->setPayerName('ООО Вектор');
$incomeInformation->setPayerType('legal');
$incomeInformation->setPayerTaxNumber('330000000000');
$recipient = new Participant();
$recipient->setFullName('Ivanov Ivan');
$request = RequestBuilderFactory::create()
->initPayoutSessionWithFiscalization()
->setIncomeInformation($incomeInformation)
->setCard(new BankCard('4242424242424242'))
->setAmount(5000, 'rub')
->setRecipient($recipient)
->setMetadata('good')
->build();
$response = $client->session()->initPayoutWithFiscalization($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payout_list": [{
"id": "po_2909",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"payout_details": {
"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"
}
}
}]
}
}
{
"error": {
"code": "invalid_request",
"description": "participant_details.recipient.full_name.not_blank"
},
"status": "error"
}
session/refund
Возврат платежа
Метод для возврата денег пользователю после успешного платежа. Можно вернуть всю сумму или часть. Отменить возврат нельзя — перед отправкой запроса убедитесь, что это действительно необходимо.
После проведения возврата Банк 131 отправит вам вебхук payment_refunded с результатом возврата.
- API v1
- API v2
Адрес для отправки запроса
/api/v1/session/refund
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии из платежа, который нужно вернуть |
amount_details | - | object | Сумма. Если не указать, вернется вся сумма платежа |
metadata | - | * | Дополнительная информация |
Пример запроса
- cURL
- PHP
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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->refundSession('ps_3230')
->build();
$response = $client->session()->refund($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}
}]
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/refund
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор сессии из платежа, который нужно вернуть |
amount_details | - | object | Сумма. Если не указать, вернется вся сумма платежа |
metadata | - | * | Дополнительная информация |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/session/refund \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->refundSession('ps_3230')
->build();
$response = $client->session()->refund($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payment_list": [{
"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"
}
}]
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/start/payment
Запуск платежа
Метод для запуска платежа в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.
- API v1
- API v2
Адрес для отправки запроса
/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
- PHP
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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
use Bank131\SDK\DTO\Customer;
use Bank131\SDK\DTO\PaymentOptions;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$paymentOptions = new PaymentOptions();
$paymentOptions->setReturnUrl('return_url');
$request = RequestBuilderFactory::create()
->startPaymentSession('session_id')
->setCard(
new BankCard(
'number',
'expiration_month',
'expiration_year',
'security_code'
)
)
->setCustomer(
new Customer('reference')
)
->setPaymentOptions($paymentOptions)
->setAmount(10000, 'rub')
->setMetadata('good')
->build();
$response = $client->session()->startPayment($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}]
}
}
{
"status": "error",
"error": {
"description": "internal error",
"code": "repository_record_not_found"
}
}
Адрес для отправки запроса
/api/v2/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
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Card\BankCard;
use Bank131\SDK\DTO\Customer;
use Bank131\SDK\DTO\PaymentOptions;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$paymentOptions = new PaymentOptions();
$paymentOptions->setReturnUrl('return_url');
$request = RequestBuilderFactory::create()
->startPaymentSession('session_id')
->setCard(
new BankCard(
'number',
'expiration_month',
'expiration_year',
'security_code'
)
)
->setCustomer(
new Customer('reference')
)
->setPaymentOptions($paymentOptions)
->setAmount(10000, 'rub')
->setMetadata('good')
->build();
$response = $client->session()->startPayment($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payment_list": [{
"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"
}]
}
}
{
"status": "error",
"error": {
"description": "internal error",
"code": "repository_record_not_found"
}
}
session/start/payout
Запуск выплаты
Метод для запуска выплаты в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.
- API v1
- API v2
Адрес для отправки запроса
/api/v1/session/start/payout
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
payment_method | - | object | Платежные данные для зачисления средств |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | - | object | Информация об отправителе и получателе |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->startPayoutSession('session_id')
->build();
$response = $client->session()->startPayout($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/start/payout
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
payout_details | - | object | Платежные данные для зачисления средств |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | - | object | Информация об отправителе и получателе |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->startPayoutSession('session_id')
->build();
$response = $client->session()->startPayout($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payout_list": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"metadata": "good"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/start/payout/fiscalization
Запуск выплаты с фискализацией
Метод для запуска выплаты самозанятому с фискализацией в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.
- API v1
- API v2
Адрес для отправки запроса
/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
- PHP
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"
}
}]
}
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Collection\FiscalizationServiceCollection;
use Bank131\SDK\DTO\FiscalizationService;
use Bank131\SDK\DTO\ProfessionalIncomeTaxpayer;
use Bank131\SDK\DTO\Amount;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$services = new FiscalizationServiceCollection();
$services[] = new FiscalizationService(
'Доставка товара',
new Amount(5000, 'rub'),
1
);
$incomeInformation = new ProfessionalIncomeTaxpayer(
$services,
'590000000000'
);
$incomeInformation->setPayerName('ООО Вектор');
$incomeInformation->setPayerType('legal');
$incomeInformation->setPayerTaxNumber('330000000000');
$request = RequestBuilderFactory::create()
->startPayoutSessionWithFiscalization('3230', $incomeInformation)
->build();
$response = $client->session()->startPayoutWithFiscalization($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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": "ООО Вектор"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/start/payout/fiscalization
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
payout_details | - | object | Платежные данные для зачисления средств |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
fiscalization_details | - | object | Данные для фискализации |
participant_details | - | object | Информация об отправителе и получателе |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}
}]
}
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\DTO\Collection\FiscalizationServiceCollection;
use Bank131\SDK\DTO\FiscalizationService;
use Bank131\SDK\DTO\ProfessionalIncomeTaxpayer;
use Bank131\SDK\DTO\Amount;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$services = new FiscalizationServiceCollection();
$services[] = new FiscalizationService(
'Доставка товара',
new Amount(5000, 'rub'),
1
);
$incomeInformation = new ProfessionalIncomeTaxpayer(
$services,
'590000000000'
);
$incomeInformation->setPayerName('ООО Вектор');
$incomeInformation->setPayerType('legal');
$incomeInformation->setPayerTaxNumber('330000000000');
$request = RequestBuilderFactory::create()
->startPayoutSessionWithFiscalization('3230', $incomeInformation)
->build();
$response = $client->session()->startPayoutWithFiscalization($request);
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payout_list": [{
"id": "po_203",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"payout_details": {
"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": "ООО Вектор"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
token
Получение публичного токена для виджетов
Для работы с виджетами нужен публичный токен. Он действует 24 часа и предназначен для одной операции.
В запросе укажите тип виджета, токен для которого нужно получить.
Адрес для отправки запроса
/api/v1/token
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
tokenize_widget | - | object | Данные для виджета токенизации |
self_employed_widget | - | object | Данные для виджета регистрации самозанятого |
acquiring_widget | - | object | Данные для виджета платежной формы |
Пример запроса токена для выплаты с получением данных карты через виджет и с подключением самозанятого
- cURL
- PHP
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"
}
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$request = RequestBuilderFactory::create()
->issuePublicTokenBuilder()
->setTokenizeWidget()
->setSelfEmployedWidget('111111111111')
->setAcquiringWidget(
'test_ps_id',
'http://success.url',
'http://failed.url',
false
)
->build();
$response = $client->widget()->issuePublicToken($request);
$publicToken = $response->getPublicToken();
Пример запроса токена для платежа с оплатой через платежную форму
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"
}
{
"status": "error",
"error": {
"description": "acquiring_widget.session_id.not_unique",
"code": "invalid_request"
}
}
tokenize
Токенизация банковского счета
Метод для получения токена банковского счета получателя выплаты. В ответе также возвращается маскированный номер счета. Токен не имеет срока действия.
Если счет не проходит проверку на соответствие разрешенному списку счетов, возвращается ошибка «Введите другой номер счета».
Адрес для отправки запроса
/api/v1/tokenize
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
type | string | Тип банковского счета |
bank_account_ru | object | Дополнительная информация о банковском счете |
bik | string | БИК банка |
account | string | Номер счета |
Пример запроса
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"
}
}'
Параметры ответа
| Параметр | Тип | Описание |
|---|---|---|
status | string | Тип банковского счета |
token | string | Токен |
data | object | Данные маскированного счета |
error | object | Ошибка |
Примеры ответов
- Пример успешного ответа
- Пример неуспешного ответа
{
"status": "ok",
"token": "2c6ebe1368407b922057efee0fed58360dae1d28af50fa6734bb54c61a763c24",
"data": {
"masked_account": "40817***9535"
}
}
{
"status": "error",
"error": {
"description": "The public token is not found",
"code": "public_token_invalid"
}
}
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"
}
}
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Информация
fps/banks
Получение списка банков — участников СБП
Метод для получения списка банков с их наименованиями и идентификаторами для отправки выплат через Систему быстрых платежей.
Адрес для отправки запроса
/api/v1/fps/banks
Пример запроса
- cURL
- PHP
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 '{}'
use Bank131\SDK\Client;
$response = $client->fps()->getBanks();
foreach ($response->getBanks() as $bank) {
echo $bank->getId(), ' ', $bank->getRuName(), ' ', $bank->getEngName(), PHP_EOL;
}
Пример ответа
{
"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
- API v2
Адрес для отправки запроса
/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": "Иванович"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/fps/customer_verification
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | + | object | Платежные данные для зачисления средств |
participant_details | + | object | Информация об отправителе и получателе |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/fps/customer_verification \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payout_details": {
"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",
"payout_list": [{
"id": "po_31668",
"status": "in_progress",
"created_at": "2022-03-01T11:57:31.895773Z",
"payout_details": {
"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": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
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
}
}
{
"status": "error",
"error": {
"code": "Error code",
"description": "Error description"
}
}
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"
}]
}
}
}
Примеры неуспешных ответов
- Неверные даты
- Невалидный запрос по формату JSON
- Внутренняя ошибка
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"
}
}
{
"status": "error",
"error": {
"description": "Invalid request",
"code": "invalid_request"
}
}
Данный ответ возвращается в следующих случаях:
- номер счета указан неверно,
- запрашивается выписка по несуществующему счету,
- счет, по которому запрошена выписка, не принадлежит клиенту.
{
"status": "error",
"error": {
"description": "Internal error",
"code": "internal_error"
}
}
session/status
Получение информации о сессии
Метод для получения полной информации о платежной сессии. Например, вы можете проверить статус выплаты или узнать, можно ли списать захолдированную сумму.
- API v1
- API v2
Адрес для отправки запроса
/api/v1/session/status
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
Пример запроса
- cURL
- PHP
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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->status('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/status
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
Пример запроса
- cURL
- PHP
curl -X POST \
https://demo.bank131.ru/api/v2/session/status \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"session_id": "ps_3230"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$response = $client->session()->status('session_id');
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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",
"payout_list": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa",
"bin": "220220"
}
},
"amount_details": {
"amount": 10000,
"currency": "rub"
},
"transaction_info": {
"rrn": "425307614918",
"auth_code": "057441"
},
"metadata": "good"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
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"
}
}
}'
Вы отправляете публичный токен и получаете информацию о нем.
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": "public_token",
"public_token": {
"token": "your_token"
}
}'
Вы отправляете токен и получаете информацию о нем.
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": "recurrent_token",
"recurrent_token": {
"token": "your_token"
}
}'
Вы отправляете токен и получаете информацию о нем.
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": "bank_account_ru",
"bank_account_ru": {
"token": "4371c4633033d3e7f468c8ca5f50f7dd10c00fe8655563c3da759c16b505ba93"
}
}'
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
status | + | string | Статус. Возможные значения: error, ok |
info | - | object | Информация о токене, зависит от типа запроса (type): токенизированная банковская карта, публичный токен, токен для рекуррентных платежей или выплат или токен банковского счета |
error | - | object | Ошибка |
Примеры ответов
- Данные карты по хешу
- Публичный токен
- Данные токена для рекуррентных платежей или выплат
- Данные токена банковского счета
{
"status": "ok",
"info": {
"number_hash": "card_number_hash",
"brand": "visa",
"last4": "4242",
"type": "card"
}
}
{
"status": "ok",
"info": {
"token": "your_token",
"created_at": "2021-03-17T14:10:56+03:00",
"finished_at": "2021-03-18T14:10:56+03:00",
"is_active": true,
"type": "public_token"
}
}
{
"status": "ok",
"info": {
"token": "your_token",
"created_at": "2021-03-17T14:19:05+03:00",
"finished_at": "2021-04-17T14:19:05+03:00",
"is_active": true,
"type": "recurrent_token"
}
}
{
"status": "ok",
"info": {
"masked_account": "40817***9535",
"created_at": "2024-02-08T17:17:44+03:00",
"finished_at": "2124-02-08T17:17:44+03:00",
"type": "bank_account_ru"
}
}
wallet/balance
Проверка баланса
Метод для получения текущего остатка по обеспечительному счету. Используйте его, чтобы убедиться, что на обеспечительном счете достаточно средств для выплат и возвратов. Если денег недостаточно — пополните счет.
Баланс по эквайрингу можно узнать в вашем аккаунте интернет-банка в разделе Выписки.
Адрес для отправки запроса
/api/v1/wallet/balance
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
request_datetime | + | string | Дата и время отправки запроса согласно ISO 8601 |
Пример запроса
- cURL
- PHP
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"
}'
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory;
use Bank131\SDK\Client;
use Bank131\SDK\Config;
$config = new Config(
'https://demo.bank131.ru',
'your_project_name',
file_get_contents('/path/to/your/private_key.pem')
);
$client = new Client($config);
$walletBalanceResponse = $client->wallet()->balance();
$wallets = $walletBalanceResponse->getWallets();
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
status | + | string | Статус. Возможные значения: error, ok |
wallets | - | object | Список доступных депозитов в Банке 131 |
error | - | object | Ошибка |
Примеры ответов
- Пример успешного ответа
- Пример неуспешного ответа
{
"status": "ok",
"wallets": [{
"id": "131",
"amount_details": {
"amount": 13100,
"currency": "rub"
}
}]
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Самозанятые
npd/accruals и npd/request/status
Подробная проверка налоговой задолженности и бонуса самозанятого
Метод для получения подробной информации о налоговой задолженности и остатке налогового бонуса у самозанятого.
Состоит из двух шагов:
- Отправьте запрос
npd/accrualsс ИНН самозанятого. В ответе придетrequest_id. - Передайте этот
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
Проверка количества непрочитанных оповещений ФНС для самозанятого
Метод для получения количества непрочитанных оповещений из ФНС для самозанятого.
Состоит из двух шагов:
- Отправьте запрос
npd/notifications/countс ИНН самозанятого. В ответе придетrequest_id. - Передайте этот
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.
Состоит из двух шагов:
- Отправьте запрос
npd/notifications/mark_as_deliveredс данными самозанятого. В ответе придетrequest_id. - Передайте этот
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
Получение подробной информации о непрочитанных оповещениях ФНС для самозанятого
Метод для получения подробной информации о непрочитанных оповещениях из ФНС для самозанятого.
Состоит из двух шагов:
- Отправьте запрос
npd/notifications/readс ИНН самозанятого. В ответе придетrequest_id. - Передайте этот
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.
Состоит из двух шагов:
- Отправьте запрос
npd/notifications/updateс данными самозанятого. В ответе придетrequest_id. - Передайте этот
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
Общая проверка налоговой задолженности и остатка бонуса самозанятого
Метод для получения общей информации о наличии налоговой задолженности и остатке налогового бонуса у самозанятого.
Состоит из двух шагов:
- Отправьте запрос
npd/taxpayer/account_statusс данными самозанятого. В ответе придетrequest_id. - Передайте этот
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
Проверка соответствия данных самозанятого данным ФНС
Метод для проверки данных (ИНН, ФИО, номер телефона) самозанятого с теми, которые хранятся в ФНС.
Состоит из двух шагов:
- Отправьте запрос
npd/taxpayer/check_personal_infoс ИНН, ФИО и номером телефона самозанятого. В ответе придетrequest_id. - Передайте этот
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
- API v2
Адрес для отправки запроса
/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"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "Invalid input request parameters: payment_method.bank_account.ru.inn (bank_account_ru.inn.invalid_length)",
"code": "invalid_request"
}
}
Адрес для отправки запроса
/api/v2/session/create/nominal
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | - | object | Платежные данные для зачисления средств |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | - | object | Информация об отправителе и получателе |
fiscalization_details | - | object | Данные для фискализации |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/session/create/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payout_details": {
"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",
"payout_list": [{
"id": "po_72265",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.781934Z",
"payout_details": {
"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"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/init/payout/nominal
Создание сессии с одновременным запуском выплаты на банковский счет
Метод для проведения выплаты на банковский счет, в том числе через СБП, без отдельного создания сессии. В этом случае вы передаете все данные сразу.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}'
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",
"ru": {
"bik": "044525974",
"account": "40702810500000000001",
"full_name": "ООО Наименование организации",
"inn": "1111111111",
"kpp": "156605101",
"description": "Перечисление денежных средств по договору за декабрь 2022 г. НДС не облагается."
}
}
},
"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"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/init/payout/nominal
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | + | object | Платежные данные для зачисления средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | + | object | Информация об отправителе и получателе |
fiscalization_details | - | object | Данные для фискализации |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Примеры запросов
- Выплата на счет физического лица
- Выплата на счет юридического лица
curl -X POST \
https://demo.bank131.ru/api/v2/session/init/payout/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payout_details": {
"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"
}
}
}'
curl -X POST \
https://demo.bank131.ru/api/v2/session/init/payout/nominal \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payout_details": {
"type": "bank_account",
"bank_account": {
"ru": {
"bik": "044525974",
"account": "40702810500000000001",
"full_name": "ООО Наименование организации",
"inn": "1111111111",
"kpp": "156605101",
"description": "Перечисление денежных средств по договору за декабрь 2022 г. НДС не облагается."
},
"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_287403",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.586072Z",
"updated_at": "2023-05-10T16:58:43.705620Z",
"payout_list": [{
"id": "po_72265",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.781934Z",
"payout_details": {
"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"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/multi/create/nominal
Создание платежной сессии
Метод создания платежной сессии для выплаты на карту. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.
Используйте метод, если данные банковской карты для выплаты вы получаете через виджет, а выплату отправляете отдельным запросом в рамках созданной сессии.
Вы можете создать сессию и запустить выплату одновременно с помощью метода
session/multi/init/payment/nominal. Не рекомендуем использовать этот способ.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/multi/create/nominal
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payment_details | - | object | Платежные данные для списания средств |
payout_details | - | object | Платежные данные для зачисления средств |
fiscalization_details | - | object | Данные для фискализации |
participant_details | - | object | Информация об отправителе и получателе |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/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": "Назначение платежа"
}
}
},
"payout_details": {
"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",
"payout_list": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payout_details": {
"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"
}
}
}],
"payment_list": [{
"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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
session/multi/init/payment/nominal
Создание сессии с одновременным запуском выплаты на банковскую карту
Метод для проведения выплаты на банковскую карту без отдельного создания сессии. В этом случае вы передаете все данные сразу.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/multi/init/payment/nominal
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payment_details | + | object | Платежные данные для списания средств |
payout_details | + | object | Платежные данные для зачисления средств |
fiscalization_details | - | object | Данные для фискализации |
participant_details | + | object | Информация об отправителе и получателе |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
customer | + | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}
}
},
"payout_details": {
"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",
"payout_list": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payout_details": {
"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"
}
}
}],
"payment_list": [{
"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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
session/multi/start/payment/nominal
Запуск выплаты на банковскую карту
Метод для запуска выплаты в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/multi/start/payment/nominal
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
payment_details | + | object | Платежные данные для списания средств |
payout_details | + | object | Платежные данные для зачисления средств |
fiscalization_details | - | object | Данные для фискализации |
participant_details | + | object | Информация об отправителе и получателе |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
customer | + | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}
}
},
"payout_details": {
"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",
"payout_list": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payout_details": {
"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"
}
}
}],
"payment_list": [{
"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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
session/start/payout/nominal
Запуск выплаты на банковский счет
Метод для запуска выплаты на банковский счет, в том числе через СБП, в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}'
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",
"ru": {
"bik": "044525974",
"account": "40702810500000000001",
"full_name": "ООО Наименование организации",
"inn": "1111111111",
"kpp": "156605101",
"description": "Перечисление денежных средств по договору за декабрь 2022 г. НДС не облагается."
}
}
},
"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"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/start/payout/nominal
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
payout_details | + | object | Платежные данные для зачисления средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | + | object | Информация об отправителе и получателе |
fiscalization_details | - | object | Данные для фискализации |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Примеры запросов
- Выплата на счет физического лица
- Выплата на счет юридического лица
curl -X POST \
https://demo.bank131.ru/api/v2/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",
"payout_details": {
"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"
}
}
}'
curl -X POST \
https://demo.bank131.ru/api/v2/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",
"payout_details": {
"type": "bank_account",
"bank_account": {
"system_type": "ru",
"ru": {
"bik": "044525974",
"account": "40702810500000000001",
"full_name": "ООО Наименование организации",
"inn": "1111111111",
"kpp": "156605101",
"description": "Перечисление денежных средств по договору за декабрь 2022 г. НДС не облагается."
}
}
},
"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",
"payout_list": [{
"id": "po_72265",
"status": "in_progress",
"created_at": "2023-05-10T16:58:43.781934Z",
"payout_details": {
"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"
}
}
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Расчетный счет
session/create/rko
Создание платежной сессии
Метод создания платежной сессии для выплаты на банковский счет. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.
Используйте метод, если данные банковского счета для выплаты вы получаете через виджет, а выплату отправляете отдельным запросом в рамках созданной сессии.
Вы можете создать сессию и запустить выплату одновременно с помощью метода
session/init. Не рекомендуем использовать этот способ.
- API v1
- API v2
Адрес для отправки запроса
/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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/create/rko
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | - | object | Платежные данные для зачисления средств |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | - | object | Информация об отправителе и получателе |
fiscalization_details | - | object | Данные для фискализации |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/session/create/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payout_details": {
"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",
"payout_list": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/init/payout/rko
Создание сессии с одновременным запуском выплаты на банковский счет
Метод для проведения выплаты на банковский счет, в том числе через СБП, без отдельного создания сессии. В этом случае вы передаете все данные сразу.
- API v1
- API v2
Адрес для отправки запроса
/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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/init/payout/rko
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payout_details | + | object | Платежные данные для зачисления средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | + | object | Информация об отправителе и получателе |
fiscalization_details | - | object | Данные для фискализации |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/session/init/payout/rko \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payout_details": {
"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",
"payout_list": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
session/multi/create/rko
Создание платежной сессии
Метод создания платежной сессии для выплаты на банковскую карту. Возвращает session_id — идентификатор сессии, по которому Банк 131 определяет, к какой сессии относится запрос.
Используйте метод, если данные банковской карты для выплаты вы получаете через виджет, а выплату отправляете отдельным запросом в рамках созданной сессии.
Вы можете создать сессию и запустить выплату одновременно с помощью метода
session/init. Не рекомендуем использовать этот способ.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/multi/create/rko
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payment_details | - | object | Платежные данные для списания средств |
payout_details | - | object | Платежные данные для зачисления средств |
fiscalization_details | - | object | Данные для фискализации |
participant_details | - | object | Информация об отправителе и получателе |
amount_details | - | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
customer | - | object | Данные получателя в вашей системе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/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": "Назначение платежа"
}
}
},
"payout_details": {
"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_3230",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.274416Z",
"updated_at": "2021-08-06T11:34:51.466550Z",
"payout_list": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payout_details": {
"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"
}
}
}],
"payment_list": [{
"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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
session/multi/init/payment/rko
Создание сессии с одновременным запуском выплаты на банковскую карту
Метод для проведения выплаты на банковскую карту без отдельного создания сессии. В этом случае вы передаете все данные сразу.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/multi/init/payment/rko
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
payment_details | + | object | Платежные данные для списания средств |
payout_details | + | object | Платежные данные для зачисления средств |
customer | + | object | Данные получателя в вашей системе |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
fiscalization_details | - | object | Данные для фискализации |
participant_details | + | object | Информация об отправителе и получателе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}
}
},
"payout_details": {
"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",
"payout_list": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payout_details": {
"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"
}
}
}],
"payment_list": [{
"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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
session/multi/start/payment/rko
Запуск выплаты на банковскую карту
Метод для запуска выплаты в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.
- API v1
- API v2
Адрес для отправки запроса
/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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
Адрес для отправки запроса
/api/v2/session/multi/start/payment/rko
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
payment_details | + | object | Платежные данные для списания средств |
payout_details | + | object | Платежные данные для зачисления средств |
customer | + | object | Данные получателя в вашей системе |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
fiscalization_details | - | object | Данные для фискализации |
participant_details | + | object | Информация об отправителе и получателе |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/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"
}
}
},
"payout_details": {
"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",
"payout_list": [{
"id": "po_25657",
"status": "in_progress",
"created_at": "2021-08-06T11:34:51.545329Z",
"customer": {
"reference": "lucky"
},
"payout_details": {
"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"
}
}
}],
"payment_list": [{
"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"
}
}
}]
}
}
{
"error": {
"description": "error description",
"code": "error code"
},
"status": "error"
}
session/start/payout/rko
Запуск выплаты на банковский счет
Метод для запуска выплаты на банковский счет, в том числе через СБП, в рамках уже созданной сессии. В запросе можно передать недостающие параметры или заменить уже переданные.
- API v1
- API v2
Адрес для отправки запроса
/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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Адрес для отправки запроса
/api/v2/session/start/payout/rko
Параметры запроса
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
session_id | + | string | Идентификатор платежной сессии |
payout_details | + | object | Платежные данные для зачисления средств |
amount_details | + | object | Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000 |
participant_details | + | object | Информация об отправителе и получателе |
fiscalization_details | - | object | Данные для фискализации |
metadata | - | * | Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках |
Пример запроса
curl -X POST \
https://demo.bank131.ru/api/v2/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",
"payout_details": {
"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",
"payout_list": [{
"id": "po_2025",
"status": "in_progress",
"created_at": "2025-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [{
"email": "user@gmail.com"
}]
},
"payout_details": {
"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"
}]
}
}
{
"status": "error",
"error": {
"description": "error description",
"code": "error code"
}
}
Денежные переводы
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 |
Примеры запросов
- Прямой курс. Конвертация из RUB в TRY
- Обратный курс. Конвертация из UZS в RUB
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"
}
}
}'
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": null,
"currency": "RUB"
},
"destination": {
"amount": 46943404,
"currency": "UZS"
}
}
}'
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
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 | Ошибка |
Примеры ответов
- Прямой курс. Конвертация из RUB в TRY
- Обратный курс. Конвертация из UZS в RUB
- Пример неуспешного ответа
{
"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
}
}
}
{
"amounts": {
"source": {
"amount": 357912,
"currency": "RUB"
},
"destination": {
"amount": 46943404,
"currency": "UZS"
},
"transfer_fee": {
"amount": 0,
"currency": "RUB"
},
"sms_fee": {
"amount": 0,
"currency": "RUB"
},
"payment": {
"amount": 9193,
"currency": "RUB"
}
},
"exchanges": {
"source": {
"amount": null,
"currency": "RUB"
},
"destination": {
"amount": 46943404,
"currency": "UZS"
},
"rate": {
"fx_rate": 76.2433,
"quantity": 10000
}
}
}
{
"status": "error",
"error": {
"description": "Invalid request",
"code": "invalid_request"
}
}
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 | + | string | 12-значный ИНН отправителя |
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 | - | string | 12-значный ИНН получателя |
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 | Объект для перевода наличными. Передается пустым: {} |
Примеры запросов
- Перевод с банковской карты на банковскую карту в Таджикистан
- Перевод с банковской карты на IBAN в Турцию
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"
}
}
}
}]
}'
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": 1000,
"currency": "TRY"
},
"customer": {
"reference": "lucky"
},
"participant_details": {
"sender": {
"citizenship_country_iso3": "RUS",
"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",
"issued_by": "ОВД ПО Кировскому району",
"division_code": "123-543"
},
"contacts": {
"phone": {
"full_number": "+79376151530"
},
"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": 1000,
"currency": "TRY"
},
"participant_details": {
"recipient": {
"first_name": "Sidor",
"last_name": "Sidorov",
"middle_name": "Sidorovich",
"date_of_birth": "2000-11-08",
"country_iso3": "TRY",
"citizenship_country_iso3": "TRY",
"contacts": {
"phone": {
"full_number": "+43523452345",
"country_iso3": "TRY",
"operator_code": "352",
"short_number": "3452345"
},
"email": "recipient@test.tr"
}
}
},
"payout_details": {
"type": "bank_account",
"bank_account": {
"system_type": "iban",
"iban": {
"account": "TR12312312"
}
}
}
}]
}'
Параметры ответа
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
status | + | string | Статус. Возможные значения: error, ok |
session | + | object | Платежная сессия |
error | - | object | Ошибка |
Примеры ответов
- Перевод с банковской карты на банковскую карту в Таджикистан
- Перевод с банковской карты на IBAN в Турцию
- Пример неуспешного ответа
{
"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
}
}]
}
}
{
"status": "ok",
"session": {
"id": "ps_3808544",
"status": "in_progress",
"created_at": "2025-08-11T07:39:00.076932Z",
"updated_at": "2025-08-11T07:39:00.476548Z",
"payout_list": [{
"id": "po_955266",
"status": "in_progress",
"created_at": "2025-08-11T07:39:00.528662Z",
"payout_details": {
"type": "bank_account",
"bank_account": {
"system_type": "iban",
"iban": {
"account": "TR12312312"
}
}
},
"amount_details": {
"amount": 1000,
"currency": "TRY"
},
"amounts": {},
"payment_metadata": {},
"participant_details": {
"recipient": {
"full_name": "Sidor Sidorov Sidorovich",
"first_name": "Sidor",
"last_name": "Sidorov",
"middle_name": "Sidorovich",
"country_iso3": "TRY",
"date_of_birth": "2000-11-08",
"citizenship_country_iso3": "TRY",
"contacts": {
"phone": {
"full_number": "+43523452345",
"country_iso3": "TRY",
"operator_code": "352",
"short_number": "3452345"
},
"email": "recipient@test.tr"
}
}
}
}],
"payment_list": [{
"id": "pm_2766065",
"status": "in_progress",
"created_at": "2025-08-11T07:39:00.528558Z",
"customer": {
"reference": "lucky"
},
"payment_details": {
"type": "card",
"card": {
"brand": "visa",
"last4": "1111",
"country_iso3": "POL"
}
},
"amount_details": {
"amount": 1000,
"currency": "TRY"
},
"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",
"division_code": "123-543",
"issued_by": "ОВД ПО Кировскому району"
},
"citizenship_country_iso3": "RUS",
"contacts": {
"phone": {
"full_number": "+79376151530"
},
"email": "sender@test.com"
}
}
},
"payment_options": {
"return_url": "https://www.131.ru/",
"recurrent": false
}
}]
}
}
{
"status": "error",
"error": {
"description": "Invalid request",
"code": "invalid_request"
}
}
Прочее
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"
}
{
"status": "error",
"error": {
"description": "Internal error",
"code": "internal_error"
}
}