.. meta::
   :description: Эндпоинт API /api/v4/payout-pay Payneteasy: второй шаг двухэтапного процесса выплаты — подтверждение и выполнение выплаты после вызова payout-check.

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

/api/v4/payout-pay
##############################

.. role:: ex

.. role:: code

Введение
^^^^^^^^^^^^^^^^^^^^^^^^

Выплата инициируется через зарос :code:`HTTPS POST` на указанный ниже :ref:`Ссылки<payout-check/apis>` с использованием указанных :ref:`параметров<payout-check_parameters>` в зависимости от типа выплаты. Для аутентификации запроса используется :ref:`RSA-SHA256`

.. _payout-pay/apis:

API URL
^^^^^^^^^^^^^^^^^^^^

.. note::
    | Путь API URL не должен быть задан фиксированным значением, т.к. он может быть изменён позднее.

.. list-table::
  :widths: 50, 50
  :header-rows: 1
  :class: longtable

  * - Интеграционная среда
    - Производственная среда
  * - :ex:`https://sandbox.payneteasy.ru/paynet/api/v4/payout-pay/ENDPOINTID`
    - :ex:`https://gate.payneteasy.ru/paynet/api/v4/payout-pay/ENDPOINTID`
  * - :ex:`https://sandbox.payneteasy.ru/paynet/api/v4/payout-pay/group/ENDPOINTGROUPID`
    - :ex:`https://gate.payneteasy.ru/paynet/api/v4/payout-pay/group/ENDPOINTGROUPID`


.. _payout-pay_parameters:

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

.. note::
  | Запрос должен иметь content-type=application/x-www-form-urlencoded и :ref:`Заголовки авторизации<RSA-SHA256>`.

.. list-table::
  :widths: 35, 50, 20
  :header-rows: 1
  :class: longtable

  * - Название параметра
    - Описание
    - Значение
  * - :code:`client_orderid`
    - Идентификатор заказа, присвоенный Присоединяющейся Стороной.
    - | ``Необходимость``: Обязательно
  * - :code:`orderid`
    - Идентификатор заказа, присвоенный Payneteasy.
    - | ``Необходимость``: Обязательно
  * - :code:`login`
    - Логин Присоединяющейся Стороны в Платёжном Шлюзе.
    - | ``Необходимость``: Обязательно

\* Спросите менеджера службы поддержки если условные параметры обязательны для интеграции

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

.. note::
  | Ответ имеет заголовок Content-Type: text/html;charset=utf-8. Все поля имеют кодировку x-www-form-urlencoded, с символом (0xA) в конце значения каждого параметра.

.. list-table::
  :widths: 35, 65
  :header-rows: 1
  :class: longtable

  * - Параметры Ответа Выплаты
    - Описание
  * - :code:`type`
    - Тип ответа. Может принимать такие значения как: :ex:`async-response`, :ex:`validation-error`, :ex:`error` и т.д. Если тип ответа :ex:`validation-error` или :ex:`error`, параметры :ex:`error-message` и :ex:`error-code` будут содержать детали ошибки.
  * - :code:`paynet-order-id`
    - Идентификатор заказа, присвоенный Payneteasy.
  * - :code:`merchant-order-id`
    - Идентификатор заказа Присоединяющейся Стороны.
  * - :code:`serial-number`
    - Уникальный номер, присваиваемый сервером Payneteasy конкретному запросу от Присоединяющейся стороны.
  * - :code:`error-message`
    - Для транзакций в статусе :ex:`error` этот параметр будет содержать причину отклонения или сведения об ошибке.
  * - :code:`error-code`
    - Код ошибки для транзакций в статусе :ex:`error`.

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

