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

AddComment Method

To add a comment into the case sample chat, call the AddComment method.

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

REQUEST DETAILS
Key Data type Description
bpItemId integer Case ID
comment string Comment text
files array of ApiFileContent Attachments
X-Authorization string  
RESPONSE DETAILS 200
Key Data type Description
success boolean Action result
errorMessage string Error text

An example of HTTP request

JSON
POST http://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/AddComment HTTP/1.1
Host: <Имя сервера Диспут+>
Content-Length: 260
Accept: application/json
Content-Type: application/json;charset=UTF-8
Accept-Encoding: gzip, deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>
{
    bpItemId: 1608,
    comment: "test"
}

An example of HTTP response

JSON
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-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: default-src 'self';script-src 'self' 'unsafe-eval' 'unsafe-inline';img-src 'self' data:;style-src 'self' 'unsafe-inline'
Strict-Transport-Security: max-age=31536000;includeSubdomains
Date: Tue, 24 Apr 2018 07:23:14 GMT
{
    "success":true
}


Data types

ApiFileContent

Code Data types Description
content string Content in base64
fileName string File name
guid string GUID of a file previously uploaded to the system