Operation documents_search

Search documents by number from your system.

Query parameters

ParameterValue
operationdocuments_search
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.
beginDatePeriod starting date. DD.MM.YYYY format.
endDatePeriod ending date. DD.MM.YYYY format.
customNumberPayment number from your system. Необязательный параметр.

See also

  • import_batch_advanced — Uploading a batch payment into the system with the possibility to choose the verification method.
  • get_batch_info — The operation of getting detailed information about the downloaded batch payment document.
  • get_documents_history_ext — The operation of obtaining the history of operations.

Response

Values

ValueDescription
<type>Type of the payment (Opcode of mass payment)
<batchId>The ID of the batch payment document created in the system
<timestamp>Document creation date (timestamp)
<sourceAccount>Source account
<destinationAccount>Destination account
<amount>Amount
<currency>Currency
<description>Payment description
<customNumber>Payment number from your system
<documentNumber>Capitalist payment number
<comment>Description of the reason for rejecting the document
<documentState>

It may take the following values:

  • NEW, READY — awaiting processing
  • INPROCESS — in process
  • DECLINED — declined
  • PROCESSED — processed
<localizedDocumentState>Localized document state

Response examples

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

{
  "code": 0,
  "message": "",
  "data": {
    "search": {
      "beginDate": "04.06.2016",
      "endDate": "04.07.2016",
      "customNumber": null
    },
    "documents": [
      {
        "type": "CAPITALIST",
        "sourceAccount": "R0100813",
        "destinationAccount": "R0100271",
        "batchId": "344bfcc6-1231-4eb1-a8bd-872c1f697bb0",
        "timestamp": 1465483189,
        "currency": "RUR",
        "amount": "12.34",
        "description": "Payout CAP",
        "customNumber": "9666",
        "documentNumber": null,
        "comment": null,
        "documentState": "INPROCESS",
        "localizedDocumentState": "В обработке"
      },
      {
        "type": "BANKCARD",
        "sourceAccount": "R0100813",
        "destinationAccount": "5187 7429 3333 1234",
        "batchId": "344bfcc6-1231-4eb1-a8bd-872c1f697bb0",
        "timestamp": 1465483189,
        "currency": "RUR",
        "amount": "100.00",
        "description": null,
        "customNumber": "9999",
        "documentNumber": null,
        "comment": "Неверно задано значение поля Card number",
        "documentState": "DECLINED",
        "localizedDocumentState": "Отменен"
      },
      {
        "type": "CAPITALIST",
        "sourceAccount": "R0100671",
        "destinationAccount": "R0100271",
        "batchId": "6d04b343-434e-40af-a225-67d1bd0294b7",
        "timestamp": 1465483189,
        "currency": "RUR",
        "amount": "10.00",
        "description": "Payout",
        "customNumber": "9999",
        "documentNumber": "93173750",
        "comment": null,
        "documentState": "PROCESSED",
        "localizedDocumentState": "Обработан"
      },
      {
        "type": "QIWI",
        "sourceAccount": "R0100671",
        "destinationAccount": "9030120099",
        "batchId": "3668010f-d074-4bc1-9d28-732c8ab18240",
        "timestamp": 1465483189,
        "currency": "RUR",
        "amount": "100.00",
        "description": null,
        "customNumber": "1001",
        "documentNumber": null,
        "comment": null,
        "documentState": "INPROCESS",
        "localizedDocumentState": "В обработке"
      }
    ]
  }
}