Получение информации о количестве обработанных транзакций

Warning

Версия DWH v.1 не поддерживается и в скором времени будет отключена. Пожалуйста, используйте запросы DWH v.2.

Для получения информации о количестве обработанных транзакций можно воспользоваться следующими типами запросов:

GET запрос;
POST запрос: используйте данный тип запроса, если количество символов URL HTTP GET запроса с параметрами фильтра превышает максимально допустимое значение;
POST запрос (устаревшая версия): фильтр данных возможен только по дате, статусу транзакции и способу оплаты.

GET запрос

Запрос

Запрос должен:

иметь авторизацию типа Basic c вашим ID и секретным ключом PSP как имя пользователя и пароль соответственно;
иметь заголовок Content-Type, установленный как application/json;
иметь заголовок Accept, установленный как application/json;
использовать кодировку UTF-8.

Отправьте GET запрос на {YOUR DWH URL}/api/v1/transactions со следующими параметрами:

Параметр	Тип	Описание
response_type * обязательный	string	Тип информации в ответе. Для получения количества транзакций передайте `count`.
date_from * обязательный	string	Дата начала периода выборки транзакций в формате `YYYY-MM-DD hh:mm:ss`, например, `2020-01-01 12:00:00`. Дата должна быть не ранее 90 дней до даты параметра `date_to`.
date_to * обязательный	string	Дата окончания периода выборки транзакций в формате `YYYY-MM-DD hh:mm:ss`, например, `2020-01-01 12:00:00`. Дата должна быть не поздее 90 дней после даты параметра `date_from`.
date_type	string	Тип даты. Возможные значения: `created_at` - дата создания транзакции (установлено по умолчанию); `paid_at` - дата оплаты; `settled_at` - дата клиринга платежа; `updated_at` - дата обновления данных транзакции; `manually_corrected_at` - дата ручной корректировки транзакции.
time_zone	string	Часовой пояс, в котором необходимо интерпретировать даты начала и конца выборки транзакций в запросе и в котором будут указаны даты обработки транзакций в ответе в формате, как описан здесь, например, `Europe/London`. По умолчанию используется `Etc/UTC`.
merchant_id	string	Строка идентификационных номеров торговцев, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Не использовать при передаче параметра `shop_id`.
shop_id	string	Строка идентификационных номеров магазинов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Не использовать при передаче параметра `merchant_id`.
gateway_id	string	Строка идентификационных номеров платежных шлюзов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций.
transaction_type	string	Строка типов транзакций, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Возможные значения: `authorization`, `payment`, `tokenization`, `payout`, `capture`, `void`, `refund`, `credit`, `chargeback`.
payment_method_type	string	Строка методов оплаты, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Возможные значения: `credit_card` - методы оплаты картами, `alternative` - альтернативные, некарточные платежные методы.
status	string	Строка статусов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Возможные значения: `successful`, `failed`, `incomplete`, `error`, `pending`.
currency	string	Строка валют платежа, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, указанных в формате ISO-4217, например, `USD`.
brand	string	Строка способов оплаты и платежных брендов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, например, `visa`.
agent_id	string	Строка идентификационных номеров агентов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций.
token_provider	string	Строка провайдеров токенов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, например, `apple_pay`.
merchant_country	string	Строка стран регистрации торговцев, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, в формате ISO 3166-1 alpha-2.
gateway_type	string	Строка названий эквайеров, разделенных запятыми, по платежным шлюзам которых необходимо подсчитать количество обработанных транзакций, например, `Bogus`

Пример запроса

curl -v "{YOUR DWH URL}/api/v1/transactions?response_type=count&date_type=created_at&date_from=2020-06-06 10:30:25&date_to=2020-07-06 00:00:00&gateway_type=Bogus,InvestBank" \
    -H "Authorization: Basic MTpwc3BfMV9rZXk=" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Ответ

Ответ содержит следующие параметры:

Параметр	Тип	Описание
data	object	Секция данных транзакций.
count * обязательный	integer	Количество транзакций, соответствующих параметрам запроса.

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

{
    "data": {
        "count": 18298
    }
}

POST запрос

Запрос

Запрос должен:

иметь авторизацию типа Basic c вашим ID и секретным ключом PSP как имя пользователя и пароль соответственно;
иметь заголовок Content-Type, установленный как application/json;
иметь заголовок Accept, установленный как application/json;
использовать кодировку UTF-8.

Отправьте POST запрос на {YOUR DWH URL}/api/v1/transactions со следующими параметрами:

