3.49. /services/v2/rpt-engine

Введение

Пользовательский отчёт по транзакциям предоставляет возможность получить настраиваемую информацию о транзакциях с их статусами для проверки и дальнейшего анализа.

Пользовательский отчёт по транзакциям инициируется посредством запроса HTTPS POST с использованием указанных ниже URL и параметров. Для аутентификации используйте HMAC-SHA1. Параметры отчёта передаются через JSON.

API URL

Примечание

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

Интеграционная среда	Производственная среда
https://sandbox.sbctech.ru/paynet-ui/services/v2/rpt-engine	https://gate.sbctech.ru/paynet-ui/services/v2/rpt-engine

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

Каждый пользовательский отчёт имеет разные параметры тела JSON. Шаблоны JSON и поддерживаемые форматы требуемых пользовательских отчётов могут быть предоставлены менеджерами поддержки по запросу.

Описание: Request body example:

{
    "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": []
    }
}

Параметры ответа

Каждый пользовательский отчёт имеет разные параметры тела ответа. Обычно он предоставляется в формате CSV или PDF.

Примечание

Сформированный отчет имеет правильно сформированный формат (well-formed) CSV. В соответствии с поля RFC 4180, содержащие переносы строк (CRLF, CR, LF), двойные кавычки и запятые заключаются в двойные кавычки.

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

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":[]}}

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

"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"

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

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

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

HTTP method
URL
FileName	File name and format should be the same in JSON (UserData)
User data	Input JSON content
version
consumer key
consumer secret
timestamp
timestamp
signature method

signature base string

signature

authorization header

• CURL

Copy to clipboard