Методы

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

к сведению

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

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

• Если запрос 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

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": "9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48"
    }
  }'

PHP

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('9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48')
    ->build();

$response =  $client->recurrent()->disable($request);

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

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

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

{
  "recurrent": {
    "token": "9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48",
    "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/v1/session/cancel

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии

Пример запроса

cURL

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"
  }'

PHP

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

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

/api/v2/session/cancel

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии

Пример запроса

cURL

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"
  }'

PHP

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/v1/session/capture

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии
amount_details	-	object	Сумма. Может быть меньше захолдированной, но обязательно больше 0. Если параметр отсутствует, захолдированная сумма будет списана полностью

Пример запроса

cURL

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"
  }'

PHP

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": "mir",
          "last4": "2058"
        }
      },
      "amount_details": {
        "amount": 10000,
        "currency": "rub"
      },
      "refunds": [{
        "id": "rf_23",
        "status": "in_progress",
        "created_at": "2024-05-27T02:03:00.000000Z",
        "amount_details": {
          "amount": 10000,
          "currency": "rub"
        }
      }]
    }]
  }
}

Пример неуспешного ответа

{
  "error": {
    "code": "error code",
    "description": "error description"
  },
  "status": "error"
}

API v2

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

/api/v2/session/capture

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии
amount_details	-	object	Сумма. Может быть меньше захолдированной, но обязательно больше 0. Если параметр отсутствует, захолдированная сумма будет списана полностью

Пример запроса

cURL

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"
  }'

PHP

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": "mir",
          "last4": "2058"
        }
      },
      "amount_details": {
        "amount": 10000,
        "currency": "rub"
      },
      "refunds": [{
        "id": "rf_23",
        "status": "in_progress",
        "created_at": "2024-05-27T02:03:00.000000Z",
        "amount_details": {
          "amount": 10000,
          "currency": "rub"
        }
      }]
    }]
  }
}

Пример неуспешного ответа

{
  "error": {
    "code": "error code",
    "description": "error description"
  },
  "status": "error"
}

session/confirm

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

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

API v1

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

/api/v1/session/confirm

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии
confirm_information	- (обязательно при операциях с расчетным и номинальным счетами, а также при денежных переводах)	object	Информация для подтверждения операции

Пример запроса

cURL

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"
  }'

PHP

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

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

/api/v2/session/confirm

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии
confirm_information	- (обязательно при операциях с расчетным и номинальным счетами, а также при денежных переводах)	object	Информация для подтверждения операции

Пример запроса

cURL

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"
  }'

PHP

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/v1/session/create

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

Название	Обязательность	Тип	Описание
payment_method	-	object	Платежные данные для зачисления средств
payment_details	-	object	Платежные данные для списания средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details	-	object	Информация об отправителе и получателе
customer	-	object	Данные пользователя в вашей системе
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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"
  }'

PHP

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

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

/api/v2/session/create

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

Название	Обязательность	Тип	Описание
payout_details	-	object	Платежные данные для зачисления средств
payment_details	-	object	Платежные данные для списания средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details	-	object	Информация об отправителе и получателе
customer	-	object	Данные пользователя в вашей системе
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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"
  }'

PHP

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/v1/session/init/payment

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

Название	Обязательность	Тип	Описание
payment_details	+	object	Платежные данные для списания средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer	+	object	Данные плательщика в вашей системе
payment_options	-	object	Дополнительные параметры платежа
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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"
    }
  }'

PHP

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('https://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

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

/api/v2/session/init/payment

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

Название	Обязательность	Тип	Описание
payment_details	+	object	Платежные данные для списания средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer	+	object	Данные плательщика в вашей системе
payment_options	-	object	Дополнительные параметры платежа
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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"
    }
  }'

PHP

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('https://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/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
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

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

/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
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/v1/session/init/payout

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

Название	Обязательность	Тип	Описание
payment_method	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details	- (обязателен для выплат на карты)	object	Информация об отправителе и получателе
customer	-	object	Данные получателя в вашей системе
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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": "Иванов Иван Иванович"
      }
    }
  }'

PHP

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\Participant;

$config = new Config(
    'https://demo.bank131.ru',
    'your_project_name',
    file_get_contents('/path/to/your/private_key.pem')
);

$client = new Client($config);

$participant = new Participant();
$participant->setFullName('Иванов Иван Иванович');

$request = RequestBuilderFactory::create()
    ->initPayoutSession()
    ->setCard(new BankCard('4242424242424242'))
    ->setAmount(1000, 'rub')
    ->setRecipient($participant)
    ->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"
      },
      "participant_details": {
        "recipient": {
          "full_name": "Иванов Иван Иванович"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

API v2

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

/api/v2/session/init/payout

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

Название	Обязательность	Тип	Описание
payout_details	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details	- (обязателен для выплат на карты)	object	Информация об отправителе и получателе
customer	-	object	Данные получателя в вашей системе
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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": "Иванов Иван Иванович"
      }
    }
  }'

