API Products of the Mir payment system
РУ EN
Main page
API products
Dispute API
Documentation
Service SiomAPI
Method GetDetail

Dispute API documentation

Service SiomAPI

Method GetDetail

The GetDetial method is used to get detail information about transaction reported to SIOM

 

Method address: /webapi/v1/SiomApi/GetDetail/{id}
Request type: post

REQUEST DETAILS
Code Data type Description
id* integer SIOM record ID
X-Authorization* string Access token value, which was received as result of method Login
RESPONCE DETAILS 200
Key Data type Description
success boolean Action result
errorMessage string Error message
result ApiSiomTransactionInfo Result

An example of HTTP request

JSON
JSON
POST https://<Имя сервера Диспут+>/webapi/v1/SiomApi/GetDetail/{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: 9517 
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": {
    "id": 300217,
    "inputSource": {
      "code": "2",
      "text": "2 - Эквайрер"
    },
    "fraudStatus": {
      "code": "1",
      "text": "1 - подтвержденный фрод"
    },
    "fraudType": {
      "code": "08",
      "text": "08 - с использованием нештатных специализированных программно-технических средств или вредоносного программного обеспечения"
    },
    "ps": "МИР",
    "mti": "1240",
    "inputDate": "2020-01-14T16:13:46",
    "processingCode": "000000",
    "authorizationDate": "2020-01-07T00:00:00",
    "transmissionDate": "2020-01-07T00:00:00",
    "cardNumber": "<номер карты>",
    "cardSequenceNumber": "009",
    "cardExpirationDate": "2004",
    "authorizationCode": "<код авторизации>",
    "transactionLifeCycleID": "<TRN>",
    "retrievalReferenceNumber": "<RRN>",
    "acquirerReferenceData": "<ARN>",
    "authorisationResponseSource": {
      "code": "N",
      "text": "N (не авторизована)"
    },
    "issuerResponseCode": "00",
    "transactionOriginatorInstitutionIDCode": "20000",
    "issuerInstitutionIDCode": "70000010000",
    "acquiringInstitutionIDCode": "901301",
    "forwardingInstitutionIDCode": "70290130101",
    "authAmount": "1,000.00 RUB",
    "jsonAuthAmount": "{\"amount\":1000.00,\"currency\":{\"id\":1,\"numericCode\":\"643\",\"code\":\"RUB\",\"displayValue\":\"Российский рубль\",\"currencyExponent\":2}}",
    "amount": "1,000.00 RUB",
    "jsonAmount": "{\"amount\":1000.0,\"currency\":{\"id\":1,\"numericCode\":\"643\",\"code\":\"RUB\",\"displayValue\":\"Российский рубль\",\"currencyExponent\":2}}",
    "tranAmount": "1,000.00 RUB",
    "jsonTranAmount": "{\"amount\":1000.0,\"currency\":{\"id\":1,\"numericCode\":\"643\",\"code\":\"RUB\",\"displayValue\":\"Российский рубль\",\"currencyExponent\":2}}",
    "cardAcceptorBusinessCode": "4722",
    "cardAcceptorTerminalId": "P1200267",
    "cardAcceptorIdCode": "11200267",
    "cardAcceptorName": "TMS-2",
    "cardAcceptorCountryCode": "RUS",
    "cardAcceptorRegionCode": "70 ",
    "cardAcceptorZIP": "636780    ",
    "cardAcceptorCity": "STREZHEVOY",
    "cardAcceptorAddress": "mkr. 4, 419",
    "cardInputMode": {
      "code": "05",
      "text": "05 (Online Chip (данные PAN считаны с чипа карты через контактный интерфейс и переданы в авторизационном запросе эмитенту))"
    },
    "pointOfServiceDataCode": "501100030636780    ",
    "pointOfServiceDataCode_TerminalType": {
      "code": "3",
      "text": "3 (POS (POS-терминал))"
    },
    "pointOfServiceDataCode_CardholderActivatedTerminalLevel": {
      "code": "0",
      "text": "0 (Not a CAT (не является терминалом самообслуживания))"
    },
    "pointOfServiceDataCode_TerminalDataCardDataInputCapability": {
      "code": "5",
      "text": "5 (Magnetic stripe reader and ICC capability (гибридное устройство с поддержкой карт с магнитной полосой и контактных  чиповых карт))"
    },
    "pointOfServiceDataCode_CardDataInputMode": {
      "code": "05",
      "text": "05 (Online Chip (данные PAN считаны с чипа карты через контактный интерфейс и переданы в авторизационном запросе эмитенту))"
    },
    "pointOfServiceDataCode_TerminalOperatingEnvironment": {
      "code": "1",
      "text": "1 (On card acceptor premises (терминал в точке обслуживания))"
    },
    "pointOfServiceDataCode_CardAndCardholderPresentData": {
      "code": "0",
      "text": "0 (Card&Cardholder present (карта и держатель карты присутствуют))"
    },
    "pointOfServiceDataCode_CardholderAuthenticationMethod": {
      "code": "8",
      "text": "8 (Off-line PIN (введен off-line PIN))"
    },
    "pointOfServiceDataCode_ElectronicCommerceIndicator": {
      "code": "0",
      "text": "0 (Not a e-commerce transaction (операция не относится к электронной коммерции))"
    },
    "authCVPFlag": {
      "code": "1",
      "text": "1 (присутствовала (проверка ОК))"
    },
    "authCVP2Flag": {},
    "authPINFlag": "8",
    "transactionIncs": [
      {
        "id": 5104,
        "inputDate": "14.01.2020 16:13:46",
        "inputSource": {
          "code": "2",
          "text": "2 - Эквайрер"
        },
        "fraudStatus": {
          "code": "1",
          "text": "1 - подтвержденный фрод"
        },
        "fraudType": {
          "code": "08",
          "text": "08 - с использованием нештатных специализированных программно-технических средств или вредоносного программного обеспечения"
        },
        "comment": "тестирование СИоМ API 2",
        "inputChannel": {
          "code": "10",
          "text": "API"
        },
        "userName": "USER aa"
      },
      {
        "id": 5105,
        "inputDate": "14.01.2020 17:07:11",
        "inputSource": {
          "code": "1",
          "text": "1 - Эмитент"
        },
        "fraudStatus": {
          "code": "1",
          "text": "1 - подтвержденный фрод"
        },
        "fraudType": {
          "code": "08",
          "text": "08 - с использованием нештатных специализированных программно-технических средств или вредоносного программного обеспечения"
        },
        "comment": "тестирование СИоМ API",
        "inputChannel": {
          "code": "10",
          "text": "API"
        },
        "userName": "bb"
      },
      {
        "id": 5106,
        "inputDate": "15.01.2020 11:41:24",
        "inputSource": {
          "code": "1",
          "text": "1 - Эмитент"
        },
        "fraudStatus": {
          "code": "1",
          "text": "1 - подтвержденный фрод"
        },
        "fraudType": {
          "code": "08",
          "text": "08 - с использованием нештатных специализированных программно-технических средств или вредоносного программного обеспечения"
        },
        "comment": "тестирование 2 СИоМ API",
        "inputChannel": {
          "code": "10",
          "text": "API"
        },
        "userName": "bb"
      },
      {
        "id": 5107,
        "inputDate": "15.01.2020 12:00:41",
        "inputSource": {
          "code": "1",
          "text": "1 - Эмитент"
        },
        "fraudStatus": {
          "code": "1",
          "text": "1 - подтвержденный фрод"
        },
        "fraudType": {
          "code": "08",
          "text": "08 - с использованием нештатных специализированных программно-технических средств или вредоносного программного обеспечения"
        },
        "comment": "тест через UI",
        "inputChannel": {
          "code": "1",
          "text": "TRX"
        },
        "userName": "bb"
      },
      {
        "id": 5110,
        "inputDate": "15.01.2020 14:45:26",
        "inputSource": {
          "code": "1",
          "text": "1 - Эмитент"
        },
        "fraudStatus": {
          "code": "1",
          "text": "1 - подтвержденный фрод"
        },
        "fraudType": {
          "code": "08",
          "text": "08 - с использованием нештатных специализированных программно-технических средств или вредоносного программного обеспечения"
        },
        "comment": "тестирование 5 СИоМ API",
        "inputChannel": {
          "code": "10",
          "text": "API"
        },
        "userName": "bb"
      },
      {
        "id": 5121,
        "inputDate": "15.01.2020 15:32:47",
        "inputSource": {
          "code": "1",
          "text": "1 - Эмитент"
        },
        "fraudStatus": {
          "code": "1",
          "text": "1 - подтвержденный фрод"
        },
        "fraudType": {
          "code": "08",
          "text": "08 - с использованием нештатных специализированных программно-технических средств или вредоносного программного обеспечения"
        },
        "comment": "тестирование 7 СИоМ API",
        "inputChannel": {
          "code": "10",
          "text": "API"
        },
        "userName": "bb"
      }
    ]
  }
}

