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 https://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/GetBpList HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: Keep-Alive
Accept: application/json
Content-Type: application/json;charset=UTF-8
Content-Length: 920
Accept-Encoding: gzip,deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>

{
  "paging": {
    "page": 0,
    "size": 10
  },
    "columns": [
       
           {"datasourceId": "BpAvailableActions"},
            {"datasourceId": "BpItemCode",
    "filter": [
                {
                    "filterType": "Equals",
                    "value": "DP-20-453"
                }
            ]},
                      {"datasourceId": "TransactionDate",
    "filter": [
                {
                    "filterType": "GreaterOrEquals",
                    "value": "2020-04-15"
                }
            ]},
       {  "datasourceId": "CardNumber" },
      {"datasourceId": "OperationType"},
      {"datasourceId": "CardAcceptorName"},
      {"datasourceId": "CardAcceptorTerminalId"},
       {  "datasourceId": "CardAcceptorIdCode" },
       {"datasourceId": "DisputeAmount"},
       {"datasourceId": "DisputeAmountCurrency"},
       {"datasourceId": "ActivityType"}
         
    ]
}

An example of HTTP response

JSON
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 990
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: Wed, 22 Apr 2020 18:08:13 GMT

{
   "columns":    [
            {
         "name": "Есть доступные действия",
         "datasourceId": "BpAvailableActions"
      },
            {
         "name": "Индекс БП",
         "datasourceId": "BpItemCode"
      },
            {
         "name": "Дата операции",
         "datasourceId": "TransactionDate"
      },
            {
         "name": "Карта",
         "datasourceId": "CardNumber"
      },
            {
         "name": "Тип операции",
         "datasourceId": "OperationType"
      },
            {
         "name": "Точка",
         "datasourceId": "CardAcceptorName"
      },
            {
         "name": "Номер терминала",
         "datasourceId": "CardAcceptorTerminalId"
      },
            {
         "name": "Код точки обслуживания",
         "datasourceId": "CardAcceptorIdCode"
      },
            {
         "name": "Сумма диспута",
         "datasourceId": "DisputeAmount"
      },
            {
         "name": "Валюта диспута",
         "datasourceId": "DisputeAmountCurrency"
      },
            {
         "name": "Вид деятельности",
         "datasourceId": "ActivityType"
      }
   ],
   "rows": [   {
      "bpItemId": "10399",
      "data":       [
         "Нет",
         "DP-20-453",
         "2020-04-22T00:00:00",
         "<номер карты>",
         "Оплата",
         "TMS-2",
         "P1200267",
         "11200267",
         "333.00",
         "RUB",
         "Эквайринг"
      ]
   }],
   "totalRowCount": 1
}

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 of datasourceId 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

datasourceId

Value Decription
BpItemCode  
CardNumber  
OperationType  
BpName BP Type
StageName  
StageDateCreate  
DateCreated  
TransmissionDate  
AmountAndCurrency  
AmountCurrency  
CardAcceptorName  
AcquirerReferenceData ARN
AutoActionDate  
CardAcceptorIdCode  
CardAcceptorTerminalId  
TransactionDate  
TranAmount Transaction amount
TranAmountCurrency Transaction amount currency
CardAcceptorBusinessCode МСС
AcquirerBin  
IssuerBin  
ActivityType  
BpDirection  
PaymentSystem  
DisputeAmount  
DisputeAmountCurrency  
RequestReason  
AuthorizationCode  
BpAvailableActions  
LastChangeDate  
AwaitingAcqAcceptance  
MerchAcqChangeDatetime  
pf_949 Custom field
 

BpName

Value Description
DP Disput
FR Fraud
COM Complaint
GF Good Faith
RFC  
VI Disput_VISA
MC MC_Chargeback
 

PaymentSystem

Value Description
2 MasterCard
3 Visa
4
MIR
 

OperationType

Value
Purchase
Purchase ECOM
Quick purchase
Funding
Card-to-Card
Cash-to-Card
Refund
Withdrawal
Cash Disbursement
 

StageName

Value
s_Start
s_AdjustmentPartial
s_AdjustmentFull
s_AnswerReview
s_AnswerAccepted
s_InfoProvided
s_CoolingPeriod
s_Arbitration
s_ArbDecision
s_Arbitrated
s_Reversal
s_Reject
s_FraudConfirmed
s_ClearingReceived
s_DocsProvided
s_BPFineshed
s_RequestDiclined
s_RequestGranted
 

Currency

Value Description
1 RUB
2 EUR
3 USD
4 AMD
5 UZS
6 TJS
7 AZN
8 KGS
9 BYN
10 KZT
11 TRY
12 VND
13 BGN
20 HKD
21 MYR
22 SGD
23 UAH
 

RequestReason

Value Description
Товар не получен Goods or services not received
Неуспешная операция Unsuccessful transaction
Оплачено иным способом Paid by other means

Заказ или подписка отменена

Canceled subscription

Товар ненадлежащего качества

Defective merchandise

Нарушение технологии совершения операции 

Technical error
Банкомат не выдал наличные Non-receipt of cash at ATM
Получатель не получил перевод Non-receipt of P2P transfer
Возврат не зачислен Refund not credited
Запрос информации об отправителе Request for sender information
Возврат не обработан  Refund not handled
Отказ от кредитовой операции Refusal from credit
Динамическая конвертация валюты DCC
 

BpDirection

Value
in
out
 

ActivityType

Value Description
1 Acquiring
2 Issuing
 

filterType

Value
Equals
LesserThan
GreaterThan
Contains
NotEquals
NotContains
LesserOrEquals
GreaterOrEquals
 

direction

Value
Undefined
Ascending
Descending