PHP

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\Participant;

$config = new Config(
    'https://demo.bank131.ru',
    'your_project_name',
    file_get_contents('/path/to/your/private_key.pem')
);

$client = new Client($config);

$participant = new Participant();
$participant->setFullName('Иванов Иван Иванович');

$request = RequestBuilderFactory::create()
    ->initPayoutSession()
    ->setCard(new BankCard('4242424242424242'))
    ->setAmount(1000, 'rub')
    ->setRecipient($participant)
    ->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"
      },
      "participant_details": {
        "recipient": {
          "full_name": "Иванов Иван Иванович"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

session/refund

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

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

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

API v1

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

/api/v1/session/refund

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии из платежа, который нужно вернуть
amount_details	-	object	Сумма. Если не указать, отправителю вернется вся сумма платежа
metadata	-	*	Дополнительная информация

Пример запроса

cURL

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"
  }'

PHP

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": "mir",
          "last4": "2058"
        }
      },
      "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

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

/api/v2/session/refund

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор сессии из платежа, который нужно вернуть
amount_details	-	object	Сумма. Если не указать, отправителю вернется вся сумма платежа
metadata	-	*	Дополнительная информация

Пример запроса

cURL

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"
  }'

PHP

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": "mir",
          "last4": "2058"
        }
      },
      "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/v1/session/start/payment

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_details	-	object	Платежные данные для списания средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer	-	object	Данные плательщика в вашей системе
payment_options	-	object	Дополнительные параметры
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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"
  }'

PHP

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('order123')
    ->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

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

/api/v2/session/start/payment

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_details	-	object	Платежные данные для списания средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
customer	-	object	Данные плательщика в вашей системе
payment_options	-	object	Дополнительные параметры
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

cURL

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"
  }'

PHP

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('order123')
    ->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/v1/session/start/payout

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_method	-	object	Платежные данные для зачисления средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details	- (обязателен для выплат на карты)	object	Информация об отправителе и получателе
customer	-	object	Данные получателя в вашей системе
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

curl -X POST \
  https://demo.bank131.ru/api/v1/session/start/payout \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: signature' \
  -d '{
    "session_id": "ps_3230",
    "participant_details": {
      "recipient": {
        "full_name": "Иванов Иван Иванович"
      }
    }
  }'

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

Название	Обязательность	Тип	Описание
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"
      },
      "participant_details": {
        "recipient": {
          "full_name": "Иванов Иван Иванович"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

API v2

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

/api/v2/session/start/payout

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payout_details	-	object	Платежные данные для зачисления средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_details	- (обязателен для выплат на карты)	object	Информация об отправителе и получателе
customer	-	object	Данные получателя в вашей системе
metadata	-	*	Любые дополнительные данные, которые необходимы вам для проведения операции. Банк 131 возвращает их в ответах и вебхуках

Пример запроса

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",
    "participant_details": {
      "recipient": {
        "full_name": "Иванов Иван Иванович"
      }
    }
  }'

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

Название	Обязательность	Тип	Описание
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"
      },
      "participant_details": {
        "recipient": {
          "full_name": "Иванов Иван Иванович"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

token

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

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

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

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

/api/v1/token

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

Название	Обязательность	Тип	Описание
tokenize_widget	-	object	Данные для виджета токенизации
acquiring_widget	-	object	Данные для виджета платежной формы
sber_pay_widget	-	object	Данные для виджета SberPay

Пример запроса токена для выплаты с получением данных карты через виджет

cURL

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
    }
  }'

PHP

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()
    ->setAcquiringWidget(
        'test_ps_id',
        'https://success.url',
        'https://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"
    }
  }'

Пример запроса токена для оплаты через SberPay

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 '{
    "sber_pay_widget": {
      "session_id": "ps_77872830",
      "phone": "79680000000",
      "return_url": "https://131.ru"
    }
  }'

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

Название	Обязательность	Тип	Описание
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": "d47b2f90a6c1e8350f9a4d7c2e6b183fa5c0d9e472b6f8a1c3e5d7092b4f6a8c",
  "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": "9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48",
      "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

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 '{}'

PHP

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/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

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

/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"
      }]
    }
  }
}

Примеры неуспешных ответов

Неверные даты

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"
  }
}

Невалидный запрос по формату JSON

{
  "status": "error",
  "error": {
    "description": "Invalid request",
    "code": "invalid_request"
  }
}

Внутренняя ошибка

Данный ответ возвращается в следующих случаях:

• номер счета указан неверно,
• запрашивается выписка по несуществующему счету,
• счет, по которому запрошена выписка, не принадлежит клиенту.

{
  "status": "error",
  "error": {
    "description": "Internal error",
    "code": "internal_error"
  }
}

