.. meta::
   :description: Sale Status API в процессе Mobile Device Payneteasy: опрашивает текущий статус транзакции Sale, инициированной с мобильного устройства, из мобильного приложения.

.. _api_sale_status:

Sale статус
###########


.. role:: ex

.. role:: code

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

| Sale статус инициируется через запрос :code:`HTTPS POST` с использованием :ref:`URLs<api_url_sale_status>` и :ref:`parameters<api_parameters_sale_status>`.
| Sale статус запрос is made by Присоединяющаяся сторона’s app to site.company_название to get the статус of sale транзакция. Payneteasy
| Рекомендуется отправлять запрос статуса Sale в течение 2–3 минут с интервалом 3–5 секунд между запросами. Сервер Присоединяющейся стороны должен полагаться на callback для получения окончательного статуса.

.. _api_url_sale_status:

API URL
^^^^^^^^

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

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

   * - Интеграционная среда
     - Производственная среда
   * - :ex:`https://sandbox.payneteasy.ru/paynet/dapi/v1/sale/{endpointId}/{invoiceId}/status`
     - :ex:`https://gate.payneteasy.ru/paynet/dapi/v1/sale/{endpointId}/{invoiceId}/status`

.. _api_parameters_sale_status:

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

.. list-table::
   :widths: 30, 45, 25
   :header-rows: 1
   :class: longtable

   * - Название параметра
     - Описание
     - Значение
   * - :code:`session`
     -
     - | ``Тип``: **Object**
   * - :code:`session.accessToken`
     - The access token key received in Необязательное потребителя authentication.
     - | ``Тип``: String
       | ``Длина``: 32-128
   * - :code:`session.token`
     - Session token транзакции sale.
     - | ``Тип``: String
       | ``Длина``: 16-36

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

.. list-table::
   :widths: 30, 45, 25
   :header-rows: 1
   :class: longtable

   * - Название параметра
     - Описание
     - Значение
   * - :code:`invoiceId`
     - Идентификатор транзакции sale.
     - | ``Тип``: String
   * - :code:`session`
     -
     - | ``Тип``: **Object**
   * - :code:`session.token`
     - The session token of sale транзакция
     - | ``Тип``: String
   * - :code:`state`
     - Возможные значения: ``PROCESSING``, ``REDIRECT_REQUEST``, ``APPROVED``, ``DECLINED``.
     - | ``Тип``: Enum
   * - :code:`bankOrderId`
     - Обязательное if state is ``APPROVED`` or ``DECLINED``.
     - | ``Необходимость``: Условно
       | ``Тип``: String
       | ``Длина``: 128
   * - :code:`redirectUrl`
     - Обязательное if state is ``REDIRECT_REQUEST``.
     - | ``Необходимость``: Условно
       | ``Тип``: String
       | ``Длина``: 128
   * - :code:`orderId`
     - Идентификатор заказа в системе обработки платежей.
     - | ``Необходимость``: Условно
       | ``Тип``: String
   * - :code:`transaction`
     - |
     - | ``Необходимость``: Условно
       | ``Тип``: **Object**
   * - :code:`transaction.amountCentis`
     - Сумма денежного перевода в центах: 1,00 EUR = 100 центов.
     - | ``Необходимость``: Условно
       | ``Тип``: Integer
   * - :code:`transaction.commissionCentis`
     - Сумма удержанной комиссии в центах (зависит от интеграции).
     - | ``Необходимость``: Условно
       | ``Тип``: Integer
   * - :code:`transaction.orderCreatedDate`
     - | Дата создания заказа в системе обработки платежей.
     - | ``Необходимость``: Условно
       | ``Тип``: String
   * - :code:`transaction.transactionCreatedDate`
     - Дата создания транзакции в системе обработки платежей.
     - | ``Необходимость``: Условно
       | ``Тип``: String
   * - :code:`errorCode`
     - | Код причины отклонения; может присутствовать, если состояние — ``DECLINED``.
     - | ``Необходимость``: Опционально
       | ``Тип``: Integer
   * - :code:`errorMessage`
     - | Сообщение о причине отклонения; может присутствовать, если состояние — ``DECLINED``.
     - | ``Необходимость``: Опционально
       | ``Тип``: String
       | ``Длина``: 128
   * - :code:`secure3DAuthStatus`
     - Возможные значения: ``AUTHENTICATED``, ``NOT_AUTHENTICATED``, ``UNSUPPORTED``. ``UNSUPPORTED`` означает, что карта не поддерживает 3-D Secure или процесс аутентификации 3DS завершился с неизвестным статусом.
     - | ``Необходимость``: Опционально
       | ``Тип``: Enum
   * - :code:`randomSumAuthStatus`
     - Возможные значения: ``AUTHENTICATED``, ``NOT_AUTHENTICATED``.
     - | ``Необходимость``: Опционально
       | ``Тип``: Enum

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

.. list-table::
   :widths: 30, 45, 25
   :header-rows: 1
   :class: longtable

   * - Название параметра
     - Описание
     - Значение
   * - :code:`error`
     -
     - | ``Тип``: **Object**
   * - :code:`error.cause`
     - Причина ошибки. Возможные значения: ``FILTERED``, ``INVALID_REQUEST``, ``INTERNAL_ERROR``, ``PROCESSING_FAILED``, ``ORDER_NOT_FOUND``.
     - | ``Тип``: Enum
   * - :code:`error.code`
     - Уникальный код ошибки.
     - | ``Тип``: String
   * - :code:`error.message`
     - Описание ошибки.
     - | ``Тип``: String
   * - :code:`invoiceId`
     - Идентификатор транзакции sale.
     - | ``Тип``: String

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

.. code-block:: json

  {
    "session": {
      "accessToken": "string",
      "token": "string"
    }
  }

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

.. code-block:: json

  {
    "bankOrderId": "string",
    "invoiceId": "string",
    "redirectUrl": "string",
    "session": {
      "token": "string"
    },
    "state": "enum"
  }

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

.. code-block:: json

  {
    "error": {
      "cause": "enum",
      "code": "string",
      "message": "string"
    },
    "invoiceId": "string"
  }

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

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