Перейти к содержанию

getInvoicesHistory


Описание

Получение реестра платежей

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

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

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

Параметр Свойства Описание
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, то поиск будет проверять принадлежность магазина к организации.
State Статус СКО
INT
OPTIONAL
Запрос реестра платежей только с указанным статусом СКО (см. )
InvoiceId Номер СКО
INT 3*********
OPTIONAL
Запрос информации только по одному СКО по его номеру
IncludePaymentTransactions Включает транзакции по СКО в выборку
BOOLEAN
OPTIONAL
При передаче значения true в выборку будут включены все транзакции по СКО: транзакции пополнения СКО, транзакции пополнения счета магазина, транзакции возврата (при возврате)
IsHoldingSearch Тип операции
INT
OPTIONAL
Флаг, указывающий на поиск по организациям холдинга:
  • 0 - Поиск по организациям холдинга не осуществляется
  • 1 - Поиск по организациям холдинга включен
Если флаг включен:
  • EshopId и OrganizationId не переданы - выведет все магазины в холдинге
  • EshopId передан - будет искать данный магазин во всех организациях холдинга
  • OrganizationId передан - будет искать данный магазин, среди магазинов организации
  • Переданы EshopId и OrganizationId - будет искать магазин среди магазинов организации
OwnerEmail Email пользователя (покупателя)
STRING MAX 100
OPTIONAL
Будут выбраны только те СКО, в которых был указан данный email.
SortOrder Указывает порядок сортировки
STRING
OPTIONAL
Данный порядок отвечает за сортировку данных перед выдачей()
DateFrom Дата начала выборки создания СКО
DATE ДД.ММ.ГГГГ
OPTIONAL
В выборку попадут все СКО, у которых дата создания входит в данный диапазон
DateTo Дата окончания выборки создания СКО
DATE ДД.ММ.ГГГГ
OPTIONAL
В выборку попадут все СКО, у которых дата создания входит в данный диапазон
ChangeDateFrom Дата начала выборки изменения СКО
DATE ДД.ММ.ГГГГ
OPTIONAL
В выборку попадут все СКО, у которых дата изменения входит в данный диапазон.
ChangeDateTo Дата окончания выборки изменения СКО
DATE ДД.ММ.ГГГГ
OPTIONAL
В выборку попадут все СКО, у которых дата изменения входит в данный диапазон.
Skip Ограничение выборки по количеству объектов
INT
OPTIONAL
Количество объектов, пропускаемых перед отдачей.
Take Ограничение выборки по количеству объектов
INT
REQUIRED
Ограничение на количество возвращаемых объектов.
WithRefunds Только СКО по которым были возвраты
STRING
OPTIONAL
В выборку попадут только СКО по которым были возвраты.

Тело ответа