session/status

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

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

API v1

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

/api/v1/session/status

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии

Пример запроса

cURL

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"
  }'

PHP

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

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

/api/v2/session/status

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии

Пример запроса

cURL

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"
  }'

PHP

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": "9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48"
      }
    }
  }'

Публичный токен

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

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": "9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48"
    }
  }'

Токен банковского счета

Вы отправляете токен и получаете информацию о нем.

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": "d47b2f90a6c1e8350f9a4d7c2e6b183fa5c0d9e472b6f8a1c3e5d7092b4f6a8c"
    }
  }'

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

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

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

Данные карты по хешу

{
  "status": "ok",
  "info": {
    "number_hash": "9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48",
    "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": "9a1c4e7f2b8d5036af61c9e0d4b72f8a3c5e190d6f24b8a7c0e3d5f19b6a2c48",
    "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

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"
  }'

PHP

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"
  }
}

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

session/create/nominal

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

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

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

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

API v1

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

/api/v1/session/create/nominal

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

Название	Обязательность	Тип	Описание
payment_method	-	object	Платежные данные для зачисления средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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

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

/api/v2/session/create/nominal

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

Название	Обязательность	Тип	Описание
payout_details	-	object	Платежные данные для зачисления средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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/v1/session/init/payout/nominal

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

Название	Обязательность	Тип	Описание
payment_method	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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

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

/api/v2/session/init/payout/nominal

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

Название	Обязательность	Тип	Описание
payout_details	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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/v1/session/multi/create/nominal

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

Название	Обязательность	Тип	Описание
payment_details	-	object	Платежные данные для списания средств
payment_method	-	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": "mir",
        "bank_card": {
          "number": "2200774546102058"
        }
      }
    },
    "participant_details": {
      "sender": {
        "full_name": "Данные отправителя",
        "beneficiary_id": "1987654321"
      },
      "recipient": {
        "full_name": "Иванов Иван Иванович",
        "beneficiary_id": "1234567890",
        "reference": "1234"
      }
    },
    "amount_details": {
      "amount": 30000,
      "currency": "RUB"
    },
    "customer": {
      "reference": "lucky"
    }
  }'

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

Название	Обязательность	Тип	Описание
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": "mir",
          "last4": "2058"
        }
      },
      "amount_details": {
        "amount": 30000,
        "currency": "RUB"
      },
      "metadata": {
        "key": "value"
      },
      "participant_details": {
        "sender": {
          "full_name": "Данные отправителя",
          "beneficiary_id": "1987654321"
        },
        "recipient": {
          "full_name": "Иванов Иван Иванович",
          "beneficiary_id": "1234567890",
          "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": "220077******2058"
          }
        }
      },
      "amount_details": {
        "amount": 30000,
        "currency": "RUB"
      },
      "metadata": {
      "participant_details": {
        "sender": {
          "full_name": "Данные отправителя",
          "beneficiary_id": "1987654321"
        },
        "recipient": {
          "full_name": "Иванов Иван Иванович",
          "beneficiary_id": "1234567890",
          "reference": "1234"
        }
      }
        }
      }
    }]
  }
}

Пример неуспешного ответа

{
  "error": {
    "description": "error description",
    "code": "error code"
  },
  "status": "error"
}

API v2

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

/api/v2/session/multi/create/nominal

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

Название	Обязательность	Тип	Описание
payment_details	-	object	Платежные данные для списания средств
payout_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": {
    "participant_details": {
      "sender": {
        "full_name": "Данные отправителя",
        "beneficiary_id": "1987654321"
      },
      "recipient": {
        "full_name": "Иванов Иван Иванович",
        "beneficiary_id": "1234567890",
        "reference": "1234"
      }
    },
        "beneficiary_id": "1234567890"
      },
      "recipient": {
        "full_name": "Иванов Иван Иванович"
      }
    },
    "amount_details": {
      "amount": 30000,
      "currency": "RUB"
    },
    "customer": {
      "reference": "lucky"
    }
  }'

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

Название	Обязательность	Тип	Описание
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": "mir",
          "last4": "2058"
        }
      },
      "amount_details": {
      "participant_details": {
        "sender": {
          "full_name": "Данные отправителя",
          "beneficiary_id": "1987654321"
        },
        "recipient": {
          "full_name": "Иванов Иван Иванович",
          "beneficiary_id": "1234567890",
          "reference": "1234"
        }
      }
        },
        "recipient": {
          "full_name": "Иванов Иван Иванович",
          "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": "220077******2058"
          }
        }
      "participant_details": {
        "sender": {
          "full_name": "Данные отправителя",
          "beneficiary_id": "1987654321"
        },
        "recipient": {
          "full_name": "Иванов Иван Иванович",
          "beneficiary_id": "1234567890",
          "reference": "1234"
        }
      }
        "sender": {
          "full_name": "Данные отправителя"
        },
        "recipient": {
          "full_name": "Иванов Иван Иванович",
          "reference": "1234"
        }
      }
    }]
  }
}