.. code-block:: guess

  POST /paynet/api/v4/payout-pay/39915 HTTP/1.1
  Host: sandbox.payneteasy.ru
  User-Agent: curl/7.83.0
  Accept: */*
  Authorization: OAuth oauth_consumer_key="TestMerchant", oauth_nonce="b5E31Tw6SVjauE29uOf2jOLnuUSXmVdE", oauth_signature="WrW79JHNUVwDRhCGWQYgaN6xmJXpQxy8XSNyCOL6b2Wyf7V5BWGMe2TZa1bjC9ZeO0Q3FcQxeGGHv0%2F7hsMAsJNQEET321VNsbDwao2Ep%2Bp7eoYiGYrVveSrSW1diCrBf3AJYJZM0PTJ67Sl8XyeTVBHT4kpC5qBu3xDQ3aFfKnmRTmn9fiVsYsYu3DQrsHM1K9uAoltGt3Muz0kCDZ3MWNGrNqtdpWuar8HRQD3kckcPjuN9D6VrSuQm9eLx27G%2FvkiP%2BZ44i8ghIUp61NWSrJ4Ky69JiZ%2FoaVVmUTEaanc%2F%2B%2BQT6jBwWy%2Bb%2FTLUrxtSakeNfcjn1JVwRf4aCX2fhyG5ozH%2BjiXF6eRb83WVqBUAwykSq35pLU3Vmua3pKMKAJK1ZRDZdjGrT50KJg5tBniC4JFzdQqjQf%2FhFnDYodfIK3S2qZo%2FD3Bmlya46iEcK6SAQdNBBQue3E5Qi8FEHYrY1o7K8wDyzT1QzqqHF%2BQdmXcElSGu9ge0Y655%2BbGtXhnsUWnKEO0NGqErvAwzm7yUg0e5QWHVf505aE7pr5K4z%2Fzj7AvkuD7R1savqam%2BnnuSfq1E%2BnnnN7mTcC0g18Sr38vdTshcGq99YW3xWKc%2FpuooZYdYa5A6u46o%2BREZSTCD2XexcV49%2F9eVn3xdoTXYq4NISJSY8U7ThKnr0g%3D", oauth_signature_method="RSA-SHA256", oauth_timestamp="1677831012", oauth_version="1.0"
  Content-Length: 51
  Content-Type: application/x-www-form-urlencoded
  Connection: close

  client_orderid=3
  &login=test-merchant
  &orderid=900258


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

.. code-block:: javascript

  HTTP/1.1 200
  Server: server
  Date: Fri, 03 Mar 2023 08:10:34 GMT
  Content-Type: text/html;charset=utf-8
  Connection: close
  Vary: Accept-Encoding
  X-XSS-Protection: 1
  X-Content-Type-Options: nosniff
  Strict-Transport-Security: max-age=31536000
  Content-Language: en-US
  Strict-Transport-Security: max-age=31536000
  Content-Length: 137

  type=async-response
  &serial-number=00000000-0000-0000-0000-000002e2c322
  &merchant-order-id=1
  &paynet-order-id=900258
  &end-point-id=39915

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

.. code-block:: guess

  HTTP/1.1 403 Forbidden
  Server: server
  Date: Thu, 25 Aug 2022 06:50:16 GMT
  Content-Type: text/html
  Content-Length: 735
  Connection: close
  X-XSS-Protection: 1
  X-Content-Type-Options: nosniff
  Strict-Transport-Security: max-age=31536000

  <!DOCTYPE html>
  <html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title>403</title>

  <style type="text/css">
  body {
  font-family: Arial, sans-serif;
  font-size: 130%;
  background-color: #eee;
  }

  p {
  margin: 10em auto 0;
  width: 500px;
  border: 1px solid gray;
  text-align: center;
  vertical-align: middle;
  padding: 40px 20px;
  background-color: #fff;
  -webkit-border-radius: 20px;
  -moz-border-radius: 20px;
  border-radius: 20px;
  }
  </style>
  </head>

  <body>
  <p>Access is denied</p>
  </body>
  </html>


Коллекция Postman
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. raw:: html
    :file: ../_static/Postman/Postman_payout_with_two_stages.html

Конструктор запросов
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Вставьте приватный ключ PKCS#1 PEM для среды sandbox в поле ниже. Конструктор запросов поддерживает длину ключа до 4096.

.. raw:: html
    :file: ../_static/examples/V4Payout-pay_Debug.html