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

ProcessAction Method

To respond to a case sample, call the ProcessAction method.

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

Key Data type Description
bpItemId* integer Case ID
actionCode* string Action code
fields* array of ApiBpField Query data fields
X-Authorization* string  
Key Data type Description
errorMessage string Error text
success boolean Successful case action attribute

An example of HTTP request

POST https://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/ProcessAction HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: Keep-Alive
Accept: application/json
Content-Type: application/json;charset=UTF-8
Content-Length: 283
Accept-Encoding: gzip,deflate
X-Authorization: Bearer <значение маркера доступа>

     "value":"тестовый ответ "

An example of HTTP response

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 16
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, 29 Apr 2020 08:30:35 GMT


Data types


Code Data types Description
code string Code
value string Value