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


{
    "bpItemId": 10891,
    "comment": "комментарий из API без файла",
    "commentType":"Private"
}


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-Powered-By: ASP.NET
Date: Tue, 23 Jun 2020 14:56:00 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

Enumerations

commentType

Value
Public
Private