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

Платежи

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

Ответ:

{
  "code": 0,
  "message": "string",
  "data": [
    {
      "idService": 0,
      "sName": "string",
      "tName": "string",
      "aName": "string",
      "idTypeTerminal": 0,
      "sn": "string",
      "date": "20230901140002",
      "dateIn": "20230901140002",
      "dateOut": "20230901140002",
      "processing": true,
      "account": "string",
      "amount": 0,
      "commission": 0,
      "comment": "string",
      "postStatus": "string",
      "eName": "string",
      "eCode": 0
    }
  ],
  "metadata": {
    "pageCount": 0,
    "pageSize": 0,
    "pageIndex": 0,
    "rowCount": 0
  },
  "result": {
    "totalCount": 0,
    "totalAmount": 0,
    "totalCommission": 0,
    "totalTerminalCount": 0,
    "totalServiceCount": 0,
    "totalErrorCount": 0,
    "totalErrorAmount": 0,
    "totalErrorCommission": 0,
    "totalProcessedCount": 0,
    "totalProcessedAmount": 0,
    "totalProcessedCommission": 0,
    "totalSuccessCount": 0,
    "totalSuccessAmount": 0,
    "totalSuccessCommission": 0
  }
}
  • idService - идентификатор услуги;
  • sName - наименование услуги;
  • tName - наименование терминала, где был сделан платёж;
  • aName - наименование агента, выполнившего платёж;
  • idTypeTerminal - тип терминала;
  • sn - номер транзакции;
  • date - дата платежа на терминале;
  • dateIn - дата платежа на сервере;
  • dateOut - дата завершения обработки платежа;
  • account - номер телефона/счёта;
  • amount - сумма платежа (в этой сумме комиссия);
  • commission - комиссия за платёж;
  • comment - комментарий к платежу (встречаются редко);
  • postStatus - статус постобработки (отмены, перепроведения и т.д.);
  • eCode и eName - если проведён с ошибкой, то код и текст ошибки;
  • processing - если платёж еще в обработке, то будет этот тег со значением true. В противном случае тег может отсутствовать. 

Итоги:

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

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

Наверх