Пример неуспешного ответа

{
  "error": {
    "description": "error description",
    "code": "error code"
  },
  "status": "error"
}

session/multi/init/payment/nominal

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

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

API v1

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

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

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

Название	Обязательность	Тип	Описание
payment_details	+	object	Платежные данные для списания средств
payment_method	+	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": "lucky"
    }
  }'

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

Название	Обязательность	Тип	Описание
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

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

/api/v2/session/multi/init/payment/nominal

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

Название	Обязательность	Тип	Описание
payment_details	+	object	Платежные данные для списания средств
payout_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": "lucky"
    }
  }'

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

Название	Обязательность	Тип	Описание
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/v1/session/multi/start/payment/nominal

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_details	+	object	Платежные данные для списания средств
payment_method	+	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

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

/api/v2/session/multi/start/payment/nominal

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_details	+	object	Платежные данные для списания средств
payout_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/v1/session/start/payout/nominal

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_method	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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

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

/api/v2/session/start/payout/nominal

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payout_details	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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/v1/session/create/rko

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

Название	Обязательность	Тип	Описание
payment_method	-	object	Платежные данные для зачисления средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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"
      },
      "participant_details": {
        "sender": {
          "account": "40702810900000000011"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

API v2

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

/api/v2/session/create/rko

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

Название	Обязательность	Тип	Описание
payout_details	-	object	Платежные данные для зачисления средств
amount_details	-	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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"
      },
      "participant_details": {
        "sender": {
          "account": "40702810900000000011"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

session/init/payout/rko

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

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

API v1

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

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

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

Название	Обязательность	Тип	Описание
payment_method	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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"
      },
      "participant_details": {
        "sender": {
          "account": "40702810900000000011"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

API v2

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

/api/v2/session/init/payout/rko

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

Название	Обязательность	Тип	Описание
payout_details	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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"
      },
      "participant_details": {
        "sender": {
          "account": "40702810900000000011"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

session/multi/create/rko

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

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

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

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

API v1

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

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

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

Название	Обязательность	Тип	Описание
payment_details	-	object	Платежные данные для списания средств
payment_method	-	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

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

/api/v2/session/multi/create/rko

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

Название	Обязательность	Тип	Описание
payment_details	-	object	Платежные данные для списания средств
payout_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/v1/session/multi/init/payment/rko

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

Название	Обязательность	Тип	Описание
payment_details	+	object	Платежные данные для списания средств
payment_method	+	object	Платежные данные для зачисления средств
customer	+	object	Данные получателя в вашей системе
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
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

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

/api/v2/session/multi/init/payment/rko

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

Название	Обязательность	Тип	Описание
payment_details	+	object	Платежные данные для списания средств
payout_details	+	object	Платежные данные для зачисления средств
customer	+	object	Данные получателя в вашей системе
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
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/v1/session/multi/start/payment/rko

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_details	+	object	Платежные данные для списания средств
payment_method	+	object	Платежные данные для зачисления средств
customer	+	object	Данные получателя в вашей системе
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
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

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

/api/v2/session/multi/start/payment/rko

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_details	+	object	Платежные данные для списания средств
payout_details	+	object	Платежные данные для зачисления средств
customer	+	object	Данные получателя в вашей системе
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
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/v1/session/start/payout/rko

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payment_method	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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"
      },
      "participant_details": {
        "sender": {
          "account": "40702810900000000011"
        }
      },
      "metadata": "good"
    }]
  }
}

Пример неуспешного ответа

{
  "status": "error",
  "error": {
    "description": "error description",
    "code": "error code"
  }
}

API v2

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

/api/v2/session/start/payout/rko

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

Название	Обязательность	Тип	Описание
session_id	+	string	Идентификатор платежной сессии
payout_details	+	object	Платежные данные для зачисления средств
amount_details	+	object	Сумма. Значение в минорных единицах валюты. Например, чтобы передать 100 рублей, укажите 10000
participant_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"
      },
      "participant_details": {
        "sender": {
          "account": "40702810900000000011"
        }
      },
      "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

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"
      }
    }
  }'

Обратный курс. Конвертация из 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": 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

{
  "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
    }
  }
}

Обратный курс. Конвертация из UZS в RUB

{
  "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	Объект для перевода наличными. Передается пустым: {}

Примеры запросов

Перевод с банковской карты на банковскую карту в Таджикистан

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"
          }
        }
      }
    }]
  }'

Перевод с банковской карты на 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": 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	Ошибка

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

Перевод с банковской карты на банковскую карту в Таджикистан

{
  "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
      }
    }]
  }
}

Перевод с банковской карты на IBAN в Турцию

{
  "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"
  }
}