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

GetBpItemActions Method

To get actions available for a case sample, call the GetBpItemActions method.

Method address: /webapi/v1/BpEngineApi/GetBpItemActions/{id}
Request type: post

REQUEST DETAILS
Key Data type Description
id* integer  
X-Authorization string  
RESPONSE DETAILS 200
Key Data type Description
actions array of BpItemAction Case actions
success boolean Successful creation case attribute

An example of HTTP request

JSON
POST http://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/GetBpItemActions/<bpItemId> HTTP/1.1
Accept-Encoding: gzip,deflate
X-Authorization: Bearer <значение маркера доступа>
Content-Type: application/json
Content-Length: 0
Host: <Имя сервера Диспут+>
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

An example of HTTP response

JSON
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 226
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, 25 Apr 2018 11:13:53 GMT
{
  "actions": [
    {
      "code": "ZIP_a_Fulfill",
      "name": "Исполнить ЗИП"
    },
    {
      "code": "ZIP_a_AdjFull",
      "name": "Вернуть деньги"
    }
  ],
  "success": true
}

Data types

BpItemAction

Code Data types Description
code string  
name string