.. meta::
   :description: /api/v2/pan-eligibility/form API endpoint SBC: проверяет пригодность карты для OCT через размещённую форму, в которой получатель вводит данные карты.

.. _/api/v2/pan-eligibility-form/:

/api/v2/pan-eligibility/form
############################

.. role:: ex

.. role:: code

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

Форма PAN Eligibility инициируется посредством запроса :code:`HTTPS POST` с использованием указанных ниже :ref:`URL<api_v2_pan-eligibility_form_request_url>` и :ref:`параметров<api_v2_pan-eligibility_form_request_parameters>`. Для аутентификации используйте :ref:`OAuth HMAC-SHA1<HMAC-SHA1>`. См. :ref:`statuses`.

.. _api_v2_pan-eligibility_form_request_url:

PAN Eligibility API URLs
^^^^^^^^^^^^^^^^^^^^^^^^

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

.. list-table::
   :widths: 15, 45, 40
   :header-rows: 1
   :class: longtable

   * - Method
     - Интеграционная среда
     - Производственная среда
   * - Sending-only
     - :ex:`https://sandbox.sbctech.ru/paynet/api/v2/pan-eligibility/send-form/ENDPOINTID`
     - :ex:`https://gate.sbctech.ru/paynet/api/v2/pan-eligibility/send-form/ENDPOINTID`
   * - Receiving-only
     - :ex:`https://sandbox.sbctech.ru/paynet/api/v2/pan-eligibility/receive-form/ENDPOINTID`
     - :ex:`https://gate.sbctech.ru/paynet/api/v2/pan-eligibility/receive-form/ENDPOINTID`
   * - Both
     - :ex:`https://sandbox.sbctech.ru/paynet/api/v2/pan-eligibility/both-form/ENDPOINTID`
     - :ex:`https://gate.sbctech.ru/paynet/api/v2/pan-eligibility/both-form/ENDPOINTID`

.. _api_v2_pan-eligibility_form_request_parameters:

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

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

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

  * - Название параметра
    - Описание
    - Значение
  * - :code:`client_orderid`
    - Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной.
    - | ``Необходимость``: Обязательно
      | ``Тип``: String
      | ``Длина``: 128
  * - :code:`redirect_url`
    - | URL, where the Payer is redirected to upon completion of the transaction.
        Please note that redirection is performed in any case, no matter whether transaction is :ex:`approved`, :ex:`declined` in any other final :ref:`status<statuses>`.
      | Connecting Party must not use the parameters come along with the redirect HTTP Request to treat the status of the transaction.
        Instead Connecting Party can utilize :ex:`server_callback_url` or :ref:`status API command</api/v2/status/>`.
        Pass :ex:`https://doc.sbctech.ru` if you have no need to return payer anywhere. Use either :ex:`redirect_url` or combination of :ex:`redirect_success_url` and :ex:`redirect_fail_url`, not both.
    - | ``Необходимость``: Опционально
      | ``Тип``: String
      | ``Длина``: 128
  * - :code:`server_callback_url`
    - | URL-адрес :ex:`server_callback_url`, по которому будет отправлен обратный вызов с результатом транзакции. Присоединяющаяся сторона может использовать обратные вызовы для индивидуальной обработки завершения транзакции (например, для сбора данных о платежах в информационной системе Присоединяющейся стороны). Список параметров, включенных в обратный вызов, см. в разделе :ref:`Обратного вызова Присоединяющейся стороны<merchant_callback_parameters>`. Данный параметр может быть передан вместо :ex:`notify_url`. При использовании :ex:`server_callback_url` платежный шлюз отправляет callback-уведомление только при получении финального статуса исходной транзакции. При использовании :ex:`notify_url` платежный шлюз отправляет уведомление при получении финального статуса и продолжает отправлять уведомления о всех последующих изменениях (возвраты, chargeback и др.).
    - | ``Необходимость``: Опционально
      | ``Тип``: String
      | ``Длина``: 128
  * - :code:`notify_url`
    - | URL-адрес :ex:`notify_url`, по которому будет отправлен обратный вызов с результатом транзакции. Присоединяющаяся сторона может использовать обратные вызовы для индивидуальной обработки завершения транзакции (например, для сбора данных о платежах в информационной системе Присоединяющейся стороны). Список параметров, включенных в обратный вызов, см. в разделе :ref:`Обратного вызова Присоединяющейся стороны<merchant_callback_parameters>`. Данный параметр может быть передан вместо :ex:`server_callback_url`. При использовании :ex:`notify_url` платежный шлюз отправляет уведомление при получении финального статуса и продолжает отправлять уведомления о всех последующих изменениях (возвраты, chargeback и др.). При использовании :ex:`server_callback_url` платежный шлюз отправляет callback-уведомление только при получении финального статуса исходной транзакции.
    - | ``Необходимость``: Опционально
      | ``Тип``: String
      | ``Длина``: 128

.. _api_v2_pan-eligibility-form_response_parameters:

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

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

