.. meta::
   :description: Интеграция Payout по Форме с SBC: внешняя форма для сбора данных карты получателя и инициации payout через эндпоинт API v4 payout-form.

.. _/api/v4/payout-form:

Payout по Форме
===========


.. role:: ex

.. role:: code

Введение
------------

| Payout-form - это тип транзакции, в результате которой происходит перевод средств с банковского счёта Присоединяющейся Стороны на банковский счёт клиента (получателя) или в электронный кошелёк. Транзакция payout-form в большинстве случаев используется для пополнения банковского счёта. В отличие от интеграции Server-to-Server Payout, в которой Присоединяющаяся Сторона отправляет счёт получателя в первоначальном запросе, интеграция Payout по Форме позволяет получателю ввести данные банковского счёта на форме, размещённой на стороне SBC.
|
| Значение терминов см. в :ref:`Глоссарии<glossary>`.
|

1. Получатель заполняет форму payout и отправляет данные;

.. image:: /_static/images/payout_v4_flow/payout_v4_payment1.png
  :alt: Платёжная Форма
  :align: center
  :width: 550

2. Контекстные данные собираются SBC для обработки транзакции;

.. image:: /_static/images/3ds_server_to_server_sale_flow/wait_form.png
  :alt: Форма Ожидания
  :align: center
  :width: 550

3. Браузер Получателя перенаправляется на сайт Присоединяющейся Стороны на финальную страницу.

.. image:: /_static/images/payout_v4_flow/payout_v4_finish.jpg
  :alt: Финальная форма
  :align: center
  :width: 550


Сценарий Payout по Форме
----------------

.. uml::
  :align: center

  participant Получатель as R
  participant "Присоединяющаяся Сторона" as Cp
  autonumber
  group Опционально
  R -> Cp : Инициализация
  activate Cp
  end
  == Запрос выплаты по форме ==
  Cp -> SBC: /api/v4/payout-form/
  activate SBC
  SBC --> Cp: ИД транзакции\nredirect-url
  deactivate SBC
  Cp --> R : Перенаправление на форму \nвыплаты redirect-url
  deactivate Cp
  activate R
  R -> SBC : GET redirect-url
  deactivate R
  activate SBC
  SBC --> R : Форма Выплаты
  deactivate SBC
  activate R
  R -> SBC : Подтверждение формы
  deactivate R
  activate SBC
  SBC --> SBC : Обработка выплаты
  == Финальное перенаправление получателя ==
  SBC --> R :redirect_url веб-сайта \nПрисоединяющейся Стороны
  activate R
  R -> Cp : POST status,Order ID
  deactivate R
  activate Cp
  group Получение финального статуса
  == Получение обратного вызова \nПрисоединяющейся Стороны ==
  Cp <- SBC : Обратный вызов \nс финальным статусом
  SBC <-- Cp: HTTP 200
  deactivate SBC
  == Запрос статуса ==
  Cp -> SBC: Получение статуса по ИД транзакции\napi/v2/status
  activate SBC
  SBC --> Cp : Ответ\nstatus,order-stage
  deactivate SBC
  end
  group Опционально
  Cp --> R: Показ результата
  deactivate Cp
  end

| (1) Payout-form может быть инициирован Присоединяющейся Стороной на основании внутренней бизнес-модели или по запросу Получателя.
| (2) Для имплементации payout-form см. :ref:`/api/v2/payout/form/`.
| (9) Для имплементации финального перенаправления Плательщика см. :ref:`Финальное Перенаправление<final_redirect>`.
| (11) Для имплементации обратного вызова с обработкой финального статуса см. :ref:`Обратный вызов Присоединяющейся Стороны<merchant_callbacks>`.
| (13) Для имплементации запроса статуса заказа см.:ref:`/api/v2/status/</api/v2/status/>`. Статус должен запрашиваться несколько раз с интервалами в 3-5 секунд до получения финального статуса в ответе.
| (15) Финальный статус может быть отправлен Присоединяющейся Стороной в зависимости от внутренней бизнес-модели или запроса Получателя.

.. ifconfig:: "doc.payneteasy.com" in site_link

   ----

   .. admonition:: See also
      :class: related-cross-link

      `Global payout corridors: SEPA, SWIFT, local rails → <https://payneteasy.com/blog/global-payouts-how-to-pay-third-parties-globally-with-ease>`_

.. ifconfig:: "doc.payneteasy.ru" in site_link

   ----

   .. admonition:: См. также
      :class: related-cross-link

      `Финтех-решения: выплаты и переводы → <https://payneteasy.ru/branches/fintech>`_