Dispute API
- Product review
- Documents
  - Authentication Service
    - Login Method ValidateToken Method Logout Method
  - BpEngineApi Service
    - CreateBp Method Download Method Upload Method GetBpItem Method GetBpList Method ProcessAction Method Method GetBpItemActions Method ProccessMerchantStageAction GetComments Method AddComment Method
  - Reporting Service
    - Disputes Method
  - Business logic
    - Dispute case
      - Dispute Case Incoming Case Response Review of the Response Cooling-off Period
    - Fraud case
      - Fraud Case Response to a Case Review of the response Review of the Issuer’s response Cooling-off period
    - Compliance case
      - Compliance Case Response to a Case Review of the response Cooling-off period
    - Good Faith case
      - Good Faith case Responce Good Faith case
  - Service SiomAPI
    - Method GetDetail Method GetPacketStatus Method Send Method GetSiomList
- Technical support
Search

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

Method ProccessMerchantStageAction

To decline or accept to Merchant actions, Acquirer need to call the method ProccessMerchantStageAction.

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

REQUEST DETAILS
Ключ	Тип данных	Описание
bpItemId*	integer	Case ID
actionCode*	ApiActionCode	Action Code
comment	string	Comment test (used for actionCode: a_DeclineMerchantAction)
files	array of ApiFileContent	Attachment ( used for actionCode: a_DeclineMerchantAction)
X-Authorization*	string

RESPONSE DETAILS 200
Ключ	Тип данных	Описание
success	boolean	Action result
errorMessage	string	Error text

An example of HTTP request

JSON

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


{  "bpItemId":"<Идентификатор БП>",
"actionCode":"a_DeclineMerchantAction",
"comment":"test",
  "Files": [
        {"fileName":"image.png", "content":"<содержимое файла в base 64>"}
		   ]
}

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: Mon, 18 May 2020 06:50:39 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

ApiActionCode

Code	Data types
a_AcceptMerchantAction	string
a_DeclineMerchantAction	string