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 GetBpItemActions
To get actions available for a case sample, call the GetBpItemActions method.
Method address:
/webapi/v1/BpEngineApi/GetBpItemActions/{id}
Request type: post
| Ключ | Тип данных | Описание |
|---|---|---|
| id* | integer | Case id |
| getMerchantStageActions | boolean | Get available actions in response to the step Merchant |
| X-Authorization* | string |
| Ключ | Тип данных | Описание |
|---|---|---|
| actions | array of BpItemAction | Case actions |
| success | boolean | Successful creation case attribute |
An example of HTTP request
JSON
JSON
POST https://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/GetBpItemActions/<bpItemId>?getMerchantStageActions=true HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: Keep-Alive
Accept: application/json
Content-Type: application/json;charset=UTF-8
Content-Length: 0
Accept-Encoding: gzip,deflate
X-Authorization: Bearer <значение маркера доступа>
An example of HTTP response
JSON
JSON
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 577
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: Sat, 16 May 2020 17:47:49 GMT
{
"actions": [
{
"code": "a_DeclineDispute",
"name": "Отклонить",
"actionType": "StageAction"
},
{
"code": "a_MakeAdjustment",
"name": "Вернуть деньги",
"actionType": "StageAction"
},
{
"code": "a_AcceptMerchantAction",
"name": "Подтвердить",
"actionType": "MerchantStageAction"
},
{
"code": "a_DeclineMerchantAction",
"name": "Вернуть ТСП",
"actionType": "MerchantStageAction"
}
],
"success": true
}
Data types
BpItemAction
| Code | Data types | Description |
|---|---|---|
| code | string | System name of action |
| name | string | Name of action |
| actionType | string of actionType |
Enumerations
actionType
| Value |
|---|
| StageAction |
| MerchantStageAction |