Экспортировать список обработанных транзакций
Этот метод похож на запрос списка обработанных транзакций, но имеет более простую структуру параметра response_parameters и, следовательно, требует меньше времени для выполнения.
Основные отличия от запроса списка обработанных транзакций:
- Для запроса get list рекомендуемое количество транзакций в ответе (значение
option.limit) – 10–20. В данном запросе допускается использовать значение больше 100. - Отсутствие параметра
options.time_zone. Все даты в ответе имеют часовой пояс UTC. - Параметр
response_parametersимеет типstring. Filterподдерживает меньшее количество значений.- Если в
response_parametersуказанcommission, то запрос вернет детальную информацию о комиссиях, примененных к транзакции.
Запрос
Запрос должен:
- иметь авторизацию типа Basic c PSP ID и секретным ключом PSP как имя пользователя и пароль соответственно;
- иметь заголовок
Content-Type, установленный какapplication/json; - иметь заголовок
Accept, установленный какapplication/json; - использовать кодировку UTF-8.
Отправьте POST запрос на {YOUR DWH URL}/api/v2/transactions/export со следующими параметрами:
| Параметр | Тип | Описание |
|---|---|---|
| response_parameters | string | Список параметров транзакции, которые должны быть включены в ответ. Пример формата: "response_parameters": "main,shop,gateway".Больше информации здесь. |
| options | object | |
| limit | integer | Количество транзакций в ответе. Минимально допустимое значение: 1. Максимально допустимое значение: 1000. Значение по умолчанию: 100. |
| sort_order | string | Тип сортировки данных в ответе. Возможные значения: asc (самые недавние транзакции в конце списка) и desc (самые недавние транзакции в начале списка). По умолчанию asc. |
| filter | object | |
| date_from * обязательный | string | Дата начала периода выборки транзакций в формате ISO 8601 YYYY-MM-DDThh:mm:ss, например, 2024-01-25T23:13:39.Дата должна быть не ранее 90 дней до даты параметра date_to. В случае если количество транзакций в заданный период превышает установленный в запросе лимит, необходимо отправить повторный запрос, указав в этом поле значение параметра next_date из ответа на предыдущий запрос. |
| uid_from * условно обязательный | string | Параметр обязателен при отправке повторных запросов в случае, если количество транзакций с заданными параметрами больше установленного в запросе лимита. Значение должно равняться значению параметра next_uid из ответа на предыдущий запрос. |
| date_to * обязательный | string | Дата окончания периода выборки транзакций в формате ISO 8601 YYYY-MM-DDThh:mm:ss, например, 2024-01-25T23:13:39.Дата должна быть не позднее 90 дней после даты параметра date_from. |
| date_type | string | Тип даты. Возможные значения: created_at - дата создания транзакции (установлено по умолчанию);paid_at - дата оплаты;updated_at - дата обновления данных транзакции. |
| merchant_id | string | Строка идентификационных номеров торговцев, транзакции которых надо вернуть в ответе. Строка с одним или несколькими значениями, разделенными запятыми. |
| shop_id | string | Строка идентификационных номеров магазинов, транзакции которых надо вернуть в ответе. Строка с одним или несколькими значениями, разделенными запятыми. |
| type | string | Строка типов транзакций, данные по которым нужно получить в ответе. Строка с одним или несколькими значениями, разделенными запятыми. Возможные значения: authorization,payment,tokenization,payout,capture,void,refund,credit,chargeback. |
| test | boolean | По умолчанию, false. Если true, будут возвращены данные по тестовым транзакциям. |
| currency | string | Валюта транзакции. Строка с одним или несколькими значениями, разделенными запятыми. Значения должны иметь формат ISO-4217, например, USD. |
| gateway_id | string | Идентификационный номер платежного шлюза, подключенного к магазину торговца. Строка с одним или несколькими целочисленными значениями, разделенными запятыми. |
| method_type | string | Платежный метод. Возможные значения: credit_card— карточная транзакция,alternative — альтернативный способ оплаты. |
Пример запроса
{
"response_parameters": "main,gateway",
"filter": {
"date_from": "2024-06-19T00:00:00",
"date_to": "2024-06-30T00:02:00",
"date_type": "created_at",
"type": "payment",
"test": "false",
"currency": "EUR"
},
"options": {
"sort_direction": "desc",
"limit": 2
}
}
Группы параметров для response_parameters
Main: включает все корневые атрибуты транзакции, которые не являются вложенными объектами: amount, converted_amount, converted_currency, closed_at, code, created_at, currency, description, expired_at, fraud, friendly_message, language, manually_corrected_at, merchant_id, message, paid_at, parent_uid, product_id,psp_settled_at, reason, recurring_type, shop_id, settled_at, status, subscription_id, test, tracking_id, type, updated_at, uid.
Остальные группы – это корневые атрибуты транзакции, которые являются вложенными объектами. Если группа указана в response_parameters, то ответ будет включать и атрибуты, соответствующие указанной группе: shop, merchant, gateway, provider_raw, links, three_d_secure_verification, method, customer, recipient, be_protected_verification (устаревший сервис), smart_routing_verification, avs_cvc_verification, provider_response, additional_data, commission, adjustments.
Ответ
Пример ответа
{ "data": { "transactions": [ { "amount": 3000, "closed_at": null, "code": null, "converted_amount": null, "converted_currency": null, "created_at": "2024-06-28T14:21:12.792000Z", "currency": "EUR", "description": "description", "expired_at": "2025-01-01T14:00:00.000000Z", "fraud": null, "friendly_message": "Transaction was initialized.", "gateway": { "agent_id": null, "id": 4146, "note": null, "type": "SWPAlternative", "vendor": "beyag" }, "language": null, "manually_corrected_at": null, "merchant_id": 1245, "message": "Transaction was initialized.", "paid_at": null, "parent_uid": null, "product_id": null, "reason": null, "recurring_type": null, "settled_at": null, "shop_id": 1871, "status": "pending", "subscription_id": null, "test": false, "tracking_id": "9379992", "type": "payment", "uid": "4964ef24-82cb-4f66-99f7-5ae8fd2385f2", "updated_at": "2024-06-28T14:21:14.245000Z" }, { "amount": 3000, "closed_at": null, "code": null, "converted_amount": null, "converted_currency": null, "created_at": "2024-06-28T14:01:06.842000Z", "currency": "EUR", "description": "description", "expired_at": "2025-01-01T14:00:00.000000Z", "fraud": null, "friendly_message": "Transaction was initialized.", "gateway": { "agent_id": null, "id": 4146, "note": null, "type": "SWPAlternative", "vendor": "beyag" }, "language": null, "manually_corrected_at": null, "merchant_id": 1245, "message": "Transaction was initialized.", "paid_at": null, "parent_uid": null, "product_id": null, "reason": null, "recurring_type": null, "settled_at": null, "shop_id": 1871, "status": "pending", "subscription_id": null, "test": false, "tracking_id": "9379992", "type": "payment", "uid": "c64424f1-e65d-4ed7-95b7-0128ce329963", "updated_at": "2024-06-28T14:01:08.218000Z" } ], "pagination": { "date_from": "2024-06-28T14:21:12.792000Z", "date_to": "2024-06-28T14:01:06.842000Z", "date_type": "created_at", "has_next_page": true, "uid_from": "4964ef24-82cb-4f66-99f7-5ae8fd2385f2", "next_date": "2024-06-28T14:00:29.654000Z", "next_uid": "08d75a4e-6b17-4088-a9a2-81b10e93310a", "uid_to": "c64424f1-e65d-4ed7-95b7-0128ce329963" } }}
Параметры группы main
Эта группа параметров включает в себя все корневые параметры транзакции.
| Параметр | Тип | Описание |
|---|---|---|
| amount | bigInteger | Сумма транзакции. |
| code | string | Код обработки транзакции. |
| closed_at | datetime | Дата закрытия транзакции. |
| converted_amount | bigInteger | Сумма транзакции в целевой валюте в минимальных денежных единицах, сконвертированная сумма. Передается, если активирован сервис конвертера. |
| converted_currency | string | Целевая валюта в формате ISO-4217 alpha-3 code. Передается, если активирован сервис конвертера. |
| created_at | datetime | Дата создания транзакции в системе PSP. |
| currency | string | Валюта транзакции. Формат ISO-4217, например, USD, или код криптовалюты. |
| description | string | Описание транзакции. |
| expired_at | datetime | Время и дата окончания периода для возможного проведения оплаты по транзакции. |
| fraud | string | Результат проверки безопасности. Возможные значения: reject - транзакция была отклонена, например, BIN карты находится в черном списке;review - транзакция проверяется поставщиком платежных услуг. |
| friendly_message | string | Сообщение об обработке транзакции для покупателя. |
| language | string | Язык страницы оформления заказа. |
| manually_corrected_at | datetime | Дата ручной корректировки транзакции. |
| merchant_id | integer | Идентификационный номер торговца. |
| message | string | Сообщение об обработке транзакции для торговца. |
| paid_at | datetime | Время и дата проведения оплаты по транзакции. |
| parent_uid | string | Идентификатор родительской транзакции в системе поставщика платежных услуг. |
| product_ id | integer | Идентификатор плана подписки, соответствующей транзакции. |
| psp_settled_at | datetime | Дата и время расчета по транзакции между системой поставщика платежных услуг (PSP) и торговцем. |
| reason | string | Причина возврата. |
| recurring_type | string | Тип рекуррентного платежа при оплате по сохраненным картам. Возможные значения: recurring,initial,null,d_moto. |
| shop_id | integer | Идентификационный номер магазина |
| settled_at | datetime | Дата и время расчета по транзакции между эквайером и торговцем. |
| status | string | Статус транзакции. Возможные значения: successful,failed,incomplete,error,pending. |
| subscription_id | integer | Идентификатор подписки, соответствующей транзакции. |
| test | boolean | Если true, транзакция тестовая. |
| tracking_id | string | Идентификатор транзакции в системе торговца. |
| type | string | Тип транзакции. Возможные значения: authorization,payment,tokenization,payout,capture,void,refund,credit,chargeback. |
| updated_at | datetime | Дата последнего обновления транзакции в системе PSP. |
| uid | string | Идентификатор транзакции в системе поставщика платежных услуг (PSP). |
Параметры группы shop
Данные о магазине, в пользу которого была проведена транзакция.
Пример объекта shop
{ "shop": { "business_category_id": "5", "business_category_key": "it", "city": null, "company_name": "Demo Company", "contact_email": "demo_company@example.com", "contact_phone": "1234567890", "country": null, "created_at": "2024-08-05T10:54:08.201000Z", "enabled": true, "id": 1932, "legal_address": null, "mailing_address": null, "merchant_id": 1283, "name": "Demo", "postal_code": null, "psp_id": 1, "updated_at": "2025-03-26T10:46:16.933000Z", "url": "https://example.com" }}
| Параметр | Тип | Описание |
|---|---|---|
| business_category_id | string | Идентификатор категории бизнеса магазина. |
| business_category_key | string | Название категории бизнеса магазина. |
| city | string | Город, в котором зарегистрирован магазин. |
| company_name | string | Название компании магазина торговца. |
| contact_email | string | Контактный email компании магазина торговца. |
| contact_phone | string | Контактный телефон компании магазина торговца. |
| country | string | Страна регистрации магазина торговца. |
| created_at | datetime | Дата и время создания магазина торговца. |
| enabled | boolean | Если true, магазин активирован. |
| id | string | Идентификатор магазина торговца. |
| legal_address | string | Адрес регистрации магазина торговца. |
| mailing_address | string | Почтовый адрес магазина торговца. |
| merchant_id | string | Идентификатор торговца. |
| name | string | Название магазина. |
| postal_code | string | Индекс компании магазина торговца. |
| psp_id | integer | Идентификатор поставщика платёжных услуг (PSP), в системе которого создан магазин. |
| updated_at | datetime | Дата и время последнего обновления магазина торговца. |
| url | string | URL магазина торговца. |
Параметры группы merchant
Данные о торговце, в пользу которого была проведена транзакция.
Пример объекта merchant
{ "merchant": { "bank_id": 1854, "city": "Vilnius", "company_name": "Demo Tests", "country": "LT", "created_at": "2023-11-30T12:35:39.928000Z", "email": "demo-test@example.com", "enabled": true, "id": 1253, "legal_address": null, "name": "Demo Shop", "postal_code": null, "psp_id": 1, "updated_at": "2025-02-12T07:19:41.112000Z" }}
| Параметр | Тип | Описание |
|---|---|---|
| bank_id | integer | Идентификатор банка торговца. |
| city | string | Город регистрации компании торговца. |
| company_name | string | Город регистрации компании торговца. |
| country | string | Страна регистрации компании торговца в формате ISO 3166-1 alpha-2. |
| created_at | datetime | Дата и время создания торговца. |
| string | Адрес электронной почты торговца. Используется как логин для входа в личный кабинет торговца. |
|
| enabled | boolean | Если true, учетная запись торговца активна. |
| id | integer | Идентификатор торговца в системе поставщика платёжных услуг. |
| legal_address | string | Адрес регистрации компании торговца. |
| name | string | Название торговца. |
| postal_code | string | Почтовый код компании торговца. |
| psp_id | integer | Идентификатор поставщика платёжных услуг (PSP), в системе которого создан торговец. |
| updated_at | datetime | Дата и время последнего обновления учетной записи торговца. |
Параметры группы gateway
Данные о шлюзе/банке, использованном для обработки транзакции.
Пример объекта gateway
{
"gateway": {
"agent_id": 1058,
"connection_type": null,
"id": 5102,
"note": null,
"type": "BankTransfer",
"vendor": "beyag"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| agent_id | integer | Идентификатор агента. |
| connection_type | string | Тип подключения шлюза. Значение поля Тип подключения в настройках шлюза. Как правило, содержит ключевые слова, используемые для группировки данных в бухгалтерских отчетах. |
| id | integer | Идентификатор шлюза. |
| note | string | Значение поля Заметки в настройках шлюза. |
| type | string | Тип шлюза; название процессора/эквайера. |
| vendor | string | Тип шлюза. Возможные значения: gateway для карточных шлюзов,beyag для шлюзов альтернативных способов оплаты. |
Параметры группы provider_raw
Параметры, полученные от эквайера.
Пример объекта provider_raw
{
"provider_raw": {
"amount": 4294,
"auth_code": "654321",
"bank_code": "05",
"currency": "EUR",
"dynamic_billing_descriptor": "TEST GATEWAY BILLING DESCRIPTOR",
"message": "Payment was approved",
"ref_id": "777888",
"rrn": "999",
"status": "successful"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| amount | bigInteger | Сумма транзакции в системе провайдера. |
| auth_code | string | Код авторизации провайдера. |
| bank_code | string | Код результата транзакции в системе провайдера. |
| currency | string | Валюта транзакции в системе провайдера. |
| dynamic_billing_descriptor | string | Описание результата транзакции в системе провайдера. |
| message | string | Сообщение с результатом транзакции в системе провайдера. |
| ref_id | string | Идентификатор транзакции в системе провайдера. |
| rrn | string | Номер операции в международной платёжной системе. ID транзакции, выданный сетью обработки карт. |
| status | string | Статус транзакции в системе провайдера. |
Параметры группы links
Контейнер ссылок, связанных с обработкой транзакции.
Пример объекта links
{
"links": {
"notification_url": null,
"receipt_url": "{backoffice_url}/customer/transactions/caeb055b-de38-4b8d-abcb-cb5c80388ec9/c03548f824b64d2b3aa8bd71835de556e68448ee719bb03e99d7dd1b8b21ec91?language=en",
"redirect_url": "{gateway_url}/process/caeb055b-de38-4b8d-abcb-cb5c80388ec9",
"return_url": null
}
}
| Параметр | Тип | Описание |
|---|---|---|
| notification_url | string | URL, на который отправляются автоматические уведомления. |
| receipt_url | string | Ссылка на чек в формате PDF. |
| redirect_url | string | URL страницы для завершения транзакции. |
| return_url | string | URL на стороне торговца, на который покупатель будет перенаправлен после завершения оплаты или 3-D Secure проверки. |
Параметры группы three_d_secure_verification
Данные о результатах 3-D Secure проверки транзакции.
Пример объекта three_d_secure_verification
{
"three_d_secure_verification": {
"acs_url": null,
"cavv": "AJkBCHWHCAAAACcQkzEgdThBmSg=",
"cavv_algorithm": null,
"creq": null,
"eci": "05",
"fail_reason": null,
"md": null,
"message": "Authentication Successful",
"method_process_url": null,
"pa_req": null,
"pa_res_url": "{gateway_url}/process/337fdd84-afea-4dba-8363-4182ea33e80c",
"pa_status": "Y",
"status": "successful",
"ve_status": "Y",
"xid": "fc4d08fd-3939-4a3a-884a-54c111621c69"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| acs_url | string | URL c ACS формой в системе эмитента карты, куда покупатель перенаправляется для завершения 3-D Secure аутентификации. |
| cavv | string | Cardholder Authentication Verification Value (только если владелец карты был успешно аутентифицирован). |
| cavv_algorithm | string | CAVV алгоритм, использованный для генерации значения CAVV. |
| creq | string | Запрос на аутентификацию 3-D Secure. |
| eci | string or integer | Electronic Commerce Indicator. Предоставляет информацию об уровне защиты от запросов на возврат платежей владельцев карт или их банков. |
| fail_reason | string | Незашифрованное сообщение о причине непрохождения 3-D Secure аутентификации. |
| md | string | Идентификатор транзакции, используемый для связи между сервером торговца и сервером банка-эмитента. |
| message | string | Сообщение о статусе аутентификации 3-D Secure. |
| method_process_url | string | URL для дополнительной проверки на основе данных браузера. |
| pa_req | string | Зашифрованный запрос на аутентификацию держателя карты. |
| pa_res_url | string | URL, на который сервер банка-эмитента отправляет ответ на запрос аутентификации транзакции. |
| pa_status | string | Статус аутентификации транзакции в протоколе 3-D Secure. |
| status | string | Статус аутентификации 3-D Secure. |
| ve_status | string | Verification Enrollment Status, указывает, зарегистрирован ли держатель карты в программе 3-D Secure. |
| xid | string | Уникальный идентификатор 3-D Secure аутентификации. |
Параметры группы method
Данные платежного метода.
Пример объекта method
{
"method": {
"credit_card": {
"bin": "427870",
"bin_8": "42787017",
"brand": "visa",
"exp_month": 4,
"exp_year": 2025,
"first_1": "4",
"holder": "John Doe",
"issuer_bank": "OPEN JOINT-STOCK COMPANY BANK",
"issuer_country": "LT",
"last_4": "0042",
"product": "L",
"stamp": "0259b6e0ca06ab0170efdfbc1b230b57d839112d6fbe6fef2a73670f553e49f2",
"sub_brand": null,
"token": null,
"token_provider": null
},
"type": "credit_card"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| credit_card | object | Данные карты, использованной для оплаты. Объект не передается, если для транзакции использовался альтернативный способ оплаты. |
| bin | string | Шестизначный банковский идентификационный номер. Первые 6 цифр номера карточки. |
| bin_8 | string | Восьмизначный банковский идентификационный номер. Первые 8 цифр номера карточки. |
| brand | string | Бренд карты. |
| exp_month | integer | Месяц окончания срока действия карты. |
| exp_year | integer | Год окончания срока действия карты. |
| first_1 | string | Первая цифра номера карты. |
| holder | string | Имя держателя карты. |
| issuer_bank | string | Название банка-эмитента. |
| issuer_country | string | Страна банка-эмитента в формате ISO 3166-1 alpha-2. |
| last_4 | string | Последние 4 цифры номера карты. |
| product | string | Название бренда карты или карточного продукта. |
| stamp | string | Хэш карты. Постоянная величина, даже если дата окончания действия карты или владелец изменены. |
| sub_brand | string | Кобренд карточки. |
| token | string | Токен карты. |
| token_provider | string | Провайдер токена, например, apple_pay. |
| type | string | Способ оплаты. Например, credit_card или alternative. |
| alternative_account | string | Атрибут платежного метода на стороне альтернативной интеграции, например, номер счета. Параметр передается, если для транзакции использовался альтернативный способ оплаты. |
| alternative_type | string | Атрибут платежного метода на стороне альтернативной интеграции, например, тип запроса. Параметр передается, если для транзакции использовался альтернативный способ оплаты. |
| alternative_payment_info | string | Исходные данные по данному альтернативному способу оплаты. Параметр передается, если для транзакции использовался альтернативный способ оплаты. |
Параметры группы customer
Параметры c данными покупателя.
Пример объекта customer
{
"customer": {
"address": "77195 Wayne Village",
"birth_date": null,
"city": "South Robert",
"country": "US",
"device_id": null,
"email": "booker@example.com",
"first_name": "Maren",
"full_name": "Maren Lehner",
"gender": null,
"id": "66d25c97-21ce-4a0d-b697-c83e3c7a4cc3",
"ip": "143.241.100.223",
"last_name": "Lehner",
"middle_name": "",
"phone": null,
"state": "IA",
"taxpayer_id": null,
"zip": "36053"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| address | string | Адрес покупателя. |
| birth_date | string | Дата рождения покупателя. |
| city | string | Город покупателя. |
| country | string | Страна покупателя. |
| device_id | string | Идентификатор устройства, используемого для совершения транзакции. |
| string | Email покупателя. | |
| first_name | string | Имя покупателя. |
| full_name | string | ФИО покупателя. |
| gender | string | Пол покупателя. |
| id | string | Идентификатор покупателя в системе поставщика платежных услуг. |
| ip | string | IP адрес покупателя при проведении оплаты. |
| last_name | string | Фамилия покупателя. |
| middle_name | string | Отчество покупателя. |
| phone | string | Номер телефона покупателя. |
| state | string | Штат или область покупателя. |
| taxpayer_id | string | Идентификационный номер налогоплательщика (ИНН), присвоенный покупателю. |
| zip | string | Почтовый индекс покупателя. |
Параметры группы recipient
Данные получателя перевода.
Пример объекта recipient
{
"recipient": {
"customer": {
"address": null,
"birth_date": null,
"city": null,
"country": null,
"device_id": null,
"email": null,
"first_name": null,
"full_name": " ",
"gender": null,
"id": null,
"ip": null,
"last_name": null,
"middle_name": "",
"phone": null,
"state": null,
"taxpayer_id": null,
"zip": null
},
"method": {
"credit_card": {
"bin": "464990",
"bin_8": "46499012",
"brand": "visa",
"exp_month": null,
"exp_year": null,
"first_1": "4",
"holder": "HOLDER NAME",
"issuer_bank": null,
"issuer_country": null,
"last_4": "8633",
"product": null,
"stamp": "aec63aefac94d99de0bbdb1298459f374fe9452ce199bdce27ef7fd03cb3c957",
"sub_brand": null,
"token": null,
"token_provider": null
},
"type": "credit_card"
}
}
}
| Параметр | Тип | Описание |
|---|---|---|
| customer | object | Информация о получателе перевода. Параметры объекта совпадают с группой параметров customer. |
| method | object | Информация о карте, использованной для перевода. Параметры объекта совпадают с группой параметров method. |
Параметры группы smart_routing_verification
Данные проверки транзакции сервисом Умной Маршрутизации (Smart Routing).
Пример объекта smart_routing_verification
{
"smart_routing_verification": {
"data": {
"action_rules": {
"Merchant_318879_Demo": {},
"Psp_39_Demo": {
"cashback": {
"Special offers for cashback cards": "skipped"
},
"fraudulent_cards": {
"PAN name is in fraud list": "passed"
}
},
"Shop_569_Demo_shop": {
"Force 3D": {
"Force 3D": "force_3ds"
},
"1_rule_MASTERCARD": {
"1_rule_MASTERCARD": "skipped"
},
"Max transaction amount - 10 000 USD": {
"Max transaction amount - 10 000 USD": "passed"
}
}
},
"force_3ds": true,
"matched_actions": {
"force_3ds": [
{
"account": "Shop_569_Demo_shop",
"alias": "Force 3D",
"description": "Force 3D"
}
],
"passed": [
{
"account": "Shop_569_Demo_shop",
"alias": "Max transaction amount - 10 000 USD",
"description": "Max transaction amount - 10 000 USD"
},
{
"account": "Psp_39_Demo",
"alias": "fraudulent_cards",
"description": "PAN name is in fraud list"
}
],
"skipped": [
{
"account": "Shop_569_Demo_shop",
"alias": "1_rule_MASTERCARD",
"description": "1_rule_MASTERCARD"
},
{
"account": "Psp_39_Demo",
"alias": "cashback",
"description": "Special offers for cashback cards"
}
]
},
"object": "1067",
"object_defined_via": "allowed objects",
"object_flows": [
{
"name": "Shop_5655",
"rules": [
{
"alias": "rule_1",
"description": "Allow cards from the list",
"error_code": "rule_inactive",
"error_message": "Rule is inactive",
"state": "skipped"
}
],
"skipped": false,
"system": false
},
{
"name": "name",
"rules": [
{
"alias": "rule 2",
"description": "rule 2",
"state": "not_matched",
"use_only_these_objects": true
}
],
"skipped": false,
"system": false
}
],
"object_name": "gw_1067",
"status": "passed",
"wb_lists": {
"psp_black_list": "not_matched",
"psp_white_list": "not_matched"
}
},
"status": "successful"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| status | string | Статус проверки транзакции правилами сервиса Умной Маршрутизации. Возможные значения:successful - проверка пройдена;failed - проверка не пройдена. |
| data | object | Секция с детальными данными о проверке транзакции правилами сервиса Умная Маршрутизация. |
| status | string | Общий статус проверки. Возможные значения: rejected - транзакция была отклонена в результате правила типа действие с действием Отклонить, или параметры транзакции находятся в черном списке;passed - во всех остальных случаях. |
| object | string | ID шлюза, на который была отправлена транзакция; null - если все доступные шлюзы были исключены в результате проверок. |
| object_name | string | Имя шлюза, на который была отправлена транзакция. |
| object_flows | array | Массив потоков типа объект, по которым проводилась проверка транзакции. Каждый объект содержит следующие параметры:name - имя потока;system - тип правила (true, если правило системное, в противном случае false);skipped - статус выполнения потока (true, если проверка по потоку пропущена, в противном случае false);rules - массив правил этого потока. |
| rules | array | Массив объектов, каждый из которых соответствует определенному правилу. |
| alias | string | Название правила. |
| state | string | Результат проверки по правилу. |
| description | string | Описание правила. |
| error_message | string | Сообщение об ошибке. |
| error_code | string | Код ошибки. Возможные значения: precondition_failed - предусловие не выполнено;rule_inactive - правило не активно;rule_unprocessable - правило еще не готово к использованию, например, было только что обновлено, маловероятная ошибка;allowed_objects_mismatch - в результате проверки по правилу, был выбран шлюз, который к моменту обработки этим правилом уже не был доступен;data_mismatch - ошибка для агрегационных правил, если транзакция не удовлетворяет условиям правила, то транзакция не участвует в агрегации;not_enough_data - не хватает данных для проверки условий. |
| object_defined_via | string | Способ, которым был выбран шлюз для транзакции. Возможные значения: allowed objects - по результатам проверок, не был выбран конкретный шлюз, транзакция была отправлена на один из доступных шлюзов, выбранного случайным образом либо по очереди в зависимости от настроек сервиса Умная Маршрутизация;rule - шлюз был выбран в результате проверки транзакции правилом. |
| action_rules | object | Секция с информацией о прохождении правил типа действие. |
| {account_name} | object | Секция с детальной информации о правилах учетной записи, на уровне которой было создано правило. Названия учетных записей уровня PSP, торговца и магазина имеют форматы PSP_{psp_id}_{psp_name}, Merchant_{merchant_id}_{merchant_name}, Shop_{shop_id}_{shop_name} соответственно. |
| {flow_name} | object | Секция с детальной информации о потоке, в рамках которого было создано правило. |
| {rule_name} | object | Статус проверки транзакции по правилу. Название параметра совпадает с названием правила. Возможные значения: passed - проверка выполнена, транзакция не соответствует условиям правила;skipped - проверка по правилу не выполнена, например, параметр из условия правила имеет значение null, или параметры транзакции в белом списке;allow - проверка по правилу выполнена, по результатам правила транзакция допущена к последующим проверкам;skip 3DS - по результатам проверки, для транзакции не будет выполняться верификация 3D-Secure;notify - по результатам проверки транзакции было выслано уведомление, например, о приближении к пороговому значению лимита;review - в результате проверки транзакция была помечена как подозрительная, транзакция была добавлена в отчет по подозрительным транзакциям, и, если в настройках магазина был указан anti-fraud email, то на этот адрес было отправлено уведомление;reject - транзакция была отклонена. |
| matched_actions | object | Секция со списком действий, которые были применены к транзакции. |
| {действие} | array | Массив правил, после проверок по которым было применено действие. Секция каждого правила включает в себя название (alias), описание (description), учетную запись правила(account), а также (только в случае действия notify) пороговый процент лимита, по достижении которого было выслано уведомление (breached_threshold). |
| wb_lists | object | Секция черных и белых списков, проверка по которым проводилась по транзакции. Если параметры транзакции не указаны в списках, то значение параметра с именем соответствующего списка будет not_matched. В противном случае, matched. |
Параметры группы avs_cvc_verification
Данные о результатах AVS/CVC проверки транзакции.
Пример объекта avs_cvc_verification
{
"avs_cvc_verification": {
"avs_verification": {
"result_code": "1"
},
"cvc_verification": {
"result_code": "1"
}
}
}
| Параметр | Тип | Описание |
|---|---|---|
| avs_verification | object | Секция с результатами AVS проверки. |
| result_code | string | Код результата AVS проверки. |
| cvc_verification | object | Секция с результатами CVC проверки. |
| result_code | string | Код результата CVC проверки. |
Параметры группы provider_response
Исходный ответ от провайдера. Возвращается для отдельных провайдеров.
Параметры группы additional_data
Секция additional_data из ответа на запрос транзакции.
Параметры группы adjustments
Данные о корректировке первоначальной суммы транзакции.
Пример объекта adjustments
{
"adjustments": {
"adjustment_amount": 0,
"initial_amount": 100,
"surcharge_info": {
"amount": null,
"currency": "USD",
"id": "dfc4625f-262c-4b4b-9e6d-17cb727733ba",
"initial_amount": 100,
"type": "surcharge_max"
}
}
}
| Параметр | Тип | Описание |
|---|---|---|
| adjustment_amount | bigInteger | Сумма корректировки транзакции. Итоговая сумма транзакции, списанная с покупателя – это сумма initial_amount и adjustment_amount. |
| initial_amount | bigInteger | Начальная сумма транзакции до применения верхних комиссий, в минимальных денежных единицах. |
| surcharge_info | object | Секция с информацией о примененных верхних комиссиях. |
| amount | bigInteger | Сумма верхних комиссий, примененная к транзакции, в минимальных денежных единицах. |
| currency | string | Валюта верхних комиссий в формате ISO-4217 alpha-3 code или код криптовалюты. Например, USD. |
| id | string | Идентификатор верхней комиссии. |
| initial_amount | bigInteger | Начальная сумма транзакции до применения верхних комиссий, в минимальных денежных единицах. |
| type | string | Тип корректировки. Возможные значения: surcharge_max (верхние комиссии). |
Параметры группы commission
Секция данных комиссий и примененных ставок по транзакции. Все абсолютные значения – это округленные значения в минимальных денежных единицах. Объект передается в ответе только при соблюдении следующих условий:
- транзакция не тестовая;
- транзакция имеет один следующих типов: authorization, capture, void, payment, payout, refund, chargeback, p2p;
- транзакция имеет финальный статус (successful или failed);
- для транзакции были рассчитаны комиссии в системе DWH.
Пример секции commission
{
"commission": {
"bank_commission": 0,
"currency": "EUR",
"pay_to_merchant": 187,
"psp_commission": 15,
"rates": {
"bank_fee": 0,
"bank_max_commission": 0,
"bank_min_commission": 0,
"bank_rate": "0.00",
"id": "16c91a17-2cdf-4bb7-9496-8778c79bca32",
"psp_fee": 15,
"psp_max_commission": 0,
"psp_min_commission": 0,
"psp_rate": "0.00",
"rolling_reserve_days": 0,
"rolling_reserve_rate": "0.00"
},
"rolling_reserve_amount": null,
"transaction_commission": 15,
"transaction_fee": 15,
"transaction_rate": "0.00",
"transaction_rate_amount": 0
}
}
| Параметр | Тип | Описание |
|---|---|---|
| currency | string (4) | Валюта ставок и комиссий. |
| transaction_commission | integer | Общая сумма комиссий эквайера и PSP, примененная к транзакции в валюте транзакции, в минимальных денежных единицах. Без учета страховых депозитов. Соответствует параметру "Сумма комиссий" в отчете в личном кабинете. |
| transaction_fee | integer | Общее значение фиксированной ставки, примененной к транзакции, в минимальных денежных единицах. При пересчете в основные денежные единицы соответствует параметру "Комиссия за транзакцию" в отчете в личном кабинете. |
| transaction_rate_amount | integer | Сумма комиссии PSP и эквайера по процентным ставкам, примененной к транзакции, в минимальных денежных единицах. |
| transaction_rate | float (3,2) | Общее значение процентной ставки, примененной к транзакции. Соответствует параметру "Комиссия, %" в отчете в личном кабинете. |
| rolling_reserve_amount | integer | Сумма страхового депозита, в минимальных денежных единицах. |
| pay_to_merchant | bigInteger | Сумма к выплате торговцу (за вычетом комиссий эквайера, PSP и страховых депозитов) в минимальных денежных единицах. |
| psp_commission | integer | Общая сумма комиссии PSP (фиксированная + сумма по проценту), примененной к транзакции, в минимальных денежных единицах. |
| bank_commission | integer | Общая сумма комиссии эквайера (фиксированная + сумма по проценту), примененной к транзакции, в минимальных денежных единицаx. |
| rates | object | Секция примененных к транзакции ставок. Зависит от типа и статуса транзакции. |
| id | uid | Идентификатор набора ставок, примененных к транзакции, идентификатор ставок, применяемых к шлюзу/ валюте и использованных для расчета комиссии. |
| psp_fee | integer | Фиксированная ставка комиссии PSP за данный тип и данный статус транзакции, в минимальных денежных единицах. |
| psp_rate | float (3,2) | Процент от суммы, взимаемый PSP за транзакцию данного типа с данным статусом. |
| psp_min_commission | integer | Минимальная фиксированная комиссия PSP по процентной ставке за транзакцию данного типа с данным статусом, в минимальных денежных единицах. |
| psp_max_commission | integer | Максимальная фиксированная комиссия PSP по процентной ставке за транзакцию данного типа с данным статусом, в минимальных денежных единицах. |
| bank_fee | integer | Фиксированная ставка комиссии эквайера за транзакцию данного типа с данным статусом, в минимальных денежных единицах. |
| bank_rate | float (3,2) | Процент от суммы, взимаемый эквайером за транзакцию данного типа с данным статусом. |
| bank_min_commission | integer | Минимальная фиксированная комиссия эквайера по процентной ставке за транзакцию данного типа с данным статусом, в минимальных денежных единицах. |
| bank_max_commission | integer | Максимальная фиксированная комиссия эквайера по процентной ставке за транзакцию данного типа с данным статусом, в минимальных денежных единицах. |
| rolling_reserve_rate | float (3,2) | Процент ставки страхового депозита. |
| rolling_reserve_days | integer | Период действия страхового депозита в днях. |