API Products of the Mir payment system

Dispute API documentation

BpEngineApi Service

The BpEngineApi service provides methods for working with case samples: initiation, execution, obtaining execution options.

To execute the BpEngineApi service methods, transfer the access token parameter (X-Authorization).

GetBpList Method

To get a list of case samples, call the GetBpList method.

Method address: /webapi/v1/BpEngineApi/GetBpList
Request type: post

REQUEST DETAILS
Key Data type Description
paging ApiDataTableQueryPaging Paging
columns array of ApiDataTableColumnQuery Columns
sorting ApiDataTableSortingSettings Sorting
X-Authorization string  
RESPONSE DETAILS 200
Key Data type Description
columns array of ApiDataTableColumn Columns
rows array of ApiDataTableRow Rows
totalRowCount integer Number of rows excluding paging

An example of HTTP request

JSON
POST http://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/GetBpList HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: keep-alive
Content-Length: 260
Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>
{
    "columns": [
        {
            "datasourceId": "BpItemCode",
            "filter": [
                {
                    "filterType": "Equals",
                    "value": "ZIP-17-203"
                }
            ]
        }
    ]
}

An example of HTTP response

JSON
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 09 Nov 2017 07:59:34 GMT
Content-Length: 92806
{
  "columns": [
    {
      "name": "Индекс БП",
      "datasourceId": "BpItemCode"
    },
    {
      "name": "Карта",
      "datasourceId": "CardNumber"
    },
…
],
  "rows": [
    {
      "id": "193",
      "data": [
        "ZIP-17-196",
        "222222**0006",
        "Возврат",
        "ЗИП",
        "Отказ от исполнения ЗИП",
        "30.08.2017 16:33",
        "10.07.2017",
        "6,685,902.00 RUB",
        "Name_tpQer",
        "12233447189504530435644",
        "08.11.2017 09:48",
        "oJ.k> ^7f.5'P\"N",
        "<A!o5gC9",
        "09.07.2017",
        "6,685,902.00",
        "3766",
        "223344 - Acq ТЕСТ (АО)",
        "22222222 - Тестовый банк",
        "7",
        "2",
        "9",
        "2",
        "2",
        "07",
        "8",
        "3",
        "1",
        "0",
        "5",
        "Эквайрер",
        "Исходящий БП"
      ]
    }
  ],
  "totalRowCount": 112
}

Data types

ApiDataTableQueryPaging

Code Data types Description
page integer Page number
size integer Page size

ApiDataTableColumnQuery

Code Data types Description
filter array of ApiDataTableColumnFilterItem Column filter
name string Name
datasourceId string Code

ApiDataTableColumnFilterItem

Code Data types Description
filterType string of filterType Filter type
value string Filter value

ApiDataTableSortingSettings

Code Data types Description
datasourceId string Id of the field we sort by.
direction string of direction Direction in which we sort by (ascending or descending).

ApiDataTableColumn

Code Data types Description
name string Name
datasourceId string Code

ApiDataTableRow

Code Data types Description
bpItemId string Identifier
data array of object Data

Enumerations

filterType

Value
Equals
LesserThan
GreaterThan
Contains
NotEquals
NotContains
LesserOrEquals
GreaterOrEquals

direction

Value
Undefined
Ascending
Descending