getInvoiceInfo

Описание

Получение информации о платеже

POST (Уровень доступа: Базовый)

https://api.intellectmoney.ru/personal/payment/getInvoiceInfo

Заголовки запроса

Параметр	Свойства	Описание
Accept	STRING OPTIONAL application/json	Заголовок, указывающий формат данных, которые клиент хочет получить от сервера.
Content-Type	STRING OPTIONAL application/json application/xml	Заголовок, указывающий формат данных в теле запроса.
Authorization	STRING REQUIRED Bearer {token}	Заголовок, используемый для аутентификации клиента с помощью Bearer токена. Подробнее об использование Bearer токена.
Sign	STRING REQUIRED	Заголовок с подписью для аутентификации запроса. Сигнатура подписи: ``

Тело запроса

Параметр	Свойства	Описание
UserToken	Ключ доступа STRING REQUIRED	Ключ доступа клиента к API, запрашиваемый операцией аутентификации клиента GetUserToken
EshopId	ID магазина INT OPTIONAL	Номер магазина в системе IntellectMoney, по которому запрашивается реестр.
OrganizationId	ID организации INT OPTIONAL	Номер организации в системе IntellectMoney, по которому запрашивается информация. Это номер заявления о присоединении: Если параметр передан - выведет информацию по всем магазинам организации. Если передан параметр EshopId и Organization, то поиск будет проверять принадлежность магазина к организации.
InvoiceId	Номер СКО INT 3********* REQUIRED	Запрос информации только по одному СКО по его номеру
IsHoldingSearch	Тип операции INT OPTIONAL	Флаг, указывающий на поиск по организациям холдинга: 0 - Поиск по организациям холдинга не осуществляется 1 - Поиск по организациям холдинга включен Если флаг включен: EshopId и OrganizationId не переданы - выведет все магазины в холдинге EshopId передан - будет искать данный магазин во всех организациях холдинга OrganizationId передан - будет искать данный магазин, среди магазинов организации Переданы EshopId и OrganizationId - будет искать магазин среди магазинов организации

Тело ответа

Поле	Тип	Описание
OperationState	OperationState	Статус выполнения операции.
OperationId	GUID	Идентификатор операции.
EshopId	INT	Номер магазина.
Result	InvoiceInfoData	Результат выполнения запроса.

Примеры кода

C#PHP

C#

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.intellectmoney.ru/personal/payment/getInvoiceInfo");

request.Headers.Add("Accept", "application/json");
request.Headers.Add("Content-Type", "application/json");
request.Headers.Add("Authorization", "Bearer e801b9fd828147f09c0699e4b831606e");
request.Headers.Add("Sign", "ee6b71c6c54ec9b3c02d1a8bceb535b846640e4164d758489d571ffe029070af");

var collection = new List<KeyValuePair<string, string>>();
collection.Add(new("UserToken", "YdUlqkFcVo62XmY6B9VLJbpE8v0m38HGMNSyQ5EhhrEvFG51fbV8LdbtyT2wv6Sr"));
collection.Add(new("InvoiceId", "3717809037"));
var content = new FormUrlEncodedContent(collection);
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.intellectmoney.ru/personal/payment/getInvoiceInfo',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => 'UserToken=YdUlqkFcVo62XmY6B9VLJbpE8v0m38HGMNSyQ5EhhrEvFG51fbV8LdbtyT2wv6Sr&InvoiceId=3717809037',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Content-Type: application/json',
        'Authorization: Bearer e801b9fd828147f09c0699e4b831606e',
        'Sign: ee6b71c6c54ec9b3c02d1a8bceb535b846640e4164d758489d571ffe029070af',
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Пример ответов

УспехОшибка

JSON

{
    "OperationState": {
        "Code": 0,
        "Desc": "Успешно обработана"
    },
    "Result": {
        "State": {
            "Code": 0,
            "Desc": "Успешно обработан"
        },
        "Eshop": {
            "EshopId": 459299,
            "EshopName": "IM Demo",
            "Protocol": "IMProtocol",
            "SecretKey": "Xb4XgeHH0h",
            "ResultUrl": "https://test.ru"
        },
        "Organization": {
            "OrganizationId": 61476,
            "OrganizationName": "ИНТЕЛЛЕКТМАНИ",
            "Email": "pro+1@intellectmoney.ru",
            "OrganizationLogin": "pro+1@intellectmoney.ru"
        },
        "ListNotificationParams": [],
        "InvoiceId": 3717809037
    }
}

JSON

{
    "OperationState": {
        "ErrorSourceParam": "invoiceId",
        "Code": 2,
        "Desc": "Не задан обязательный параметр"
    },
    "Result": {
        "State": {
            "Code": 0,
            "Desc": "Успешно обработан"
        }
    }
}