Операция get_documents_history

Операция получения истории операций.

Эта операция устарела. Пожалуйста, используйте вместо нее другую: get_documents_history_ext.

Параметры запроса

Параметр Значение
operation get_documents_history
login <Имя пользователя>
token <TOKEN>. Получен при вызове get_token.
encrypted_password Зашифрованный пароль. Получен в результате RSA шифрования пароля пользователя при помощи публичной экспоненты и модуля, полученных при вызове операции get_token.
period_fromНачальная дата периода выборки документов (по-умолчанию — 7 дней назад).
Формат: ДД.ММ.ГГГГ
period_toКонечная дата периода выборки документов (по-умолчанию — сегодня).
Формат: ДД.ММ.ГГГГ
accountНомер вашего счета
document_stateСтатус документа.
Может принимать одно из следующих значений:
  • any — любой статус документа
  • onexecution — в обработке
  • executed — исполненные
  • declined — отклоненные
Если этот параметр пуст или не передан, принимает значение по-умолчанию any.
limitМаксимальное количество возвращаемых записей на страницу (от 0 до 1000). По-умолчанию – 30.
В случае 0 – записи не возвращаются.
pageНомер страницы (от 1 и больше).
Если page < 1 или не передан, то будет установлен в 1.

Смотрите также

  • import_batch_advanced — Загрузка массового платежа (батча) в систему с возможностью выбора способа подтверждения.
  • process_batch — Подтверждение массового платежа.
  • get_batch_info — Операция получения подробной информации по загруженному документу массового платежа (по батчу).
  • documents_search — Поиск документов по номеру платежа из вашей системы.

Ответ в формате CSV

Формат

Строка № Формат данных
10;<total_count>;<page_count>;<page>;<page_size>;<page_doc_count>;<doc_currency>
2 ... n<doc_num>;<doc_datetime>;<doc_state>;<doc_correspondent>; <doc_comment>;<doc_amount>;<doc_description>;<doc_state_code>

Значения

Значение Описание
<doc_num>Номер документа
<doc_datetime>Дата и время документа по московскому времени.
Формат: ДД.ММ.ГГГГ ЧЧ:ММ:СС
<doc_state>Локализованный статус документа.
Может принимать следующие значения:
  • В обработке
  • Отменен
  • Исполнен
  • Ожидает обработки
<doc_state_code>Код статуса документа.
Может принимать следующие значения:
  • NEW — ожидает обработки
  • ONEXECUTION — в обработке
  • DECLINED — отменен
  • EXECUTED — исполнен
<doc_correspondent>Корреспондент в формате "Тип платежа: корреспондент".
В случае банковского перевода, поле содержит данные о банке, номере счета и получателе:
Wire: Получатель;Счет;Банк
<doc_comment>Комментарий
<doc_amount>Сумма документа в валюте счета, по которому делалась выборка. Если сумма отрицательная — списание средств со счета. Если положительная — пополнение
<total_count>Общее число документов, без деления на страницы
<page_count>Общее число страниц с размером <page_size>
<page_size>Размер страницы (количество записей на страницу). Если в запросе был передан неправильный параметр limit, то <page_size> будет содержать скорректированное значение, иначе они совпадают
<page>Номер текущей страницы
<page_doc_count>Количество записей, найденных на текущей странице
<doc_currency>Валюта платежа
<doc_description>Назначение платежа

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

JSON (рекомендуемый, установите x-response-format=json)

{
    "code": 0,
    "message": "",
    "data": {
        "pages": {
            "itemCount": 7,
            "pageCount": 1,
            "pageSize": 30,
            "currentPage": 0,
            "currentPageCount": 7
        },
        "history": [
            {
                "number": 92362566,
                "date": "22.01.2015 15:20:58",
                "state": "Исполнен",
                "corrDetails": "WebMoney: Z112224443331",
                "comment": null,
                "amount": "-1.40",
                "description": "Payout 6",
                "state_code": "EXECUTED"
            },
            {
                "number": 92362498,
                "date": "22.01.2015 15:20:57",
                "state": "Исполнен",
                "corrDetails": "WebMoney: Z112224443331",
                "comment": null,
                "amount": "-1.10",
                "description": "Payout 3",
                "state_code": "EXECUTED"
            },
            {
                "number": 92362519,
                "date": "22.01.2015 15:20:57",
                "state": "Отменен",
                "corrDetails": "WebMoney: Z112224443331",
                "comment": "Внешний сервис вернул ошибку: корреспондент не найден",
                "amount": "-1.20",
                "description": "Payout 4",
                "state_code": "DECLINED"
            },
            {
                "number": 92362585,
                "date": "22.01.2015 15:20:58",
                "state": "Исполнен",
                "corrDetails": "WebMoney: Z112224443331",
                "comment": null,
                "amount": "-1.50",
                "description": "Payout 7",
                "state_code": "EXECUTED"
            },
            {
                "number": 92362544,
                "date": "22.01.2015 15:20:57",
                "state": "Исполнен",
                "corrDetails": "WebMoney: Z112224443331",
                "comment": null,
                "amount": "-1.30",
                "description": "Payout 5",
                "state_code": "EXECUTED"
            }
        ]
    }
}

CSV

0;7;1;0;30;7;USD
92362566;"22.01.2015 15:20:58";Исполнен;"WebMoney: Z112224443331";;-1.40;"Payout 6";EXECUTED
92362498;"22.01.2015 15:20:57";Исполнен;"WebMoney: Z112224443331";;-1.10;"Payout 3";EXECUTED
92362519;"22.01.2015 15:20:57";Отменен;"WebMoney: Z112224443331";"Внешний сервис вернул ошибку: корреспондент не найден";-1.20;"Payout 4";DECLINED
92362585;"22.01.2015 15:20:58";Исполнен;"WebMoney: Z112224443331";;-1.50;"Payout 7";EXECUTED
92362544;"22.01.2015 15:20:57";Исполнен;"WebMoney: Z112224443331";;-1.30;"Payout 5";EXECUTED
API Capitalist