.. meta::
   :description: /api/v4/payout-pay Wiserpay API endpoint: second step of two-step payout flow — confirm and execute payout after the payout-check call.

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

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

.. role:: ex

.. role:: code

Introduction
^^^^^^^^^^^^^^^^^^^^^^^^

Payout pay is initiated through :code:`HTTPS POST` request by using :ref:`URLs<payout-pay/apis>` and the :ref:`parameters<payout-pay_parameters>` specified below. Use :ref:`RSA-SHA256` for authentication.

.. _payout-pay/apis:

API URLs
^^^^^^^^^^^^^^^^^^^^

.. note::
    | The path in API URL should not be hardcoded, as it may be changed in future.

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

  * - Integration
    - Production
  * - :ex:`https://sandbox.wiserpay.pro/paynet/api/v4/payout-pay/ENDPOINTID`
    - :ex:`https://gate.wiserpay.pro/paynet/api/v4/payout-pay/ENDPOINTID`
  * - :ex:`https://sandbox.wiserpay.pro/paynet/api/v4/payout-pay/group/ENDPOINTGROUPID`
    - :ex:`https://gate.wiserpay.pro/paynet/api/v4/payout-pay/group/ENDPOINTGROUPID`


.. _payout-pay_parameters:

Request Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. note::
  | Request must have content-type=application/x-www-form-urlencoded and :ref:`Authorization headers<RSA-SHA256>`.

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

  * - Parameter Name
    - Description
    - Value
  * - :code:`client_orderid`
    - Connecting Party's order identifier.
    - | ``Necessity``: Required
  * - :code:`orderid`
    - Order id assigned to the order by Wiserpay.
    - | ``Necessity``: Required
  * - :code:`login`
    - Connecting Party login name.
    - | ``Necessity``: Required

\* Ask Support Manager if Conditional fields are Required for integration.

Response Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. note::
  | Response has Content-Type: text/html;charset=utf-8 header. All fields are x-www-form-urlencoded, with (0xA) character at the end of each parameter’s value.

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

  * - Payout Pay Response Parameters
    - Description
  * - :code:`type`
    - The type of response. May be :ex:`async-response`, :ex:`validation-error`, :ex:`error`. If type equals :ex:`validation-error` or :ex:`error`, :ex:`error-message` and :ex:`error-code` parameters contain error details
  * - :code:`paynet-order-id`
    - Order id assigned to the order by Wiserpay.
  * - :code:`merchant-order-id`
    - Connecting Party order id.
  * - :code:`serial-number`
    - Unique number assigned by Wiserpay server to particular request from the Connecting Party.
  * - :code:`error-message`
    - If status is :ex:`error` this parameter contains the reason for decline or error details.
  * - :code:`error-code`
    - The error code is case of :ex:`error` status.

Request Example
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: guess

  POST /paynet/api/v4/payout-pay/39915 HTTP/1.1
  Host: sandbox.wiserpay.pro
  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


Success Response Example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Fail Response Example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


.. only:: openapi_doc_enabled

    Open API Collection
    ^^^^^^^^^^^^^^^^^^^

    Open this method in the OpenAPI Reference

    .. raw:: html

        <a class="openapi-reference-button" href="/openapi-doc/#POST/api/v4/payout-pay/{endpointId}" target="_blank" rel="noopener">View in OpenAPI <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"/><polyline points="15 3 21 3 21 9"/><line x1="10" y1="14" x2="21" y2="3"/></svg></a>

Postman Collection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Request Builder
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Insert PKCS#1 PEM private key for sandbox environment in the field below. Request builder supports up to 4096 key length.

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