.. meta::
   :description: /api/v2/card-insurance-document API endpoint SBC: прикрепляет данные страхового документа к транзакции Sale или preauth через API для страховых полисов.

.. _api_v2_card-insurance-document:

/api/v2/card-insurance-document
###############################

.. role:: ex

.. role:: code

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

| Для получения документа о страховании необходимо инициировать :code:`HTTPS POST` запрос с использованием указанных ниже :ref:`URLs<api_v2_card-insurance-document_request_url>` и :ref:`parameters<api_v2_card-insurance-document_request_parameters>`. Запрос подписывается с помощью :ref:`OAuth HMAC-SHA1<HMAC-SHA1>`. См. :ref:`statuses`.
|

.. note::
    | После успешного завершения транзакции, необходимо сформировать запрос для скачивания условий страхования с данными плательщика в формате PDF. 

.. _api_v2_card-insurance-document_request_url:

API URL
^^^^^^^^

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

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

    * - Интеграционная среда
      - Производственная среда
    * - :ex:`https://sandbox.sbctech.ru/paynet/api/v2/card-insurance-document/ENDPOINTID`
      - :ex:`https://gate.sbctech.ru/paynet/api/v2/card-insurance-document/ENDPOINTID`

.. _api_v2_card-insurance-document_request_parameters:

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

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

    * - Название параметра
      - Описание
    * - :code:`client-order-id`
      - Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной.
    * - :code:`order_id`
      - Идентификатор заказа, присвоенный SBC.


.. _api_v2_card-insurance-document_response_parameters:

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

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

    * - Название параметра
      - Описание
    * - :code:`request_serial_number`
      - Уникальный номер, присвоенный сервером SBC конкретному запросу от Присоединяющейся Стороны.
    * - :code:`document_path`
      - Ссылка для скачивания документа

Пример запроса
^^^^^^^^^^^^^^^
.. highlight:: none

::

    POST /paynet/api/v2/card-insurance-document/3213 HTTP/1.1
    User-Agent: curl/8.7.1
    Accept: */*
    Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="merchantlogin",oauth_signature_method="HMAC-SHA1",oauth_signature="IibClG%2FGfoxiGvKSyRovTH0P1Pg%3D"
    Content-Length: 120
    Content-Type: application/x-www-form-urlencoded
    Connection: close

    client-order-id=Value&oauth_consumer_key=merchantlogin&oauth_signature_method=HMAC-SHA1&oauth_version=1.0&order_id=Value

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

.. highlight:: none

::

 {
   "request_serial_number": "00000000-0000-0000-0000-000001fd4472",
   "document_path": "https://sandbox.sbctech.ru/paynet/api/v2/download/card-ins-12345678912345678912"
 }

.. note::
    | Полученная ссылка должна быть отображена в браузере плательщика.

.. warning::
    | Файл доступен для одного скачивания.

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

.. highlight:: none

::

    HTTP/1.1 403
    Server: server
    Date: Fri, 14 Feb 2025 10:27:47 GMT
    Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    Connection: close
    X-XSS-Protection: 1
    X-Content-Type-Options: nosniff
    Strict-Transport-Security: max-age=31536000
    Content-Length: 102

    type=error
    &serial-number=00000000-0000-0000-0000-000002f38fde
    &error-message=Forbidden
    &error-code=-1

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

.. raw:: html
    :file: ../_static/examples/oauth_Debug(d2ins).html