Получение информации о СКО

Описание

Используется для получения информации о СКО.

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::::::EshopId::OrganizationId::IsHoldingSearch::InvoiceId::SignSecretKey

Тело запроса

Параметр	Свойства	Описание
UserToken	STRING REQUIRED	Токен-пользователя. Для получения использовать метод GetUserToken.
EshopId	STRING OPTIONAL max 6	Номер магазина. Можно найти в личном кабинете, в разделе магазины.
OrganizationId	STRING OPTIONAL max 5	Номер организации. Можно найти в личном кабинете на главной странице.
IsHoldingSearch	STRING OPTIONAL boolean	Флаг, указывающий поиск по организациям холдинга. Допустимые значения: false - без поиска по организациям холдинга. true - с поиском по организациям холдинга. Не переданы OrganizationId и EshopId - поиск по всем организациям холдинга. Передан OrganizationId - поиск в рамках указанной организации. Передан EshopId - поиск в рамках указанного магазина.
InvoiceId	STRING REQUIRED 3xxxxxxxxx	Номер СКО.

Тело ответа

Поле	Тип	Описание
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", "YdUlqkFcVo62XmY6B9VLJfwUODqE9ODk8/q/s1uXguWmiiPUo+R8YpiYt6g/s/IM"));
collection.Add(new("InvoiceId", "3000000000"));
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=YdUlqkFcVo62XmY6B9VLJfwUODqE9ODk8/q/s1uXguWmiiPUo+R8YpiYt6g/s/IM&InvoiceId=3000000000',
    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": 450000,
            "EshopName": "Магазин",
            "Protocol": "IMProtocol",
            "SecretKey": "Секретный ключ",
            "ResultUrl": "https://test.ru"
        },
        "Organization": {
            "OrganizationId": 60000,
            "OrganizationName": "Организация",
            "Email": "test@mail.ru",
            "OrganizationLogin": "test@mail.ru"
        },
        "ListNotificationParams": [],
        "InvoiceId": 3000000000
    }
}

JSON

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