.. _api_complete_transfer:

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

.. toctree::
    :maxdepth: 1

.. contents::
    :local:

.. role:: ex

.. role:: code

Introduction
^^^^^^^^^^^^

| Complete transfer is initiated through :code:`HTTPS POST` request by using :ref:`URLs<api_url_complete_transfer>` and the :ref:`parameters<api_parameters_complete_transfer>`.

.. _api_url_complete_transfer:

API URLs
^^^^^^^^

.. note::
    | The path in API URL should not be hardcoded, as it may be changed in future.

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

   * - Integration
     - Production
   * - :ex:`https://sandbox.payneteasy.com/paynet/dapi/v1/transfer/{endpointId}/{invoiceId}/{assignedId}`
     - :ex:`https://gate.payneteasy.com/paynet/dapi/v1/transfer/{endpointId}/{invoiceId}/{assignedId}`

.. _api_parameters_complete_transfer:

Request Parameters
^^^^^^^^^^^^^^^^^^

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

   * - Parameter Name
     - Description
     - Value
   * - :code:`session`
     -
     - | ``Type``: **Object**
   * - :code:`session.accessToken`
     - The session access token of transfer transaction.
     - | ``Type``: String
   * - :code:`session.token`
     - The session token of transfer transaction.
     - | ``Type``: String


Success Response Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

   * - Parameter Name
     - Description
     - Value
   * - :code:`invoiceId`
     - Transfer transaction identifier.
     - | ``Type``: String
   * - :code:`session`
     -
     - | ``Type``: **Object**
   * - :code:`session.token`
     - The session token of transfer transaction.
     - | ``Type``: String

Fail Response Parameters
^^^^^^^^^^^^^^^^^^^^^^^^

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

   * - Parameter Name
     - Description
     - Value
   * - :code:`error`
     - |
     - | ``Type``: **Object**
   * - :code:`error.cause`
     - Cause of the error. Possible values: ``INVALID_REQUEST``, ``INVALID_CONFIGURATION``, ``INTERNAL_ERROR``, ``PROCESSING_FAILED``.
     - | ``Type``: Enum
   * - :code:`error.code`
     - The unique error code.
     - | ``Type``: String
   * - :code:`error.message`
     - Description of the error.
     - | ``Type``: String
   * - :code:`invoiceId`
     - Transfer transaction identifier.
     - | ``Type``: String

Request Example
^^^^^^^^^^^^^^^

.. code-block:: json

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

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

.. code-block:: json

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

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

.. code-block:: json

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