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).
CreateBp Method
To create a case sample, call the CreateBp method.
Method address:
/webapi/v1/BpEngineApi/CreateBp
Request type: post
| Ключ | Тип данных | Описание |
|---|---|---|
| operationDataList | array of ApiCreateBpRequestOperationData | Transaction research data |
| fields | array of ApiBpField | Query data fields |
| bpCode | string | Case code |
| X-Authorization | string |
| Ключ | Тип данных | Описание |
|---|---|---|
| resultItems | array of ApiCreateBpResponseResultItem | Case creation result |
| success | boolean | Successful case creation attribute |
An example of HTTP request
JSON
JSON
POST http://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/CreateBp HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: keep-alive
Content-Length: 250
Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>
{
"operationDataList": [
{
"CardNumber": "222222226389577",
"AcquirerReferenceData": "02233447300504530821384"
}
],
"fields": [
{
"code": "ZIP_f_RequestReason",
"value": "NotRecognize"
}
]
}
An example of HTTP response
JSON
JSON
POST http://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/CreateBp HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: keep-alive
Content-Length: 250
Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>
{
"operationDataList": [
{
"CardNumber": "222222226389577",
"AcquirerReferenceData": "02233447300504530821384"
}
],
"fields": [
{
"code": "ZIP_f_RequestReason",
"value": "NotRecognize"
}
]
}
Data types
ApiCreateBpRequestOperationData
| Code | Data types | Description |
|---|---|---|
| acquirerReferenceData | string | ARN |
ApiBpField
| Code | Data types | Description |
|---|---|---|
| code | string | Code |
| value | string | Value |
ApiCreateBpResponseResultItem
| Code | Data types | Description |
|---|---|---|
| bpItemId | integer | Case ID |
| success | boolean | Successful case creation attribute |
| errorMessage | string | Error text |