getPaymentsHistory

Описание

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

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

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

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

Параметр	Свойства	Описание
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, по которому запрашивается реестр.
DateFrom	Дата начала выборки создания СКО DATE ДД.ММ.ГГГГ OPTIONAL	В выборку попадут все СКО, у которых дата создания входит в данный диапазон
DateTo	Дата окончания выборки создания СКО DATE ДД.ММ.ГГГГ OPTIONAL	В выборку попадут все СКО, у которых дата создания входит в данный диапазон
Skip	Ограничение выборки по количеству объектов INT OPTIONAL	Количество объектов, пропускаемых перед отдачей.
Take	Ограничение выборки по количеству объектов INT REQUIRED	Ограничение на количество возвращаемых объектов.

Тело ответа

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

Примеры кода

C#PHP

C#

var client = new HttpClient();

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

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/getPaymentsHistory',
    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": "Успешно обработан"
        },
        "PaymentsHistoryList": [
            {
                "Id": 181778513,
                "PaymentNumber": "2194349188",
                "State": "Confirm",
                "CreationDate": "2025-02-01T12:50:09.667+03:00",
                "PaymentAmount": {
                    "Amount": 10.0,
                    "Currency": "TST"
                },
                "RecipientAmount": {
                    "Amount": 10.0,
                    "Currency": "TST"
                },
                "PaymentAccount": "Счет к оплате 3611166272",
                "RecipientAccount": "4480883855",
                "Account": "4480883855",
                "Description": "Зачисление на счет магазина \"IM Demo TST (Autotest)\" со счета \"3611166272\"",
                "Direction": "Deposit",
                "PurchaseOrderId": "recurring-test-053_529f5e21-a160-4159-8e41-4207c4dfddc0",
                "AdditionalInfo": [],
                "InvoicePaymentType": "Purchase",
                "InvoiceId": 3611166272,
                "InvoiceComment": "",
                "IsElectedPayment": false,
                "CatalogPaymentId": 0,
                "InputType": "TestAcquiring",
                "ShortPan": "",
                "Country": "",
                "Bank": "",
                "IPAdress": "",
                "UserEmail": "pro+1@intellectmoney.ru",
                "ServiceName": "",
                "CardHolder": "",
                "EshopName": "IM Demo TST (Autotest) (459759)"
            }
        ]
    }
}

JSON

{
    "OperationState": {
        "Code": 2,
        "Desc": "Ошибка авторизации."
    },
    "Result": false
}