.. list-table::
   :widths: 25, 75
   :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`
     - Идентификатор заказа, присвоенный SBC.
   * - :code:`merchant-order-id`
     - Идентификатор заказа Присоединяющейся Стороны.
   * - :code:`serial-number`
     - Уникальный номер, присваиваемый сервером SBC конкретному запросу от Присоединяющейся стороны.
   * - :code:`error-message`
     - Для транзакций в статусе :ex:`error` этот параметр будет содержать причину отклонения или сведения об ошибке.
   * - :code:`error-code`
     - Код ошибки для транзакций в статусе :ex:`error`.

Пример запроса send-form
^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

    POST /paynet/api/v2/pan-eligibility/send-form/39907 HTTP/1.1
    Host: sandbox.sbctech.ru
    User-Agent: curl/7.83.0
    Accept: */*
    Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="javid_test_merch",oauth_timestamp="1687507473",oauth_nonce="Gs2vcwIXv6H",oauth_signature_method="HMAC-SHA1",oauth_signature="sMQWXIUY0OTgBzt2OavSFhT3Q3s%3D"
    Content-Length: 192
    Content-Type: application/x-www-form-urlencoded
    Connection: close

    client-order-id=1234567890
    &oauth_consumer_key=test_merch
    &oauth_nonce=Gs2vcwIXv6H
    &oauth_signature_method=HMAC-SHA1
    &oauth_timestamp=1687507473
    &oauth_version=1.0
    &redirect-url=http%3A%2F%2Fsandbox.sbctech.ru%2Fdoc%2Fdummy.htm

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

.. code-block:: http

   HTTP/1.1 200
   Server: server
   Date: Wed, 21 Jun 2023 11:19:20 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: 147

   type=async-response
   &serial-number=00000000-0000-0000-0000-000002ec863e
   &merchant-order-id=1234567890
   &paynet-order-id=7211136
   &redirect-url=https%3A%2F%2Fsandbox.sbctech.ru%2Fpaynet%2Fform%2Fpan-eligibility%2Finit%2FBB3757784F4A53585143535A554E2F4D6A3264715A616E744C6C31667043414962654534575039376E636F343D

Пример ответа об ошибке send-form
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

   HTTP/1.1 200 OK
   Server: server
   Date: Mon, 22 Aug 2022 12:59:09 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: 154

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

Пример запроса receive-form
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

   POST /paynet/api/v2/pan-eligibility/receive-form/39907 HTTP/1.1
   Host: sandbox.sbctech.ru
   User-Agent: curl/7.83.0
   Accept: */*
   Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="javid_test_merch",oauth_timestamp="1687511712",oauth_nonce="cRmRev3FdaP",oauth_signature_method="HMAC-SHA1",oauth_signature="6zWG0Sli0dehdFikhoGdoEqhcQA%3D"
   Content-Length: 226
   Content-Type: application/x-www-form-urlencoded
   Connection: close

   client-order-id=1234567890
   &oauth_consumer_key=test_merch
   &oauth_nonce=cRmRev3FdaP
   &oauth_signature_method=HMAC-SHA1
   &oauth_timestamp=1687511712
   &oauth_version=1.0
   &redirect-url=http%3A%2F%2Fsandbox.sbctech.ru%2Fdoc%2Fdummy.htm

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

.. code-block:: http

   HTTP/1.1 200
   Server: server
   Date: Wed, 21 Jun 2023 12:19:20 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: 147

   type=async-response
   &serial-number=00000000-0000-0000-0000-000002ec863e
   &merchant-order-id=1234567890
   &paynet-order-id=7211136
   &redirect-url=https%3A%2F%2Fsandbox.sbctech.ru%2Fpaynet%2Fform%2Fpan-eligibility%2Finit%2FBB3757784F4A53585143535A554E2F4D6A3264715A616E744C6C316670434149626545436159574254497A4D3D

Пример ответа об ошибке receive-form
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

   HTTP/1.1 200 OK
   Server: server
   Date: Mon, 22 Aug 2022 12:59:09 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: 154

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

Пример запроса both-form
^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

    POST /paynet/api/v2/pan-eligibility/both-form/39907 HTTP/1.1
    Host: sandbox.sbctech.ru
    User-Agent: curl/7.83.0
    Accept: */*
    Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="javid_test_merch",oauth_timestamp="1687512444",oauth_nonce="Nu8SL8l70H2",oauth_signature_method="HMAC-SHA1",oauth_signature="wypHgzYjxmKrdshhj1CabwPGnnA%3D"
    Content-Length: 226
    Content-Type: application/x-www-form-urlencoded
    Connection: close

    client-order-id=1234567890
    &oauth_consumer_key=test_merch
    &oauth_nonce=Gs2vcwIXv6H
    &oauth_signature_method=HMAC-SHA1
    &oauth_timestamp=1687507765
    &oauth_version=1.0
    &redirect-url=http%3A%2F%2Fsandbox.sbctech.ru%2Fdoc%2Fdummy.htm

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

.. code-block:: http

   HTTP/1.1 200
   Server: server
   Date: Wed, 21 Jun 2023 13:19:20 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: 147

   type=async-response
   &serial-number=00000000-0000-0000-0000-000002ec863e
   &merchant-order-id=1234567890
   &paynet-order-id=7211136
   &redirect-url=https%3A%2F%2Fsandbox.sbctech.ru%2Fpaynet%2Fform%2Fpan-eligibility%2Finit%2FBB3757784F4A53585143535A554E2F4D6A3264715A616E744C6C31667043414962654534575039376E636F343D

Пример ответа об ошибке both-form
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

   HTTP/1.1 200 OK
   Server: server
   Date: Mon, 22 Aug 2022 13:19:09 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: 154

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

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

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

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

.. raw:: html
      :file: ../_static/examples/oauth_Debug_both_form.html