Dispute API documentation
Service SiomAPI
Method GetPacketStatus
The GetPacketStatus method is used to get processing status of the batch with transactions are reported to SIOM
Method address:
/webapi/v1/SiomApi/GetPacketStatus/{id}
Request type: post
| Key | Data type | Description |
|---|---|---|
| id* | integer | ID batch |
| X-Authorization* | string | Access token value, which was received as result of method Login |
| Key | Data type | Description |
|---|---|---|
| success | boolean | Action result |
| errorMessage | string | Error Message |
| result | ApiSiomPacketInfo | Result |
An example of HTTP request
JSON
JSON
POST https://<Имя сервера Диспут+>/webapi/v1/SiomApi/GetPacketStatus/{id} HTTP/1.1
Host: <Имя сервера Диспут+>
Connection: keep-alive
Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>
An example of HTTP response
JSON
JSON
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 513
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: Fri, 28 Feb 2020 11:24:14 GMT
{
"success": true,
"result": {
"packetStatus": "Completed",
"rowsCount": 1,
"processedRowsCount": 1,
"succesfullProcessedRowsCount": 1,
"items": [
{
"rowNumber": 1,
"rejectCode": 16,
"rejectMessage": "Duplicate found in FIS",
"status": "Completed",
"arn": "72233550042011105553936",
"authDate": "2020-02-11T00:00:00",
"fraudStatus": "2",
"fraudType": "04",
"comment": ""
}
]
}
}
Data types
ApiSiomPacketInfo
| Code | Data type | Description |
|---|---|---|
| packetStatus | string of packetStatus | The batch download status |
| rowsCount | integer | Number of rows in the batch |
| processedRowsCount | integer | Number of processed rows in the batch |
| succesfullProcessedRowsCount | integer | Number of successfully processed rows in the batch |
| items | array of ApiSiomPacketItemInfo | Row from the batch |
ApiSiomPacketItemInfo
| Code | Data type | Description |
|---|---|---|
| rowNumber | integer | Sequence number of row |
| rejectCode | integer | Reject code |
| rejectMessage | string | Description of reject code |
| status | string of status | Record status |
| arn | string | ARN |
| pan | string | PAN |
| rrn | string | RRN |
| mti | string | Message type identifier |
| authDate | string | Authorization date & time |
| fraudStatus | string | Fraud status |
| fraudType | string | Fraud type |
| comment | string | Additional information |
Enumerations
packetStatus
| Value | Description |
|---|---|
| Loaded | Loaded |
| Processing | In process |
| Completed | Process completed |
| Closed | |
| ReportSend | |
| ReportFailed |
status
| Value | Description |
|---|---|
| Loaded | Loaded |
| Completed | Process completed |
| Stoped | Process stopped |
| Failed | Process is failed |