.. _services_v2_rpt-engine:

/services/v2/rpt-engine
##############################################

.. contents::
  :local:

.. role:: ex

.. role:: code

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

| Custom transactions report provide an opportunity to get customized information about transactions with their statuses for verification and further analysis.
|
| Custom transactions report is initiated through :code:`HTTPS POST` request by using :ref:`URLs<services_transaction-report_url>` and the :ref:`parameters<services_v2_rpt-engine_parameters>` specified below. Use :ref:`HMAC-SHA1<HMAC-SHA1>` for authentication. Report parameters are being sent via JSON.

.. _services_v2_rpt-engine_url:

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-ui/services/v2/rpt-engine`
    - :ex:`https://gate.payneteasy.com/paynet-ui/services/v2/rpt-engine`


.. _services_v2_rpt-engine_parameters:

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

| Each custom report has a different JSON body parameters. JSON templates and supported formats for required custom reports could be provided by support managers upon request.

Request body example:

.. highlight:: text

::

    {
        "reportIdentifier": "exampleReport",
        "reportEncode": "UTF-8",
        "reportName": "example",
        "reportCsvDelimiter": ",",
        "reportFormat": "CSV",
        "configurationReportParameters": [],
        "inputReportParameters": [
            {
                "type": "INPUT_TEXT",
                "name": "example",
                "value": "example"
            }
        ],
        "outputReportParameters": [],
        "filters": {
            "gates": [],
            "companies": [],
            "projects": [],
            "endpoints": [],
            "merchants": [],
            "processors": [],
            "managers": [],
            "resellers": [],
            "currencies": []
        }
    }


Response Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

| Each custom report has a different response body parameters. Usually it's provided in CSV or PDF format.
|

.. note::
   The returned report has wellformed CSV format. In accordance with |rfc_link|, fields containing line breaks (CRLF, CR, LF), double quotes, and commas are enclosed in double-quotes.

.. |rfc_link| raw:: html

   <a href="https://datatracker.ietf.org/doc/html/rfc4180" rel="nofollow noopener noreferrer">RFC 4180</a>

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

.. highlight:: text

::

    POST /paynet-ui/services/v2/rpt-engine HTTP/1.1
    Host: gate.doc2.com
    User-Agent: curl/7.88.1
    Accept: */*
    Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="login",oauth_timestamp="1690553049",oauth_nonce="2lrRWDbfOoq",oauth_signature_method="HMAC-SHA1",oauth_signature="ZAi2xFUlh35DAzDYKnSbyUUGGIA%3D"
    Content-Type: application/json
    Content-Length: 417
    Connection: close

    {"reportIdentifier":"exampleReport","reportEncode":"UTF-8","reportName":"example","reportCsvDelimiter":",","reportFormat":"CSV","configurationReportParameters":[],"inputReportParameters":[{"type":"INPUT_TEXT","name":"example","value":"example"}],"outputReportParameters":[],"filters":{"gates":[],"companies":[],"projects":[],"endpoints":[],"merchants":[],"processors":[],"managers":[],"resellers":[],"currencies":[]}}

Success Response Example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. highlight:: text

::

    "Merchant_Name","Transaction_id","Merchant_OID","Created_date","Amount","Currency","Transaction_type","Order_description","Date_of_report"
    "TestMerchant3","6891747","902B4FF5","2023-07-27 16:37:21","90.000","USD","Sale","Order #293927","28.07.2023"

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

.. highlight:: text

::

    HTTP/1.1 200
    Server: server
    Date: Mon, 31 Jul 2023 09:49:07 GMT
    Content-Type: text/plain
    Content-Length: 46
    Connection: close
    Strict-Transport-Security: max-age=31536000

    You are not authorised to perform such request

Postman Collection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. raw:: html
    :file: ../_static/Postman/Postman_rpt-engine.html

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

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