.. _api_sale_status:

Sale status
###########

.. toctree::
    :maxdepth: 1

.. contents::
    :local:

.. role:: ex

.. role:: code

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

| Sale status is initiated through :code:`HTTPS POST` request by using :ref:`URLs<api_url_sale_status>` and the :ref:`parameters<api_parameters_sale_status>`.
| Sale status request is made by Connecting Party’s app to Payneteasy to get the status of sale transaction.
| It is recommended to send Sale status request for a period of 2-3 minutes with interval of 3-5 seconds between requests. Connecting Party's server should rely on the callback for final status.

.. _api_url_sale_status:

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/sale/{endpointId}/{invoiceId}/status`
     - :ex:`https://gate.payneteasy.com/paynet/dapi/v1/sale/{endpointId}/{invoiceId}/status`

.. _api_parameters_sale_status:

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 access token key received in Optional consumer authentication.
     - | ``Type``: String
       | ``Length``: 32-128
   * - :code:`session.token`
     - The session token of sale transaction.
     - | ``Type``: String
       | ``Length``: 16-36

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

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

   * - Parameter Name
     - Description
     - Value
   * - :code:`invoiceId`
     - Sale transaction identifier.
     - | ``Type``: String
   * - :code:`session`
     -
     - | ``Type``: **Object**
   * - :code:`session.token`
     - The session token of sale transaction
     - | ``Type``: String
   * - :code:`state`
     - Possible values: ``PROCESSING``, ``REDIRECT_REQUEST``, ``APPROVED``, ``DECLINED``.
     - | ``Type``: Enum
   * - :code:`bankOrderId`
     - Required if state is ``APPROVED`` or ``DECLINED``.
     - | ``Necessity``: Conditional
       | ``Type``: String
       | ``Length``: 128
   * - :code:`redirectUrl`
     - Required if state is ``REDIRECT_REQUEST``.
     - | ``Necessity``: Conditional
       | ``Type``: String
       | ``Length``: 128
   * - :code:`orderId`
     - Order identifier in payment processing system.
     - | ``Necessity``: Conditional
       | ``Type``: String
   * - :code:`transaction`
     - |
     - | ``Necessity``: Conditional
       | ``Type``: **Object**
   * - :code:`transaction.amountCentis`
     - Amount of money transfered in centis, 1.00 EUR = 100 centis.
     - | ``Necessity``: Conditional
       | ``Type``: Integer
   * - :code:`transaction.commissionCentis`
     - Amount of commission held in centis (depends on the integration).
     - | ``Necessity``: Conditional
       | ``Type``: Integer
   * - :code:`transaction.orderCreatedDate`
     - | Order creation date in payment processing system.
     - | ``Necessity``: Conditional
       | ``Type``: String
   * - :code:`transaction.transactionCreatedDate`
     - Transaction creation date in payment processing system.
     - | ``Necessity``: Conditional
       | ``Type``: String
   * - :code:`errorCode`
     - | Decline reason code, may present if state is ``DECLINED``.
     - | ``Necessity``: Optional
       | ``Type``: Integer
   * - :code:`errorMessage`
     - | Decline reason message, may present if state is ``DECLINED``.
     - | ``Necessity``: Optional
       | ``Type``: String
       | ``Length``: 128
   * - :code:`secure3DAuthStatus`
     - Possible values: ``AUTHENTICATED``, ``NOT_AUTHENTICATED``, ``UNSUPPORTED``, ``UNSUPPORTED`` means that card does not support 3-D Secure or 3DS authentication process finished with an unknown status.
     - | ``Necessity``: Optional
       | ``Type``: Enum
   * - :code:`randomSumAuthStatus`
     - Possible values: ``AUTHENTICATED``, ``NOT_AUTHENTICATED``.
     - | ``Necessity``: Optional
       | ``Type``: Enum

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: ``FILTERED``, ``INVALID_REQUEST``, ``INTERNAL_ERROR``, ``PROCESSING_FAILED``, ``ORDER_NOT_FOUND``.
     - | ``Type``: Enum
   * - :code:`error.code`
     - The unique error code.
     - | ``Type``: String
   * - :code:`error.message`
     - Description of the error.
     - | ``Type``: String
   * - :code:`invoiceId`
     - Sale transaction identifier.
     - | ``Type``: String

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

.. code-block:: json

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

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

.. code-block:: json

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

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

.. code-block:: json

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

Request Builder
^^^^^^^^^^^^^^^

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