Операция documents_search

Поиск документов по номеру платежа из вашей системы.

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

Параметр Значение
operation documents_search
login <Имя пользователя>
token <TOKEN>. Получен при вызове get_token.
encrypted_password Зашифрованный пароль. Получен в результате RSA шифрования пароля пользователя при помощи публичной экспоненты и модуля, полученных при вызове операции get_token.
beginDate Начало периода.
endDate Конец периода.
customNumber Номер платежа из вашей системы. Необязательный параметр.

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

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

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

Формат

Строка № Формат данных
10;
2, 3, ..., n<type>;<batchId>;<timestamp>;<sourceAccount>;<destinationAccount>;<amount>;<currency>;<description>;<customNumber>;<documentNumber>;<comment>;<documentState>;<localizedDocumentState>

Значения

Значение Описание
<type>Тип платежа (код операции в массовом платеже)
<batchId>Номер массового платежа, содержащего этот документ
<timestamp>Дата создания документа (timestamp)
<sourceAccount>Отправитель
<destinationAccount>Счет получателя во внешней системе
<amount>Сумма платежа
<currency>Валюта платежа
<description>Назначение платежа
<customNumber>Номер платежа в вашей системе
<documentNumber>Номер платежа в системе Capitalist
<comment>Причина отклонения платежа
<documentState>Может принимать следующие значения:
  • NEW, READY — ожидает обработки
  • INPROCESS — в обработке
  • DECLINED — отменен
  • PROCESSED — исполнен
<localizedDocumentState>Локализованный статус платежа

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

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

{
    "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": "В обработке"
            }
        ]
    }
}

CSV

0;;04.06.2016;04.07.2016;
CAPITALIST;344bfcc6-1231-4eb1-a8bd-872c1f697bb0;1465483189;R0100813;R0100271;12.34;RUR;"Payout CAP";9666;;;INPROCESS;"В обработке"
BANKCARD;344bfcc6-1231-4eb1-a8bd-872c1f697bb0;1465483189;R0100813;"5187 7429 3333 1234";100.00;RUR;;9999;;"Неверно задано значение поля Card number";DECLINED;Отменен
CAPITALIST;6d04b343-434e-40af-a225-67d1bd0294b7;1465483189;R0100671;R0100271;10.00;RUR;Payout;9999;93173750;;PROCESSED;Обработан
QIWI;3668010f-d074-4bc1-9d28-732c8ab18240;1465483189;R0100671;9030120099;100.00;RUR;;1001;;;INPROCESS;"В обработке"
API Capitalist