API Products of the Mir payment system
РУ EN
Main page
API products
Dispute API
Documentation
Service SiomAPI
Method GetSiomList

Dispute API documentation

Service SiomAPI

Method GetSiomList

The GetSiomList method is used to get list of transaction reported to SIOM

Method address: /webapi/v1/SiomApi/GetSiomList
Request type: post

REQUEST DETAILS
Key Data type Description
paging ApiDataTableQueryPaging Number of page
columns array of ApiDataTableColumnQuery Columns
sorting ApiDataTableSortingSettings Sorting
X-Authorization* string Access token value, which was received as result of method Login
RESPONSE DETAILS 200
Key Data type Description
columns array of ApiDataTableColumn Columns
rows array of ApiSiomDataTableRow Rows
totalRowCount integer Number of rows without paging

 

An example of HTTP request

JSON
JSON
POST https://<Имя сервера Диспут+>/webapi/v1/SiomApi/GetSiomList HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: Keep-Alive
Content-Length: 639
Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip,deflate
X-Authorization:Bearer <значение маркера доступа>
{
  "paging": {
    "page": 0,
    "size": 1
  },
 "columns": [
 {"datasourceId":"Id"},
 {"datasourceId":"InputDate",
  "filter":[
{ "filterType": "GreaterThan",
 "value": "2020-01-25 00:00:00"
} 
  ]
  },
 {
 "datasourceId": "FraudType",
 "filter": [
 {
 "filterType": "Equals",
 "value": "04"
 }
 ]
 },
 {"datasourceId":"Pan"},
 {"datasourceId":"ClearingAmount"},
 {"datasourceId":"ClearingCurrency"},
 {"datasourceId":"Ps"},
 {"datasourceId":"FraudStatus"},
 {"datasourceId":"AuthDate"},
 {"datasourceId":"ResponseCode"},
 {"datasourceId":"LastUpdateDate"}
 ],
  "sorting": {
    "datasourceId": "string",
    "direction": "Undefined"
}

An example of HTTP response

JSON
JSON
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 1072
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: Tue, 28 Jan 2020 15:32:03 GMT

{
   "columns":    [
      {"datasourceId": "Id"},
            {
         "name": "Дата добавления записи в СИоМ",
         "datasourceId": "InputDate"
      },
            {
         "name": "Тип мошенничества",
         "datasourceId": "FraudType"
      },
            {
         "name": "Номер карты",
         "datasourceId": "Pan"
      },
            {
         "name": "Сумма клиринга",
         "datasourceId": "ClearingAmount"
      },
            {
         "name": "Валюта клиринга",
         "datasourceId": "ClearingCurrency"
      },
            {
         "name": "Идентификатор ПС",
         "datasourceId": "Ps"
      },
            {
         "name": "Статус",
         "datasourceId": "FraudStatus"
      },
            {
         "name": "Дата авторизации",
         "datasourceId": "AuthDate"
      },
            {
         "name": "Код ответа эмитента",
         "datasourceId": "ResponseCode"
      },
            {
         "name": "Дата обновления записи",
         "datasourceId": "LastUpdateDate"
      }
   ],
   "rows": [   {
      "id": "300276",
      "data":       [
         300276,
         "2020-01-27T18:16:55",
                  {
            "code": "04",
            "text": "04 - по поддельной карте"
         },
         <"номер карты">,
         2222,
         "RUB",
                  {
            "code": "0001",
            "text": "МИР"
         },
                  {
            "code": "1",
            "text": "1 - подтвержденный фрод"
         },
         "2020-01-27T00:00:00",
         "00",
         "2020-01-27T18:20:33"
      ]
   }],
   "totalRowCount": 3
}

Data types

ApiDataTableQueryPaging

Code Data type Description Comment
page integer Number of page Report is begun from page number 0
size integer Size of page Number of showing row on page

ApiDataTableColumnQuery

Code  Data type Description Comment
filter array of ApiDataTableColumnFilterItem Column filter  
datasourceId string of datasourceId Code

System name of the column used for selection or filtering

ApiDataTableSortingSettings

Code Data type Description Comment
datasourceId string Id of the field we sort by System name of column
direction

string of direction

 Direction in which we sort by (ascending or descending) Sorting direction

ApiDataTableColumn

Code Data type Description Comment
name string Name Column name
datasourceId string Code System name of column

ApiSiomDataTableRow

Code Data type Description
id string SIOM record ID
data array of object Data
 

ApiDataTableColumnFilterItem

Code Data type Description
filterType

string of filterType

 Filter type
value string Filter value

Enumerations

direction

Value Description
Undefined Undefined
Ascending Ascending
Descending Descending
 

filterType

Value
Equals
LesserThan
GreaterThan
Contains
NotEquals
NotContains
LesserOrEquals
GreaterOrEquals
 

datasourceId

Name Description Comment
AithDate Authorization date & time System name of the column can be used for filtering
LastUpdateDate Date of the last update of the SIOM record System name of the column can be used for filtering
InputDate SIOM record update date System name of the column can be used for filtering
FraudType Fraud type System name of the column can be used for filtering
FraudStatus Fraud status System name of the column can be used for filtering
Pan PAN System name of the column can be used for filtering
Arn ARN System name of the column can be used for filtering
Rrn RRN System name of the column can be used for filtering
Ps ID PS System name of the column can be used for filtering
AuthAmount Authorization amount  
AuthCurrency Authorization currency  
ClearingAmount Clearing amount  
ClearingCurrency Clearing currency  
NspkStatus NSPK status  
IssStatus Issuer status  
AcqStatus Acquirer status  
ResponseCode Issuer response code  
Mcc MCC  
TerminalId Terminal ID  
MerchantCity Merchant city  
MerchantCountry Merchant country  
MerchantName Merchant name  
Issuer Issuer Issuer name
Acquier Acquier Acquirer name
Direction Processing direction Only data filtering is performed for this field
SecurityCheckState Security Check The field is used only when filtering data with a given value
ActivityType Activity type The field is used only when filtering data with a given value
IssuerMemberId Issuer member ID Only data filtering is performed for this field (Incoming value is Issuer member ID)
AcquierMemberId Acquirer member ID Only data filtering is performed for this field (Incoming value is Acuirer memeber ID)
 

Ps

Value Description
0001 Mir
0006 MasterCard
0007 Visa

ActivityType

Value Description
1 Acquiring
2 Issue
 

SecurityCheckState

Value Description
1 Pending processing
2 Processing completed
 

Direction

Value Description
1 Incoming
2 Outgoing