Получение информации о количестве обработанных транзакций
Запрос
Запрос должен:
- иметь авторизацию типа Basic c вашим ID и секретным ключом PSP как имя пользователя и пароль соответственно;
- иметь заголовок
Content-Type, установленный какapplication/json; - иметь заголовок
Accept, установленный какapplication/json; - использовать кодировку UTF-8.
Отправьте POST запрос на {YOUR DWH URL}/api/v2/transactions/count со следующими параметрами:
| Параметр | Тип | Описание | Частичное совпадение |
|---|---|---|---|
| options | object | N/A | |
| time_zone | string | Часовой пояс в формате, как указан здесь, например, Europe/Vilnius.По умолчанию установлено Etc/UTC. Отправьте этот параметр, если ваш часовой пояс отличен от UTC+00:00 |
N/A |
| filter | object | N/A | |
| date_from * обязательный | string | Дата начала периода выборки транзакций в формате ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm или YYYY-MM-DDThh:mm:ss, например, 2024-01-24T23:13:39+03:00.Дата должна быть не ранее 90 дней до даты параметра date_to. Если в значении параметра указан часовой пояс, он должен быть таким же, как и в значении параметра options.time_zone. |
N/A |
| date_to * обязательный | string | Дата окончания периода выборки транзакций в формате ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm или YYYY-MM-DDThh:mm:ss, например, 2024-01-24T23:13:39+03:00.Дата должна быть не позднее 90 дней после даты параметра date_to. Если в значении параметра указан часовой пояс, он должен быть таким же, как и в значении параметра options.time_zone. |
N/A |
| date_type | string | Тип даты. Возможные значения: created_at - дата создания транзакции (установлено по умолчанию);paid_at - дата оплаты;updated_at - дата обновления данных транзакции. |
N/A |
| merchant_id | string | Строка идентификационных номеров торговцев, по которым необходимо подсчитать количество обработанных транзакций. Передается в виде строки с одним или несколькими значениями, разделенными запятыми. | N/A |
| shop_id | string | Строка идентификационных номеров магазинов, по которым необходимо подсчитать количество обработанных транзакций. Передается в виде строки с одним или несколькими значениями, разделенными запятыми. | N/A |
| uid | string (36) | Идентификатор транзакции. | + |
| description | string (1024) | Описание транзакции или заказа. | + |
| type | string | Типы транзакций, по которым необходимо подсчитать количество обработанных транзакций. Передается в виде строки с одним или несколькими значениями, разделенными запятыми. Возможные значения: authorization,payment,tokenization,payout,capture,void,refund,credit,chargeback. |
N/A |
| status | string | Статусы транзакций. Передается в виде строки с одним или несколькими значениями, разделенными запятыми. Возможные значения: successful,failed,incomplete,error,pending. |
N/A |
| amount | string | Сумма транзакции. Строка с одним или несколькими целочисленными значениями, разделенными запятыми. | N/A |
| currency | string | Валюта транзакции. Строка с одним или несколькими значениями, разделенными запятыми. Значения должны иметь формат ISO-4217, например, USD. |
N/A |
| test | boolean | По умолчанию, false. Если true, будут подсчитаны тестовые транзакции. |
N/A |
| code | string (7) | Код результата транзакции. | N/A |
| recurring_type | string | Тип рекуррентного платежа при оплате по сохраненным картам. Строка с одним или несколькими значениями, разделенными запятыми. Возможные значения: recurring,initial,null. |
N/A |
| fraud | string | Результат проверки безопасности. Возможные значения: reject - транзакция была отклонена, например, BIN карты находится в черном списке;review - транзакция проверяется поставщиком платежных услуг. |
N/A |
| tracking_id | string (500) | Идентификатор транзакции в системе торговца. | + |
| gateway_id | string | Идентификационный номер платежного шлюза, подключенного к магазину торговца. Строка с одним или несколькими целочисленными значениями, разделенными запятыми. | N/A |
| gateway_type | string | Название платежного шлюза, подключенного к магазину торговца. Строка с одним или несколькими значениями, разделенными запятыми. | N/A |
| gateway_agent_id | string | Идентификационный номер агента торговца. Строка с одним или несколькими значениями, разделенными запятыми. | N/A |
| shop_business_category_id | integer | Категория бизнеса магазина торговца. | N/A |
| provider_raw_rrn | string (64) | Номер операции в международной платёжной системе. ID транзакции, выданный сетью обработки карт. | + |
| provider_raw_ref_id | string (510) | Идентификатор транзакции в системе провайдера. | + |
| customer_id | string | ID покупателя в системе поставщика платежных услуг. | N/A |
| customer_ip | string (255) | IP адрес покупателя при проведении оплаты. | N/A |
| customer_full_name | string (255) | ФИО покупателя. | + |
| customer_phone | string (100) | Телефонный номер покупателя. | + |
| customer_email | string (255) | Email покупателя. | + |
| method_type | string | Платежный метод. Возможные значения: credit_card— карточный платеж,alternative — альтернативный способ оплаты. |
N/A |
| method_alternative_account | string (255) | Атрибут альтернативного платежного метода, например, номер счета. | N/A |
| credit_card_product | string (255) | Название бренда карты или карточного продукта. | N/A |
| credit_card_first_1 | string (1) | Первая цифра номера карты покупателя. | N/A |
| credit_card_bin | string (6) | Шестизначный банковский идентификационный номер. Первые 6 цифр номера карточки. | N/A |
| credit_card_bin_8 | string (8) | Восьмизначный банковский идентификационный номер. Первые 8 цифр номера карточки. | N/A |
| credit_card_last_4 | string (8) | Последние 4 цифры карты. | N/A |
| credit_card_holder | string (70) | Имя держателя карты. | + |
| credit_card_brand | string (60) | Бренд карты. | N/A |
| credit_card_sub_brand | string (60) | Кобренд карты. | N/A |
| credit_card_stamp | string (128) | Хэш карты. Постоянная величина, даже если дата окончания действия карты или владелец изменены. | N/A |
| credit_card_issuer_country | string (2) | Страна банка-эмитента в формате ISO 3166-1 alpha-2. | N/A |
| recipient_customer_id | string | ID получателя в системе поставщика платежных услуг. | N/A |
| recipient_customer_ip | string (255) | IP адрес получателя при проведении оплаты. | N/A |
| recipient_customer_full_name | string (255) | ФИО получателя. | + |
| recipient_customer_email | string (255) | Email получателя. | + |
| recipient_customer_phone | string (100) | Номер телефона получателя. | + |
| recipient_credit_card_product | string (255) | Название бренда карты получателя или карточного продукта получателя. | N/A |
| recipient_credit_card_first_1 | string (1) | Первая цифра номера карты получателя. | N/A |
| recipient_credit_card_bin | string (6) | Шестизначный банковский идентификационный номер. Первые 6 цифр номера карточки получателя. | N/A |
| recipient_credit_card_bin_8 | string (8) | Восьмизначный банковский идентификационный номер. Первые 8 цифр номера карточки получателя. | N/A |
| recipient_credit_card_last_4 | string (8) | Последние 4 цифры карты получателя. | N/A |
| recipient_credit_card_holder | string (70) | Имя держателя карты получателя. | + |
| recipient_credit_card_brand | string (60) | Бренд карты получателя. | N/A |
| recipient_credit_card_sub_brand | string (60) | Кобренд карты получателя. | N/A |
| recipient_credit_card_stamp | string (128) | Хэш карты получателя. Постоянная величина, даже если дата окончания действия карты или владелец изменены. | N/A |
| recipient_credit_card_issuer_country | string (2) | Страна банка-эмитента карты получателя в формате ISO 3166-1 alpha-2. | N/A |
Пример запроса
{ "filter": { "date_from": "2024-01-01T23:19:39+02:00", "date_to": "2024-01-02T23:19:39+02:00" }, "options": { "time_zone": "Europe/Vilnius" }}
Ответ
Ответ содержит следующие параметры:
| Параметр | Тип | Описание |
|---|---|---|
| data | object | Секция данных транзакций. |
| count * обязательный | integer | Количество транзакций, соответствующих параметрам запроса. |
Пример ответа{ "data": { "count": 1251 }}