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

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

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

Полученный токен можно использовать независимо от проекта (X-PARTNER-PROJECT), в рамках которого он был создан.

От того, какой способ вы выберите, зависит объем требований PCI DSS, которые необходимо соблюдать.

Шаг 1. Получите публичный токен​

Публичный токен нужен, чтобы инициализировать виджет. Отправьте запрос Банку 131 на создание токена (token), передав в нем тип виджета tokenize_widget. В ответе вы получите публичный токен.

Пример получения публичного токена
curl -X POST \
  http://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
    }
  }'

Шаг 2. Инициализируйте виджет на сайте​

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

После этого получатель выплаты сможет ввести свой номер банковской карты в форму сбора данных.

Шаг 3. Создайте платежную сессию​

Отправьте запрос на создание платежной сессии session/create. В ответе вы получите идентификатор сессии. Этот идентификатор используется во всех последующих методах.

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

Пример создания платежной сессии
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 '{
    "metadata": "good"
  }'

Шаг 4. Отправьте выплату​

Выполните запрос session/start/payout, передав идентификатор сессии и параметры выплаты.

к сведению

Вы можете проверить данные хеша или карты с помощью метода token/info. Например, можно узнать последние 4 цифры номера карты, чтобы показать получателю, на какую именно карту придет выплата.

Пример выплаты с виджетом
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",
    "payment_method": {
      "type": "card",
      "card": {
        "type": "encrypted_card",
        "encrypted_card": {
          "number_hash": "63191fa17cc7edf818ee5d6611a2c2169ab30b705111cffd710af39880deef09"
        }
      }
    },
    "participant_details": {
      "recipient": {
        "full_name": "Иванов Иван Иванович"
      }
    },
    "amount_details": {
      "amount": 10000,
      "currency": "rub"
    },
    "metadata": "good"
  }'

Шаг 5. Дождитесь вебхука о готовности выплаты​

Банк 131 отправит вам вебхук ready_to_confirm о готовности провести выплату и ожидании вашего подтверждения или отмены.

Пример вебхука о готовности выплаты
curl -X POST \
  https://partner.ru \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-SIGN: signature' \
  -d '{
    "type": "ready_to_confirm",
    "session": {
      "id": "ps_3230",
      "status": "in_progress",
      "created_at": "2025-05-27T02:03:00.340663Z",
      "updated_at": "2025-05-27T02:03:00.745032Z",
      "next_action": "confirm",
      "payments": [{
        "id": "po_2025",
        "status": "pending",
        "created_at": "2025-05-27T02:03:00.203301Z",
        "payment_method": {
          "type": "card",
          "card": {
            "last4": "4940",
            "brand": "mir",
            "bin": "220024",
            "country_iso3": "RUS"
          }
        },
        "participant_details": {
          "recipient": {
            "full_name": "Иванов Иван Иванович"
          }
        },
        "amount_details": {
          "amount": 10000,
          "currency": "rub"
        },
        "metadata": "good"
      }]
    }
  }'
Пример обработки вебхука с помощью SDK
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\Services\WebHook\Hook\WebHookTypeEnum;

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

$client = new Client($config);

$hook = $client->handleWebHook('sign from headers', 'request body');

if ($hook->getType() === WebHookTypeEnum::READY_TO_CONFIRM) {
    //do your logic here
}

Шаг 6. Подтвердите или отмените выплату​

Проверьте данные и подтвердите (session/confirm) или отмените (session/cancel) выплату.

Пример с подтверждением выплаты
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"
  }'
Пример с отменой выплаты
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"
  }'

Шаг 7. Дождитесь вебхука о результате выплаты​

Банк 131 отправит вам вебхук payment_finished. Информация о результате выплаты содержится в параметре status объекта payments/payout_list.

Статус succeeded означает, что выплата прошла успешно. Если статус failed — выплата не прошла из-за ошибки.

Какие бывают статусы выплаты >

Посмотреть коды ошибок >

Пример обработки вебхука с помощью SDK
use Bank131\SDK\Client;
use Bank131\SDK\Config;
use Bank131\SDK\Services\WebHook\Hook\WebHookTypeEnum;

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

$client = new Client($config);

$hook = $client->handleWebHook('sign from headers', 'request body');

if ($hook->getType() === WebHookTypeEnum::PAYMENT_FINISHED) {
    $session = $hook->getSession();
    //do your logic here
}