Запросы для получения отчетности
Запросы для получения отчетности
В системе WEBPAY предусмотрено получение отчетов по API из личного кабинета реальной среды https://merchant.webpay.by двумя способами:
Описание полей запроса
| Параметр | Описание |
|---|---|
url_платежного_модуля | Адрес для получения отчета — https://merchant.webpay.by |
reportType | Tип получаемого отчета:
|
email | Email для отправки отчета (отчет приходит с задержкой до 10 минут) |
reportFormat | Формат отчета:
|
startDate, endDate | Диапазон дат по всем типам операций. Формат: YYYY-MM-DD |
startFinancialCompletionDate, endFinancialCompletionDate | Диапазон дат операций финансового завершения (должны находиться в пределах startDate,endDate). В ином случае отчет будет сформирован в рамках диапазона дат, указанных в полях startDate и endDate. Формат: YYYY-MM-DD |
startReversalDate, endReversalDate | Диапазон дат операций отмены/возврата (должны находиться в пределах startDate, endDate) В ином случае отчет будет сформирован в рамках диапазона дат, указанных в полях startDate и endDate. Формат: YYYY-MM-DD |
login | Логин от личного кабинета |
password | Пароль от личного кабинета в формате MD5-hash |
GET-метод
URL-адрес формируется по следующей схеме:
{url_платежного_модуля}/reports/merchants/{reportType}?email={email}&reportFormat={reportFormat}&startDate={startDate}&endDate={endDate}&startFinancialCompletionDate={startFinancialCompletionDate}&endFinancialCompletionDate={endFinancialCompletionDate}&startReversalDate={startReversalDate}&endReversalDate={endReversalDate}
Заголовок авторизации: Authorization: login:password
Пример запроса
https://merchant.webpay.by/reports/merchants/RECONCILIATION_REPORT?email=test@webpay.by&reportFormat=JSON&startDate=2019-12-20&endDate=2019-12-30&startFinancialCompletionDate=2019-12-20&endFinancialCompletionDate=2019-12-30&startReversalDate=2019-10-01&endReversalDate=2019-12-30
POST-метод
Запрос осуществляется на следующий URL-адрес:
{url_платежного_модуля}/reports/get
Инфо
ОГРАНИЧЕНИЕ: диапазон дат не более 3 месяцев либо файл объемом не более 100 000 записей.
Пример тела запроса
{
"login": "test",
"password": "3434c7ab03ecfbde62ae697a7c66ae8e",
"startDate": "2019-12-20",
"endDate": "2019-12-30",
"reportType": "RECONCILIATION_REPORT",
"reportFormat" : "JSON",
"startFinancialCompletionDate" : "2019-12-20",
"endFinancialCompletionDate" : "2019-12-30",
"startReversalDate" : "2019-12-20",
"endReversalDate" : "2019-12-30"
}