Capitalist Logo

Операция get_documents_history_ext

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

Для этой операции доступен только формат ответа json.

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

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

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

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

Значения ответа

ValueDescription
data.pagesСводка о количестве записей и страницах.
pages.itemCountОбщее количество записей.
pages.pageCountОбщее количество страниц.
pages.pageSizeВыбранный размер страницы.
pages.currentPageНомер текущей страницы (начиная с 1).
pages.currentPageCountЧисло записей на текущей странице.
data.historyНайденные записи.
history[].numberНомер документа.
history[].idID документа.
history[].batchИнформация из массового платежа, если платеж был отправлен массовым платежом.
batch.idID массового платежа.
batch.numberВнутренний номер платежа в вашей системе.
batch.typeТип массового платежа.
batch.timestampДата массового платежа.
history[].timestampДата создания документа.
history[].stateСтатус платежа:
  • inprocess
  • executed
  • declined
  • unsigned
history[].stateLocalizedЛокализованное отображение статуса платежа.
history[].channelПлатежная система.
history[].correspondentКорреспондент.
history[].commentПричина отклонения платежа.
history[].accountВаш номер счета списания или пополнения.
history[].amountСумма платежа.
history[].currencyВалюта платежа (и комиссии).
history[].taxКомиссия.
history[].destAmountСумма назначения (в случае отличия валюты от валюты платежа.
history[].destCurrencyВалюта назначения.
history[].descriptionНазначение платежа.
history[].outgoingНаправление: исходящий или входящий платеж.
history[].selfExchangeОбмен между своими счетами.
history[].txIdID крипто транзакции.

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

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

{
  "code": 0,
  "message": "",
  "data": {
    "pages": {
      "itemCount": 7,
      "pageCount": 1,
      "pageSize": 50,
      "currentPage": 1,
      "currentPageCount": 7
    },
    "history": [
      {
        "number": 94706096,
        "id": 94706089,
        "batch": null,
        "timestamp": 1525447957,
        "state": "executed",
        "stateLocalized": "Исполнен",
        "channel": "Capitalist",
        "correspondent": "U0366438",
        "comment": "Fri May 04 18:32:37 MSK 2018",
        "account": "U0100192",
        "amount": 123,
        "tax": null,
        "currency": "USD",
        "destAmount": null,
        "destCurrency": null,
        "description": "Test",
        "outgoing": false,
        "selfExchange": false,
        "txId": null
      },
      {
        "number": 94706036,
        "id": 94706034,
        "batch": null,
        "timestamp": 1525447328,
        "state": "executed",
        "stateLocalized": "Исполнен",
        "channel": "Банковский счет",
        "correspondent": "Wires",
        "comment": "",
        "account": "U0100192",
        "amount": 2300,
        "tax": null,
        "currency": "USD",
        "destAmount": null,
        "destCurrency": null,
        "description": "Popolnenie!",
        "outgoing": false,
        "selfExchange": false,
        "txId": null
      },
      {
        "number": 94706028,
        "id": 94706023,
        "batch": null,
        "timestamp": 1525445511,
        "state": "inprocess",
        "stateLocalized": "В обработке",
        "channel": "Capitalist",
        "correspondent": "R0366510",
        "comment": null,
        "account": "U0100020",
        "amount": 43,
        "tax": null,
        "currency": "USD",
        "destAmount": "2672.26000000",
        "destCurrency": "RUR",
        "description": "Test (Конвертация валюты 43.00 USD в 2672.26 RUR)",
        "outgoing": true,
        "selfExchange": false,
        "txId": null
      },
      {
        "number": 94706015,
        "id": 94706012,
        "batch": null,
        "timestamp": 1525444195,
        "state": "inprocess",
        "stateLocalized": "В обработке",
        "channel": "Банковская карта РФ",
        "correspondent": "5106214000267756",
        "comment": null,
        "account": "U0100652",
        "amount": 100,
        "tax": 1,
        "currency": "USD",
        "destAmount": "6214.57000000",
        "destCurrency": "RUR",
        "description": "Test",
        "outgoing": true,
        "selfExchange": false,
        "txId": null
      },
      {
        "number": 94706004,
        "id": 94706001,
        "batch": null,
        "timestamp": 1525443418,
        "state": "executed",
        "stateLocalized": "Исполнен",
        "channel": "Capitalist",
        "correspondent": "R0100671",
        "comment": null,
        "account": "U0100020",
        "amount": 5000,
        "tax": null,
        "currency": "USD",
        "destAmount": "310728.54000000",
        "destCurrency": "RUR",
        "description": "Конвертация валюты 5000.00 USD в 310728.54 RUR",
        "outgoing": true,
        "selfExchange": true,
        "txId": null
      },
      {
        "number": 94705997,
        "id": 94705990,
        "batch": {
          "id": "475054ff-6b34-44fd-a680-57ccf99744ce",
          "number": "9999",
          "type": "WM",
          "timestamp": 1525443058
        },
        "timestamp": 1525443092,
        "state": "declined",
        "stateLocalized": "Отклонен",
        "channel": "WebMoney",
        "correspondent": "Z123456789012",
        "comment": "Ne nado!",
        "account": "U0100692",
        "amount": 10,
        "tax": 0,
        "currency": "USD",
        "destAmount": null,
        "destCurrency": null,
        "description": "Payout",
        "outgoing": true,
        "selfExchange": false,
        "txId": null
      },
      {
        "number": 94705981,
        "id": 94705979,
        "batch": {
          "id": "475054ff-6b34-44fd-a680-57ccf99744ce",
          "number": "9999",
          "type": "WM",
          "timestamp": 1525443058
        },
        "timestamp": 1525443092,
        "state": "inprocess",
        "stateLocalized": "В обработке",
        "channel": "WebMoney",
        "correspondent": "Z123456789012",
        "comment": null,
        "account": "U0100692",
        "amount": 10,
        "tax": 0,
        "currency": "USD",
        "destAmount": null,
        "destCurrency": null,
        "description": "Payout",
        "outgoing": true,
        "selfExchange": false,
        "txId": null
      }
    ]
  }
}
Cookies
We use cookies and anonymous statistics to make our website even better