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).

CreateBp Method

To create a case sample, call the CreateBp method.

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

Ключ Тип данных Описание
operationDataList array of ApiCreateBpRequestOperationData Transaction research data
fields array of ApiBpField Query data fields
bpCode string Case code
X-Authorization string  
Ключ Тип данных Описание
resultItems array of ApiCreateBpResponseResultItem Case creation result
success boolean Successful case creation attribute

An example of HTTP request

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: 385
Accept-Encoding: gzip,deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>

  "bpCode": "FR",
  "operationDataList": [
      "AcquirerReferenceData": "<ARN>"
  "Fields": [
      "code": "f_DisputeAmount",
      "value": "{\"amount\":\"1000.00\",\"currencyCode\":\"643\"}"
    } ,
      "code": "f_FraudType",
      "value": "01"
      "code": "f_Comment",
      "value": "test"

An example of HTTP response

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 82
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, 01 Sep 2020 10:46:54 GMT

   "resultItems":    [
         "bpItemId": 41873,
         "success": true
   "success": true

Data types


Code Data types Description
AcquirerReferenceData string ARN


Code Data types Description
code string Code
value string Value


Code Data types Description
bpItemId integer Case ID
success boolean Successful case creation attribute
errorMessage string Error text