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

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

An example of HTTP request

JSON
POST http://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/ProcessAction HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: <Имя сервера Диспут+>
Content-Length: 324
X-Authorization: Bearer <значение маркера доступа>
{ 
   "fields":[ 
      { 
         "code":"ZIP_f_ResponseType",
         "value":"ProvideInfo"
      },
      { 
         "code":"ZIP_f_prch_MerchantName",
         "value":"111111111"
      },
      { 
         "code":"ZIP_f_prch_MerchantAddress",
         "value":"222222222"
      },
      { 
         "code":"ZIP_f_prch_PurchaseDescription",
         "value":"333333333333333333"
      }
   ],
   "actionCode":"ZIP_a_Fulfill",
   "bpItemId":"1638"
}

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

ApiBpField

Code Data types Description
code string Code
value string Value