.. meta::
   :description: /api/v2/pan-eligibility API endpoint SBC: проверяет, поддерживает ли карта платежи OCT (push) перед инициацией выплаты или перевода денег.

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

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


.. role:: ex

.. role:: code

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

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

.. _api_v2_pan-eligibility_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/ENDPOINTID`
     - :ex:`https://gate.sbctech.ru/paynet/api/v2/pan-eligibility/send/ENDPOINTID`
   * - Receiving-only
     - :ex:`https://sandbox.sbctech.ru/paynet/api/v2/pan-eligibility/receive/ENDPOINTID`
     - :ex:`https://gate.sbctech.ru/paynet/api/v2/pan-eligibility/receive/ENDPOINTID`
   * - Both
     - :ex:`https://sandbox.sbctech.ru/paynet/api/v2/pan-eligibility/both/ENDPOINTID`
     - :ex:`https://gate.sbctech.ru/paynet/api/v2/pan-eligibility/both/ENDPOINTID`


.. _api_v2_pan-eligibility_request_parameters:

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

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

.. tabs::

   .. tab:: Sending-only

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

         * - Параметр
           - Описание
           - Значение
         * - :code:`client_orderid`
           - Идентификатор заказа Присоединяющейся стороны.
           - | ``Необходимость``: Обязательно
             | ``Тип``: String
             | ``Длина``: 128
         * - :code:`sending-card-number`
           - | Номер банковской карты Отправителя.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 19
         * - :code:`card-printed-name`
           - | Имя Отправителя-владельца карты.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: String
             | ``Длина``: 128
         * - :code:`expire-month`
           - | Месяц окончания срока действия банковской карты Отправителя.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 2
         * - :code:`expire-year`
           - | Год окончания срока действия банковской карты Отправителя.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 4
         * - :code:`sending-card-ref-id`
           - | Описание: Sender`s card ref ID.
             | (если :ex:`sending-card-number` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 20
         * - :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
             | ``Длина``: 1024
         * - :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
             | ``Длина``: 1024

   .. tab:: Receiving-only

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

         * - Параметр
           - Описание
           - Значение
         * - :code:`client_orderid`
           - Идентификатор заказа Присоединяющейся стороны.
           - | ``Необходимость``: Обязательно
             | ``Тип``: String
             | ``Длина``: 128
         * - :code:`receiving-card-number`
           - | Номер кредитной карты получателя.
             | (если :ex:`receiving-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 19
         * - :code:`receiving-card-ref-id`
           - | Описание: Receiver`s card ref ID.
             | (если :ex:`receiving-card-number` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Length``:
         * - :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
             | ``Длина``: 1024
         * - :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
             | ``Длина``: 1024

   .. tab:: Both

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

         * - Параметр
           - Описание
           - Значение
         * - :code:`client_orderid`
           - Идентификатор заказа Присоединяющейся стороны.
           - | ``Необходимость``: Обязательно
             | ``Тип``: String
             | ``Длина``: 128
         * - :code:`sending-card-number`
           - | Описание: Sender`s card number.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 19
         * - :code:`card-printed-name`
           - | Имя Отправителя-владельца карты.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: String
             | ``Длина``: 128
         * - :code:`expire-month`
           - | Месяц окончания срока действия банковской карты Отправителя.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 2
         * - :code:`expire-year`
           - | Год окончания срока действия банковской карты Отправителя.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 4
         * - :code:`sending-card-ref-id`
           - | Описание: Sender`s card ref ID.
             | (если :ex:`sending-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 20
         * - :code:`receiving-card-number`
           - | Номер карты получателя.
             | (если :ex:`receiving-card-ref-id` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Длина``: 19
         * - :code:`receiving-card-ref-id`
           - | Описание: Receiver`s card ref ID.
             | (если :ex:`receiving-card-number` не указан)
           - | ``Необходимость``: Обязательно
             | ``Тип``: Numeric
             | ``Length``:
         * - :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
             | ``Длина``: 1024
         * - :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
             | ``Длина``: 1024

.. _api_v2_pan-eligibility_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 Request Example
^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

   POST /paynet/api/v2/pan-eligibility/send/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="test_merch",oauth_timestamp="1687507082",oauth_nonce="XQkXQgLxhCE",oauth_signature_method="HMAC-SHA1",oauth_signature="lLTiOEyUY%2FwibmGVA%2F5rY6qIS9I%3D"
   Content-Length: 192
   Content-Type: application/x-www-form-urlencoded
   Connection: close

   client_orderid=1234567890
   &oauth_consumer_key=test_merch
   &oauth_nonce=XQkXQgLxhCE
   &oauth_signature_method=HMAC-SHA1
   &oauth_timestamp=1687507082
   &oauth_version=1.0
   &sending-card-ref-id=1461790

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

.. 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-000002ecbcba
   &merchant-order-id=1234567890
   &paynet-order-id=7216063
   &end-point-id=39907

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

.. code-block:: http

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

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

Receive Request Example
^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

   POST /paynet/api/v2/pan-eligibility/receive/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="test_merch",oauth_timestamp="1687507082",oauth_nonce="XQkXQgLxhCE",oauth_signature_method="HMAC-SHA1",oauth_signature="lLTiOEyUY%2FwibmGVA%2F5rY6qIS9I%3D"
   Content-Length: 192
   Content-Type: application/x-www-form-urlencoded
   Connection: close

   client_orderid=1234567890
   &oauth_consumer_key=test_merch
   &oauth_nonce=XQkXQgLxhCE
   &oauth_signature_method=HMAC-SHA1
   &oauth_timestamp=1687507082
   &oauth_version=1.0
   &receiving-card-number=4444555566661111

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

.. 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-000002ecbcba
   &merchant-order-id=1234567890
   &paynet-order-id=7216063
   &end-point-id=39907

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

.. code-block:: http

   HTTP/1.1 200 OK
   Server: server
   Date: Mon, 22 Aug 2022 12:19:29 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 Request Example
^^^^^^^^^^^^^^^^^^^^

.. code-block:: http

   POST /paynet/api/v2/pan-eligibility/both/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="test_merch",oauth_timestamp="1687513856",oauth_nonce="T0z9qml2rDZ",oauth_signature_method="HMAC-SHA1",oauth_signature="rsHewN7TRIxzPQAtd99z5eoSyJY%3D"
   Content-Length: 231
   Content-Type: application/x-www-form-urlencoded
   Connection: close

   client_orderid=1234567890
   &oauth_consumer_key=test_merch
   &oauth_nonce=T0z9qml2rDZ
   &oauth_signature_method=HMAC-SHA1
   &oauth_timestamp=1687513856
   &oauth_version=1.0
   &receiving-card-number=4444555566661111
   &sending-card-ref-id=1461790

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

.. code-block:: http

   HTTP/1.1 200
   Server: server
   Date: Fri, 23 Jun 2023 09:51:15 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: 146

   type=async-response
   &serial-number=00000000-0000-0000-0000-000002ecbcc2
   &merchant-order-id=1234567890
   &paynet-order-id=7216068
   &end-point-id=39907

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

.. code-block:: http

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

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

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