Поле Тип Описание
OperationState OperationState Статус выполнения операции.
OperationId GUID Идентификатор операции.
EshopId INT Номер магазина.
Result InvoicesHistoryList Результат выполнения запроса.
Примеры кода
C#
var client = new HttpClient();

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

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", "YdUlqkFcVo62XmY6B9VLJe1LBEdkM2CQxttGbeRtLymeoI5vYD7ts9DT5JH8Uas3"));
collection.Add(new("DateFrom", "01.01.2020"));
collection.Add(new("DateTo", "01.02.2025"));
collection.Add(new("Take", "1"));
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/getInvoicesHistory',
    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=YdUlqkFcVo62XmY6B9VLJe1LBEdkM2CQxttGbeRtLymeoI5vYD7ts9DT5JH8Uas3&DateFrom=01.01.2020&DateTo=01.02.2025&Take=1',
    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": "Успешно обработан"
        },
        "InvoicesHistoryList": [
            {
                "Id": 3330859615,
                "State": "Refund",
                "HoldModeFlag": false,
                "ChangeDate": "2021-08-28T17:30:14.413+03:00",
                "CreationDate": "2021-03-01T17:30:13.417+03:00",
                "ExpirationDate": "0001-01-01T00:00:00+03:00",
                "Amount": {
                    "Amount": 10.0,
                    "Currency": "RUB"
                },
                "CurrentAmount": {
                    "Amount": 0.0,
                    "Currency": "RUB"
                },
                "SurchargeAmount": {
                    "Amount": 10.0,
                    "Currency": "RUB"
                },
                "Comment": "Демонстрация процесса оплаты",
                "AdditionalInfo": [
                    {
                        "Key": "Магазин",
                        "Value": "IM Demo"
                    },
                    {
                        "Key": "Url",
                        "Value": "https://intellectmoney.ru"
                    }
                ],
                "OwnerEmail": "vashmail@gmail.com",
                "OwnerFIO": "  ",
                "PurchaseOrderId": "order_5066916",
                "UserId": 0,
                "PassthroughModeFlag": false,
                "EShopId": 459299,
                "HttpRequestErrorCount": 2068,
                "HttpRequests": [
                    {
                        "HttpRequestId": 17137446,
                        "ErrorCode": 301,
                        "ErrorDescription": "Moved Permanently",
                        "ErrorsCount": 44,
                        "HttpRequestState": "Expired",
                        "CreationDate": "2021-03-01T17:30:13.54+03:00",
                        "Method": "POST",
                        "NextAttemptDate": "2021-03-05T04:16:48.547+03:00",
                        "Url": "https://eshop.intellectmoney.ru",
                        "DataStringKeyValues": [
                            {
                                "Key": "eshopId",
                                "Value": "459299"
                            },
                            {
                                "Key": "paymentId",
                                "Value": "3330859615"
                            },
                            {
                                "Key": "orderId",
                                "Value": "order_5066916"
                            },
                            {
                                "Key": "eshopAccount",
                                "Value": "4483953250"
                            },
                            {
                                "Key": "serviceName",
                                "Value": "%d0%94%d0%b5%d0%bc%d0%be%d0%bd%d1%81%d1%82%d1%80%d0%b0%d1%86%d0%b8%d1%8f+%d0%bf%d1%80%d0%be%d1%86%d0%b5%d1%81%d1%81%d0%b0+%d0%be%d0%bf%d0%bb%d0%b0%d1%82%d1%8b"
                            },
                            {
                                "Key": "recipientAmount",
                                "Value": "10.00"
                            },
                            {
                                "Key": "recipientOriginalAmount",
                                "Value": "10.00"
                            },
                            {
                                "Key": "recipientCurrency",
                                "Value": "RUB"
                            },
                            {
                                "Key": "paymentStatus",
                                "Value": "3"
                            },
                            {
                                "Key": "userName",
                                "Value": ""
                            },
                            {
                                "Key": "userEmail",
                                "Value": "vashmail%40gmail.com"
                            },
                            {
                                "Key": "paymentData",
                                "Value": "2021-03-01+17%3a30%3a13"
                            },
                            {
                                "Key": "secretKey",
                                "Value": ""
                            },
                            {
                                "Key": "hash",
                                "Value": "a49dac56a73ce53afc996b7c91d5a5b3"
                            },
                            {
                                "Key": "UserField_1",
                                "Value": "value_1%2cvalue_1"
                            },
                            {
                                "Key": "UserField_2",
                                "Value": "value_2%2cvalue_2"
                            }
                        ],
                        "Eshopname": "IM Demo",
                        "EshopProtocolType": "IMProtocol",
                        "EshopProtocolVersion": 3,
                        "DataString": "eshopId=459299&paymentId=3330859615&orderId=order_5066916&eshopAccount=4483953250&serviceName=%c4%e5%ec%ee%ed%f1%f2%f0%e0%f6%e8%ff+%ef%f0%ee%f6%e5%f1%f1%e0+%ee%ef%eb%e0%f2%fb&recipientAmount=10.00&recipientOriginalAmount=10.00&recipientCurrency=RUB&paymentStatus=3&userName=&userEmail=vashmail%40gmail.com&paymentData=2021-03-01+17%3a30%3a13&secretKey=&hash=a49dac56a73ce53afc996b7c91d5a5b3&UserField_1=value_1&UserField_2=value_2&userfield_1=value_1&userfield_2=value_2",
                        "ContentType": "application/x-www-form-urlencoded",
                        "ErrorResponseHistory": "Error Message:Ошибка отправки HTTP запроса Status:SendFailure\r\n The complete request could not be sent to the server"
                    },
                    {
                        "HttpRequestId": 18141276,
                        "ErrorCode": 301,
                        "ErrorDescription": "Moved Permanently",
                        "ErrorsCount": 44,
                        "HttpRequestState": "Expired",
                        "CreationDate": "2021-08-28T17:30:14.43+03:00",
                        "Method": "POST",
                        "NextAttemptDate": "2021-09-01T04:02:11.823+03:00",
                        "Url": "https://eshop.intellectmoney.ru",
                        "DataStringKeyValues": [
                            {
                                "Key": "eshopId",
                                "Value": "459299"
                            },
                            {
                                "Key": "paymentId",
                                "Value": "3330859615"
                            },
                            {
                                "Key": "orderId",
                                "Value": "order_5066916"
                            },
                            {
                                "Key": "eshopAccount",
                                "Value": "4483953250"
                            },
                            {
                                "Key": "serviceName",
                                "Value": "%d0%94%d0%b5%d0%bc%d0%be%d0%bd%d1%81%d1%82%d1%80%d0%b0%d1%86%d0%b8%d1%8f+%d0%bf%d1%80%d0%be%d1%86%d0%b5%d1%81%d1%81%d0%b0+%d0%be%d0%bf%d0%bb%d0%b0%d1%82%d1%8b"
                            },
                            {
                                "Key": "recipientAmount",
                                "Value": "10.00"
                            },
                            {
                                "Key": "recipientOriginalAmount",
                                "Value": "10.00"
                            },
                            {
                                "Key": "recipientCurrency",
                                "Value": "RUB"
                            },
                            {
                                "Key": "paymentStatus",
                                "Value": "4"
                            },
                            {
                                "Key": "userName",
                                "Value": ""
                            },
                            {
                                "Key": "userEmail",
                                "Value": "vashmail%40gmail.com"
                            },
                            {
                                "Key": "paymentData",
                                "Value": "2021-08-28+17%3a30%3a14"
                            },
                            {
                                "Key": "secretKey",
                                "Value": ""
                            },
                            {
                                "Key": "hash",
                                "Value": "7b215dd31f71c021cc0fd1f2d0954676"
                            },
                            {
                                "Key": "UserField_1",
                                "Value": "value_1%2cvalue_1"
                            },
                            {
                                "Key": "UserField_2",
                                "Value": "value_2%2cvalue_2"
                            }
                        ],
                        "Eshopname": "IM Demo",
                        "EshopProtocolType": "IMProtocol",
                        "EshopProtocolVersion": 3,
                        "DataString": "eshopId=459299&paymentId=3330859615&orderId=order_5066916&eshopAccount=4483953250&serviceName=%c4%e5%ec%ee%ed%f1%f2%f0%e0%f6%e8%ff+%ef%f0%ee%f6%e5%f1%f1%e0+%ee%ef%eb%e0%f2%fb&recipientAmount=10.00&recipientOriginalAmount=10.00&recipientCurrency=RUB&paymentStatus=4&userName=&userEmail=vashmail%40gmail.com&paymentData=2021-08-28+17%3a30%3a14&secretKey=&hash=7b215dd31f71c021cc0fd1f2d0954676&UserField_1=value_1&UserField_2=value_2&userfield_1=value_1&userfield_2=value_2",
                        "ContentType": "application/x-www-form-urlencoded",
                        "ErrorResponseHistory": "Error Message:Ошибка отправки HTTP запроса Status:SendFailure\r\n The complete request could not be sent to the server"
                    }
                ],
                "Rrn": "",
                "PurchaseData": {
                    "Id": 10382514,
                    "PurchaseMoney": {
                        "Amount": 10.0,
                        "Currency": "RUB"
                    },
                    "OrderId": "order_5066916",
                    "Name": "Демонстрация процесса оплаты",
                    "SuccessUrl": "",
                    "FailUrl": "",
                    "BackUrl": "https://eshop.intellectmoney.ru/ru/demo/paymentsold/",
                    "UserFields": "UserField_1=value_1&UserField_2=value_2",
                    "Invoice": {
                        "Id": 3330859615,
                        "State": "Created",
                        "HoldModeFlag": false,
                        "ChangeDate": "0001-01-01T00:00:00+03:00",
                        "CreationDate": "0001-01-01T00:00:00+03:00",
                        "ExpirationDate": "0001-01-01T00:00:00+03:00",
                        "AdditionalInfo": [],
                        "HistoryList": [],
                        "PaymentTransactions": [],
                        "UserId": 0,
                        "PassthroughModeFlag": false,
                        "EShopId": 0,
                        "HttpRequestErrorCount": 0,
                        "HttpRequests": [],
                        "PurchaseData": {
                            "Id": 0,
                            "EshopId": 0,
                            "SMSEnable": true,
                            "IsHeldByEshop": false
                        },
                        "IsCanEnrollmentByDisabledMethod": false,
                        "InvoiceChangeAmountHistoryData": [],
                        "IsHaveCashboxReceipts": false,
                        "ReceiptVatRate": [],
                        "IsRecurrent": false
                    },
                    "EshopId": 459299,
                    "EshopUrl": "https://ya.ru",
                    "EshopName": "IM Demo",
                    "SMSEnable": true,
                    "UserEmail": "vashmail@gmail.com",
                    "IsHeldByEshop": false,
                    "ParseUserFields": [
                        {
                            "Key": "userfield_1",
                            "Value": "value_1"
                        },
                        {
                            "Key": "userfield_2",
                            "Value": "value_2"
                        }
                    ]
                },
                "IsCanEnrollmentByDisabledMethod": false,
                "InvoiceChangeAmountHistoryData": [],
                "OriginalAmount": {
                    "Amount": 10.0,
                    "Currency": "RUB"
                },
                "FormType": "None",
                "OrganizationName": "ИНТЕЛЛЕКТМАНИ",
                "IsHaveCashboxReceipts": false,
                "ReceiptVatRate": [
                    {
                        "Key": "1",
                        "Value": "20%"
                    },
                    {
                        "Key": "2",
                        "Value": "10%"
                    },
                    {
                        "Key": "3",
                        "Value": "расч 20/120"
                    },
                    {
                        "Key": "4",
                        "Value": "расч 10/110"
                    },
                    {
                        "Key": "5",
                        "Value": "0%"
                    },
                    {
                        "Key": "6",
                        "Value": "Не облагается"
                    },
                    {
                        "Key": "7",
                        "Value": "5%"
                    },
                    {
                        "Key": "8",
                        "Value": "7%"
                    },
                    {
                        "Key": "9",
                        "Value": "расч 5/105"
                    },
                    {
                        "Key": "10",
                        "Value": "расч 7/107"
                    }
                ],
                "IsRecurrent": false
            }
        ]
    }
}
JSON
{
    "OperationState": {
        "Code": 2,
        "Desc": "Слишком большое количество счетов. Уменьшите период выборки."
    },
    "Result": false
}