.. meta::
   :description: API Complete Transfer в сценарии Mobile Device Payneteasy: финализация peer-to-peer перевода, инициированного из мобильного приложения после подтверждения получателем.

.. _api_complete_transfer:

Complete Transfer
#################



.. role:: ex

.. role:: code

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

| Complete transfer инициируется через запрос :code:`HTTPS POST` с использованием :ref:`URL-адресов<api_url_complete_transfer>` и :ref:`параметров<api_parameters_complete_transfer>`.

.. _api_url_complete_transfer:

API URL
^^^^^^^^

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

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

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

.. _api_parameters_complete_transfer:

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

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

   * - Название параметра
     - Описание
     - Значение
   * - :code:`session`
     -
     - | ``Тип``: **Object**
   * - :code:`session.accessToken`
     - Access token сессии транзакции transfer.
     - | ``Тип``: String
   * - :code:`session.token`
     - Token сессии транзакции transfer.
     - | ``Тип``: String


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

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

   * - Название параметра
     - Описание
     - Значение
   * - :code:`invoiceId`
     - Идентификатор транзакции transfer.
     - | ``Тип``: String
   * - :code:`session`
     -
     - | ``Тип``: **Object**
   * - :code:`session.token`
     - Token сессии транзакции transfer.
     - | ``Тип``: String

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

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

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

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

.. code-block:: json

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

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

.. code-block:: json

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

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

.. code-block:: json

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