Перейти к основному контенту

Платежи

POST /report/payments HTTP/1.1
{
  "Body": {
    "Params": {
      "dateFrom": "20200601132357",
      "dateTo": "20200628",
      "idAgent": 120,
      "subOn": 0,
      "idService": 12,
      "idTerminal": 12341,
      "account": "ssdfsdf8293",
      "sn": "2039754093285032948",
      "statuses": "1,3",
      "top": 200
    }
  }
}
  • dateFrom и dateTo - период отчета. Необязательное поле. По умолчанию текущий день. Можно задать как дату или дату и время. Если указано время, то оно будет применено при выборке платежей;
  • idAgent - Идентификатор агента. Необязательное поле. По умолчанию агент авторизованного пользователя;
  • subOn - 1-включить или 0-не включать в поиск платежи субагентов. Необязательное поле. По умолчанию 0;
  • idService - Идентификатор услуги. Необязательное поле. По умолчанию - все услуги;
  • idTerminal - Идентификатор терминала. Необязательное поле. По умолчанию - все терминалы;
  • account - номер телефона, счета и т.п. По части аккаунта поиск не работает - строка должна быть точно такой как в платеже;
  • sn - номер транзакции платежа;
  • statuses - статусы платежей. По умолчанию все. 1 - проведён; 2 - не проведён; 3 - помечен на отмену; 4 - в процессе отмены; 5 - отменен; 6- отклонена заявка на отмену; 7 - перепроведён. Передавать список через запятую;
  • top - количество платежей в ответе. По умолчанию 200.
 

Ответ:

{
  "QueryData": [
    {
      "Rows": [
        {
          "idService": 3704,
          "sName": "ЕРЦКУ Караганды",
          "tName": "5686 - woop_xml",
          "aName": "1463 - WOOPPAY ВУППЭЙ ТОО",
          "idTypeTerminal": 7,
          "sn": "1590952103143069639",
          "date": "20210204234921",
          "dateIn": "20200601010826",
          "dateOut": "20200601010900",
          "account": "100070334",
          "amount": 4092,
          "commission": 0,
          "processing": 1,
          "comment": "просто комментарий",
          "postStatus": "3"
        },
        {
          "idService": 3704,
          "sName": "ЕРЦКУ Караганды",
          "tName": "5686 - woop_xml",
          "aName": "1463 - WOOPPAY ВУППЭЙ ТОО",
          "idTypeTerminal": 7,
          "sn": "1591038522977025531",
          "date": "20210204234921",
          "dateIn": "20200602010847",
          "dateOut": "19991231235500",
          "account": "100070334",
          "amount": 4092,
          "commission": 0,
          "eName": "Номер не принадлежит оператору",
          "eCode": 5
        }
      ]
    }
  ],
  "Metadata": {
    "PageCount": 1,
    "PageSize": 19,
    "PageIndex": 0,
    "RowCount": 19
  },
  "ResultData": {
    "totalCount": 19,
    "totalAmount": 46403,
    "totalCommission": 10,
    "totalTerminalCount": 6,
    "totalServiceCount": 8,
    "totalErrorCount": 17,
    "totalErrorAmount": 41903,
    "totalErrorCommission": 10,
    "totalProcessedCount": 1,
    "totalProcessedAmount": 53,
    "totalProcessedCommission": 0,
    "totalSuccessCount": 1,
    "totalSuccessAmount": 4447,
    "totalSuccessCommission": 0
  },
  "Code": 0,
  "Message": "OK"
}
  • idService - идентификатор услуги;
  • sName - наименование услуги;
  • tName - наименование терминала, где был сделан платёж;
  • aName - наименование агента, выполнившего платёж;
  • idTypeTerminal - тип терминала;
  • sn - номер транзакции;
  • date - дата платежа на терминале;
  • dateIn - дата платежа на сервере;
  • dateOut - дата завершения обработки платежа;
  • account - номер телефона/счёта;
  • amount - сумма платежа (в этой сумме комиссия);
  • commission - комиссия за платёж;
  • comment - комментарий к платежу (встречаются редко);
  • postStatus - статус постобработки (отмены, перепроведения и т.д.);
  • eCode и eName - если проведён с ошибкой, то код и текст ошибки;
  • processing - если платёж еще в обработке, то будет этот тег со значением "1".

Итоги:

  • totalCount - количество платежей;
  • totalAmount - оплаченная клиентами сумма;
  • totalCommission - сумма удержанной комиссии;
  • totalTerminalCount - количество уникальных терминалов;
  • totalServiceCount - количество уникальных сервисов (услуг);
  • totalErrorCount - количество ошибочных платежей;
  • totalErrorAmount - оплаченная клиентами сумма ошибочных платежей;
  • totalErrorCommission - сумма удержанной комиссии ошибочных платежей;
  • totalProcessedCount - количество платежей в обработке;
  • totalProcessedAmount - оплаченная клиентами сумма платежей в обработке;
  • totalProcessedCommission - сумма удержанной комиссии ошибочных платежей;
  • totalSuccessCount - количество успешных платежей;
  • totalSuccessAmount - оплаченная клиентами сумма успешных платежей;
  • totalSuccessCommission - сумма удержанной комиссии успешных платежей.
 

Итоговые зачисленные суммы можно найти как totalAmount - totalCommission, соответственно.