Data types

ApiSiomTransactionInfo

Code Data type Description
id integer Unique record ID
inputSource ApiRefValue Source
fraudStatus ApiRefValue Fraud status
fraudType ApiRefValue Fraud type
ps string of ps Payment system
mti string Message type identifier
inputDate string Input date
processingCode string Processing Code
authorizationDate string Authorization date
transmissionDate string CPD
cardNumber string PAN
cardSequenceNumber string Card sequence number
cardExpirationDate string Expired date
authorizationCode string Authorization code
transactionLifeCycleID string TRN
retrievalReferenceNumber string RRN
acquirerReferenceData string ARN
authorisationResponseSource ApiRefValue Authorizatin response source
issuerResponseCode string Responce code
transactionOriginatorInstitutionIDCode string Originator ID
issuerInstitutionIDCode string Issuer ID
acquiringInstitutionIDCode string Acquirer ID
forwardingInstitutionIDCode string Forward ID
authAmount string Authorization amount - Authorization currency
jsonAuthAmount string Authorization amount - Authorization currency (json)
amount string Billing amount - Billing currency
jsonAmount string Billing amount - Billing currency (json)
tranAmount string Clearing amount - Clearing currency
jsonTranAmount string Clearing amount - Clearing currency (json)
cardAcceptorBusinessCode string MCC
cardAcceptorTerminalId string Terminal ID
cardAcceptorIdCode string Merchant ID
cardAcceptorName string Merchant name
cardAcceptorCountryCode string Merchant country
cardAcceptorRegionCode string Merchant state
cardAcceptorZIP string Merchant ZIP
cardAcceptorCity string Merchant city
cardAcceptorAddress string Merchant address
cardInputMode ApiRefValue Card input mode
pointOfServiceDataCode string Point of service (POS) data
pointOfServiceDataCode_TerminalType ApiRefValue Terminal type
pointOfServiceDataCode_CardholderActivatedTerminalLevel ApiRefValue CAT level
pointOfServiceDataCode_TerminalDataCardDataInputCapability ApiRefValue Terminal Data: Card Data Input Capability
pointOfServiceDataCode_CardDataInputMode ApiRefValue Card Data: input mode
pointOfServiceDataCode_TerminalOperatingEnvironment ApiRefValue Terminal operating environment
pointOfServiceDataCode_CardAndCardholderPresentData ApiRefValue Card&Cardholder present data
pointOfServiceDataCode_CardholderAuthenticationMethod ApiRefValue Cardholder authentication method
pointOfServiceDataCode_ElectronicCommerceIndicator ApiRefValue ECI
authCVPFlag ApiRefValue CVP Flag
authCVP2Flag ApiRefValue CVP2 Flag
authPINFlag string PIN Flag
transactionIncs array of ApiSiomTransactionIncInfo Change history

ApiRefValue

Code Data type Descriprtion
code string Code
text string Name

ApiSiomTransactionIncInfo

Code Data type Description
id integer Record ID
inputDate string Record input date
inputSource ApiRefValue Input source
fraudStatus ApiRefValue Fraud status
fraudType ApiRefValue Fraud type
comment string Comment
inputChannel ApiRefValue Input channel
userName string Login of user who made change

Enumerations

ps

Value
MasterCard
Visa
Mir