Параметр	Тип	Описание
response_type * обязательный	string	Тип информации в ответе. Для получения количества транзакций передайте `count`.
date_from * обязательный	string	Дата начала периода выборки транзакций в формате `YYYY-MM-DD hh:mm:ss`, например, `2020-01-01 12:00:00`. Дата должна быть не ранее 90 дней до даты параметра `date_to`.
date_to * обязательный	string	Дата окончания периода выборки транзакций в формате `YYYY-MM-DD hh:mm:ss`, например, `2020-01-01 12:00:00`. Дата должна быть не позднее 90 дней после даты параметра `date_to`.
date_type	string	Тип даты. Возможные значения: `created_at` - дата создания транзакции (установлено по умолчанию); `paid_at` - дата оплаты; `settled_at` - дата клиринга платежа; `updated_at` - дата обновления данных транзакции; `manually_corrected_at` - дата ручной корректировки транзакции.
time_zone	string	Часовой пояс, в котором необходимо интерпретировать даты начала и конца выборки транзакций в запросе и в котором будут указаны даты обработки транзакций в ответе в формате, как указан здесь, например, `Europe/London`. По умолчанию используется `Etc/UTC`.
merchant_id	string	Строка идентификационных номеров торговцев, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Не использовать при передаче параметра `shop_id`.
shop_id	string	Строка идентификационных номеров магазинов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Не использовать при передаче параметра `merchant_id`.
gateway_id	string	Строка идентификационных номеров платежных шлюзов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций.
transaction_type	string	Строка типов транзакций, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Возможные значения: `authorization`, `payment`, `tokenization`, `payout`, `capture`, `void`, `refund`, `credit`, `chargeback`.
payment_method_type	string	Строка методов оплаты, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Возможные значения: `credit_card` - методы оплаты картами, `alternative` - альтернативные, некарточные платежные методы.
status	string	Строка статусов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций. Возможные значения: `successful`, `failed`, `incomplete`, `error`, `pending`.
currency	string	Строка валют платежа, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, указанных в формате ISO-4217, например, `USD`.
brand	string	Строка способов оплаты и платежных брендов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, например, `visa`.
agent_id	string	Строка идентификационных номеров агентов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций.
token_provider	string	Строка провайдеров токенов, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, например, `apple_pay`.
merchant_country	string	Строка стран регистрации торговцев, разделенных запятыми, по которым необходимо подсчитать количество обработанных транзакций, в формате ISO 3166-1 alpha-2.
gateway_type	string	Строка названий эквайеров, разделенных запятыми, по платежным шлюзам которых необходимо подсчитать количество обработанных транзакций, например, `Bogus`.

Пример запроса

{
    "response_type":"count",
    "date_type":"created_at",
    "date_from":"2022-06-06 10:30:25",
    "date_to":"2022-08-10 21:00:00",
    "gateway_type":"Bogus",
    "status":"successful,failed",
    "currency":"EUR,USD"
}

Ответ

Ответ содержит следующие параметры:

Параметр	Тип	Описание
data	object	Секция данных транзакций.
count * обязательный	integer	Количество транзакций, соответствующих параметрам запроса.

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

{
    "data": {
        "count": 1251
    }
}

POST запрос (устаревшая версия)

Запрос

Запрос должен:

иметь авторизацию типа Basic c x как имя пользователя и вашим секретным ключом PSP;
передавать параметры в JSON, XML форматах или как данные HTML-формы;
иметь заголовок Content-Type, установленный как application/json или application/xml в зависимости от формата тела запроса;
иметь заголовок Accept, установленный как application/json или application/xml в зависимости от предпочитаемого формата ответа;
использовать кодировку UTF-8.

Отправьте POST запрос на {YOUR_BACKOFFICE_URL}/api/psp/reports/count со следующими параметрами:

Параметр	Тип	Описание
report_params	object	Секция данных транзакций.
date_type * обязательный	string	Тип даты. Возможные значения: `created_at` - дата создания транзакции; `paid_at` - дата оплаты; `settled_at` - дата клиринга платежа.
from * обязательный	string	Дата начала запрашиваемого периода отчёта в формате `YYYY-MM-DD hh:mm:ss`, например, `2020-01-01 12:00:00`.
to * обязательный	string	Дата конца запрашиваемого периода отчёта в формате `YYYY-MM-DD hh:mm:ss`, например, `2020-01-01 15:00:00`.
status * обязательный	string	Статус транзакции. Возможные значения: `all`, `successful`, `failed`, `pending`, `incomplete`.
payment_method_type * обязательный	string	Способ оплаты. Возможные значения: `credit_card` - карточные платежные методы; `alternative` - некарточные, альтернативные платежные методы.
time_zone * обязательный	string	Часовой пояс, в котором требуется указать даты обработки транзакций в ответе в формате, как указан здесь, например, `Europe/London`.

Пример запроса

{
  "report_params": {
    "date_type":"created_at",
    "from":"2022-01-25 00:00:00",
    "to":"2022-01-27 23:59:59",
    "status":"successful",
    "payment_method_type":"credit_card",
    "time_zone":"Etc/UTC"
  }
}

Ответ

Ответ содержит следующие параметры:

Параметр	Тип	Описание
transactions	object	Секция данных транзакций.
count * обязательный	integer	Количество транзакций, соответствующий параметрам запроса.

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

{
    "transactions": {
        "count": 17
    }
}