Operation get_documents_history_ext

Documents history.

Only response format json is allowed for this operation.

Query parameters

doc_getDocumentsHistory_response
ParameterValue
operationget_documents_history_ext
login<Username>
token<TOKEN>. Obtained after invoking get_token.
encrypted_passwordEncrypted password. It is obtained after user password RSA encryption with the use of a public exponent and the modulus obtained in invoking the get_token operation.
period_fromThe start date for collecting documents (the default is 7 days before).
Format: DD.MM.YYYY
period_toThe end date of collecting documents (the default is today).
Format: DD.MM.YYYY
document_stateDocument status.
May take one of the following values:
  • any — any document status
  • inprocess — in process
  • executed — executed
  • declined — declined
If this parameter is empty or not provided, it accept the default value, any
limitThe maximum number of records returned per page (50 to 1000). The default is 100.
In the case of 0 – entries will not be returned.
pagePage number (1 and more).
If page < 1 or not provided, it will be set to 1.
accountYour account number (optional).
external_accountSearch by Correspondent details (optional).

See also

  • import_batch_advanced — Uploading a batch payment into the system with the possibility to choose the verification method.
  • process_batch — Batch payment confirmation.
  • get_batch_info — The operation of getting detailed information about the downloaded batch payment document.
  • documents_search — Search documents by number from your system.

Response values

ValueDescription
data.pagesSummary of post count and pages.
pages.itemCountTotal number of records.
pages.pageCountTotal number of pages.
pages.pageSizeSelected page size.
pages.currentPageCurrent page number (starting from 1).
pages.currentPageCountThe number of records on the current page.
data.historyFound records.
history[].numberDocument number.
history[].idDocument ID.
history[].batchInformation from the mass payment, if the payment was sent by mass payment.
batch.idMass payment ID.
batch.numberInternal payment number in your system.
batch.typeMass payment type.
batch.timestampMass payment date.
history[].timestampDocument creation date.
history[].statePayment status:
  • inprocess
  • executed
  • declined
  • unsigned
history[].stateLocalizedLocalized display of payment status.
history[].channelPayment system.
history[].correspondentCorrespondent.
history[].commentReason for payment rejection.
history[].accountYour debit or replenishment account number.
history[].amountAmount of payment.
history[].currencyCurrency of payment (and commission).
history[].taxCommission.
history[].destAmountDestination amount (if the currency differs from the payment currency.
history[].destCurrencyDestination currency.
history[].descriptionPurpose of payment.
history[].outgoingDirection: outgoing or incoming payment.
history[].selfExchangeExchange between your accounts.
history[].txIdCrypto transaction ID.

Response examples

JSON (recommended format, please set x-response-format=json header)

{
  "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
      }
    ]
  }
}