Получение списка обработанных транзакций
Запрос
Запрос должен:
- иметь авторизацию типа Basic c вашим ID и секретным ключом PSP как имя пользователя и пароль соответственно;
- иметь заголовок
Content-Type, установленный какapplication/json; - иметь заголовок
Accept, установленный какapplication/json; - использовать кодировку UTF-8.
Отправьте POST запрос на {YOUR DWH URL}/api/v2/transactions/list со следующими параметрами:
Warning
Обратите внимание, что максимальное количество транзакций в ответе – 1000 (если параметр options.limit не был отправлен в запросе, максимальное количество транзакций по умолчанию – 100). Если транзакций, соответствующих критериям запроса больше, отправьте повторный запрос, используя в фильтре значения параметров из секции pagination в ответе на предыдущий запрос. Больше информации и пример повторного запроса здесь.
| Параметр | Тип | Описание | Частичное совпадение |
|---|---|---|---|
| response_parameters | GraphQL query | Список параметров транзакции, которые должны быть включены в ответ. Пример формата: "response_parameters": "query {transactions {uid status description}}".Возможные значения указаны в таблице ниже. |
N/A |
| options | object | N/A | |
| limit | integer | Количество транзакций в ответе. Минимально допустимое значение: 1. Максимально допустимое значение: 1000. Значение по умолчанию: 100. |
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, например, 2024-01-24T23:13:39+02:00.Если в значении параметра указан часовой пояс, он должен быть таким же, как и в значении параметра options.time_zone. Дата должна быть не ранее 90 дней до даты параметра date_to. В случае если количество транзакций в заданный период превышает установленный в запросе лимит, необходимо отправить повторный запрос, указав в этом поле значение параметра next_date из ответа на предыдущий запрос. |
N/A |
| uid_from * условно обязательный | string | Параметр обязателен при отправке повторных запросов в случае, если количество транзакций с заданными параметрами больше установленного в запросе лимита. Значение должно равняться значению параметра next_uid из ответа на предыдущий запрос. |
N/A |
| date_to * обязательный | string | Дата окончания периода выборки транзакций в формате ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm, например, 2024-01-24T23:13:39+02:00. Если в значении параметра указан часовой пояс, он должен быть таким же, как и в значении параметра options.time_zone.Дата должна быть не позднее 90 дней после даты параметра date_from. |
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 (20) | Результат проверки безопасности. Возможные значения: 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) | Восьмизначный банковский идентификационный номер. Первые 6 цифр номера карточки покупателя. | 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 |
Пример запроса
{ "options": { "limit": 5, "time_zone": "Europe/Vilnius" }, "filter": { "date_from": "2024-01-01T06:30:20+02:00", "date_to": "2024-01-03T06:33:18+02:00", "date_type": "created_at", "currency": "EUR,USD" }, "response_parameters": "query { transactions { uid status description amount currency type tracking_id created_at paid_at settled_at psp_settled_at updated_at manually_corrected_at expired_at closed_at message friendly_message code language test parent_uid reason converted_currency converted_amount recurring_type subscription_id product_id fraud merchant{enabled id name company_name bank_id legal_address email postal_code country city} shop{enabled id name company_name business_category_id contact_phone url contact_email legal_address mailing_address postal_code country city} provider_raw{auth_code bank_code rrn ref_id message dynamic_billing_descriptor amount currency} gateway{id type note agent_id vendor connection_type} links{receipt_url redirect_url return_url notification_url} three_d_secure_verification{status message acs_url pa_req md pa_res_url eci pa_status xid cavv cavv_algorithm fail_reason method_process_url creq} customer{id ip first_name last_name middle_name full_name gender birth_date phone email address country city zip state device_id taxpayer_id} method{credit_card{product first_1 bin bin_8 last_4 holder exp_month exp_year brand sub_brand stamp token token_provider issuer_country issuer_bank}} recipient{customer{id ip first_name last_name middle_name full_name gender birth_date phone email address country city zip state device_id}} method {type alternative_account alternative_type alternative_payment_info} smart_routing_verification avs_cvc_verification provider_response}}"}
Пагинация
Максимальное количество транзакций в ответе – 1000 (если options.limit не указан в запросе, лимит количества транзакций в ответе – 100). Если транзакций, соответствующих критериям запроса больше установленного лимита в запросе, отправьте аналогичный запрос еще раз, но в значении filter.date_from укажите значение параметра pagination.next_date из предыдущего ответа. И добавьте параметр filter.uid_from со значением поля pagination.next_uid из предыдущего ответа. Важно указать оба параметра и использовать то же значение filter.date_type, что и в предыдущем запросе.
Пример запроса последующих транзакций
{ "options": { "limit": 5, "time_zone": "Europe/Vilnius" }, "filter": { "date_from": "2024-01-01T07:30:24.978000+02:00", "date_to": "2024-01-03T06:33:18+02:00", "date_type": "created_at", "currency": "EUR,USD" }, "response_parameters": " query { transactions { uid status description amount currency type tracking_id created_at paid_at settled_at psp_settled_at updated_at manually_corrected_at expired_at closed_at message friendly_message code language test parent_uid reason converted_currency converted_amount recurring_type subscription_id product_id fraud merchant{enabled id name company_name bank_id legal_address email postal_code country city} shop{enabled id name company_name business_category_id contact_phone url contact_email legal_address mailing_address postal_code country city} provider_raw{auth_code bank_code rrn ref_id message dynamic_billing_descriptor amount currency} gateway{id type note agent_id vendor connection_type} links{receipt_url redirect_url return_url notification_url} three_d_secure_verification{status message acs_url pa_req md pa_res_url eci pa_status xid cavv cavv_algorithm fail_reason method_process_url creq} customer{id ip first_name last_name middle_name full_name gender birth_date phone email address country city zip state device_id taxpayer_id} method{credit_card{product first_1 bin bin_8 last_4 holder exp_month exp_year brand sub_brand stamp token token_provider issuer_country issuer_bank}} recipient{customer{id ip first_name last_name middle_name full_name gender birth_date phone email address country city zip state device_id}} method {type alternative_account alternative_type alternative_payment_info} smart_routing_verification avs_cvc_verification provider_response}}"}
Возможные значения параметра response_parameters в запросе
В этой таблице приведены возможные значение параметра response_parameters (см. формат в примере выше). Если значения указаны в запросе, соответствующие параметры будут включены в ответ. Параметры, указанные жирным шрифтом — это параметры, которые будут отправлены в ответе по умолчанию, даже если параметр response_parameters не был указан в запросе.
| Параметр | Описание |
|---|---|
| transactions | |
| uid * обязательный | Идентификатор транзакции в системе поставщика платежных услуг. |
| status | Статус транзакции. Возможные значения: successful,failed,incomplete,error,pending. |
| description | Описание транзакции. |
| amount | Сумма транзакции. |
| currency | Валюта транзакции. |
| type | Тип транзакции. |
| tracking_id | Идентификатор транзакции в системе торговца. |
| created_at | Время и дата создания транзакции. |
| paid_at | Время и дата проведения оплаты по транзакции. |
| settled_at | Время и дата расчета по транзакции между эквайером и торговцем. |
| psp_settled_at | Время и дата расчета по транзакции между системой поставщика платежных услуг (PSP) и торговцем. |
| updated_at | Время и дата обновления данных транзакции. |
| manually_corrected_at | Время и дата ручной корректировки транзакции. |
| expired_at | Время и дата окончания периода для возможного проведения оплаты по транзакции. |
| сlosed_at | Дата закрытия транзакции. |
| message | Сообщение об обработке транзакции для торговца. |
| friendly_message | Сообщение об обработке транзакции для покупателя. |
| code | Код результата транзакции. |
| language | Язык страницы оформления заказа. |
| test | Если true, транзакция тестовая. |
| parent_uid | Идентификатор родительской транзакции в системе поставщика платежных услуг. |
| reason | Причина возврата. |
| converted_currency | Валюта конверсии транзакции. |
| converted_amount | Сумма транзакции после конверсии. |
| recurring_type | Тип рекуррентного платежа при оплате по сохраненным картам. Возможные значения: recurring,initial,null |
| subscription_id | Идентификатор подписки. |
| product_id | Идентификатор плана подписки. |
| fraud | Результат проверки на безопасность. |
| merchant | |
| enabled | Если true, торговец активен. |
| id | Идентификатор торговца в системе поставщика платежных услуг. |
| name | Имя торговца. |
| company_name | Название компании торговца. |
| bank_id | Идентификационный номер банка торговца для расчетно-кассовых операций |
| legal_address | Адрес компании торговца. |
| Email компании торговца. | |
| postal_code | Почтовый индекс компании торговца. |
| country | Страна, в которой зарегистрирована компания торговца. |
| city | Город, где зарегистрирована компания торговца. |
| shop | |
| enabled | Если true, магазин активен. |
| id | Идентификатор магазина в системе торговца. |
| name | Название магазина. |
| company_name | Юридическое название магазина. |
| business_category_id | Идентификатор категории бизнеса магазина. |
| contact_phone | Номер телефона магазина. |
| url | Интернет-сайт магазина. |
| contact_email | Контактный email магазина. |
| legal_address | Адрес регистрации магазина. |
| mailing_address | Почтовый адрес магазина. |
| postal_code | Почтовый индекс адреса магазина. |
| country | Страна, в которой зарегистрирован магазин. |
| city | Город, в котором зарегистрирован магазин. |
| provider_raw | |
| auth_code | Код авторизации провайдера. |
| bank_code | Код результата транзакции на стороне провайдера. |
| rrn | Номер операции в международной платёжной системе. ID транзакции, выданный сетью обработки карт. |
| ref_id | Идентификатор транзакции в системе провайдера. |
| message | Сообщение с результатом транзакции в системе провайдера. |
| dynamic_billing_descriptor | Описание результата транзакции в системе провайдера. |
| amount | Сумма транзакции в системе провайдера. |
| currency | Валюта транзакции в системе провайдера. |
| gateway | |
| id | Идентификатор шлюза в системе поставщика платежных услуг. |
| type | Наименование шлюза в системе поставщика платежных услуг. |
| note | Описание шлюза. |
| agent_id | Идентификатор агента, присвоенного магазину. |
| vendor | Тип транзакции. Возможные значения: gateway для карточных транзакций,beyag для альтернативных способов оплаты. |
| connection_type | Тип подключения шлюза. Значение поля Тип подключения в настройках шлюза. Как правило, содержит ключевые слова, используемые для группировки данных в бухгалтерских отчетах. |
| links | |
| receipt_url | Ссылка на чек в формате PDF. |
| redirect_url | URL страницы для завершения транзакции. |
| return_url | URL на стороне торговца, на который покупатель будет перенаправлен после завершения 3-D Secure проверки. |
| notification_url | URL, на который отправляются автоматические уведомления. |
| three_d_secure_verification | |
| status | Статус аутентификации 3-D Secure. |
| message | Сообщение о статусе аутентификации 3-D Secure. |
| acs_url | URL c ACS формой для ввода пароля, полученного от банка. |
| pa_req | Зашифрованный запрос на оплату. |
| md | Идентификатор транзакции, используемый для связи между сервером торговца и сервером банка-эмитента. |
| pa_res_url | URL, на который сервер банка-эмитента отправляет ответ на запрос аутентификации транзакции. |
| eci | Electronic Commerce Indicator. Предоставляет информацию об уровне защиты от запросов на возврат платежей владельцев карт или их банков. |
| pa_status | Статус аутентификации платежа в протоколе 3-D Secure. |
| xid | Уникальный идентификационный код 3-D Secure. |
| cavv | Cardholder Authentication Verification Value (только если владелец карты был успешно аутентифицирован). |
| cavv_algorithm | CAVV алгоритм (только если статус аутентификации Y или A). |
| fail_reason | Незашифрованное сообщение о причине непрохождении 3-D Secure аутентификации. |
| method_process_url | URL для дополнительной проверки на основе данных браузера. |
| creq | Запрос на аутентификацию 3-D Secure. |
| customer | |
| id | Идентификатор покупателя в системе поставщика платежных услуг. |
| ip | IP адрес покупателя при проведении оплаты. |
| first_name | Имя покупателя. |
| last_name | Фамилия покупателя. |
| middle_name | Отчество покупателя. |
| full_name | ФИО покупателя. |
| gender | Пол покупателя. |
| birth_date | Дата рождения покупателя. |
| phone | Номер телефона покупателя. |
| Email покупателя. | |
| address | Адрес покупателя. |
| country | Страна покупателя. |
| city | Город покупателя. |
| zip | Почтовый индекс покупателя. |
| state | Штат или область покупателя. |
| device_id | Идентификатор устройства, используемого для совершения транзакции. |
| taxpayer_id | Идентификационный номер налогоплательщика (ИНН), присвоенный покупателю. |
| method | |
| credit_card | |
| product | Название бренда карты или карточного продукта. |
| first_1 | Первая цифра номера карты. |
| bin | Шестизначный банковский идентификационный номер. Первые 6 цифр номера карточки. |
| bin_8 | Восьмизначный банковский идентификационный номер. Первые 8 цифр номера карточки. |
| last_4 | Последние 4 цифры номера карты. |
| holder | Имя держателя карты. |
| exp_month | Месяц окончания срока действия карты. |
| exp_year | Год срока окончания действия карты. |
| brand | Бренд карты. |
| sub_brand | Кобренд карточки. |
| stamp | Хэш карты. Постоянная величина, даже если дата окончания действия карты или владелец изменены. |
| token | Токен карты, полученный в ответе на первую транзакцию. |
| token_provider | Провайдер токена, например, apple_pay. |
| issuer_country | Страна банка-эмитента в формате ISO 3166-1 alpha-2. |
| issuer_bank | Название банка-эмитента. |
| recipient | |
| customer | |
| id | Идентификатор получателя в системе поставщика платежных услуг. |
| ip | IP адрес получателя при проведении оплаты. |
| first_name | Имя получателя. |
| last_name | Фамилия получателя. |
| middle_name | Отчество получателя. |
| full_name | ФИО получателя. |
| gender | Пол получателя. |
| birth_date | Дата рождения получаетял. |
| phone | Номер телефона получателя. |
| Email получателя. | |
| address | Адрес получателя. |
| country | Страна получателя. |
| city | Город получателя. |
| zip | Почтовый индекс получателя. |
| state | Штат или область получателя. |
| device_id | Идентификатор устройства, использованного при транзакции. |
| method | |
| type | Альтернативный способ оплаты. |
| alternative_account | Атрибут платежного метода на стороне альтернативной интеграции, например, номер счета. |
| alternative_type | Атрибут платежного метода на стороне альтернативной интеграции, например, тип запроса. |
| alternative_ payment_info | Исходные данные по данному альтернативному способу оплаты. |
| smart_routing_verification | Секция с результатами проверки транзакции сервисом Умная Маршрутизация. |
| avs-cvc_verification | Секция с результатами AVS/CVS проверки. |
| provider_response | Секция с дополнительной информацией из ответа провайдера. |
Ответ
Ответ содержит следующие параметры:
| Параметр | Тип | Описание |
|---|---|---|
| data | object | Секция данных транзакций. |
| pagination | object | |
| date_from | string | Значение параметра date_from из запроса. |
| date_to | string | Значение параметра date_to из запроса. |
| date_type | string | Значение параметра date_type из запроса. |
| has_next_page | boolean | Параметр, указывающий, все ли транзакции, соответствующие критериям из запроса, переданы в ответе. Возможные значения: true, если были присланы не все транзакции;false, если все транзакции, соответствующие требованиям из запроса, были переданы в ответе. |
| next_date | string | Дата следующей транзакции, которая соответствует параметрам запроса, но не вошла в ответ. Тип даты соответствует тому типу, который был передан в параметре date_type в запросе.Чтобы получить данные транзакций, не вошедших в ответ, передайте полученное значение даты как значение параметра date_from в запросе. |
| uid_from | string | uid первой транзакции в ответе. |
| uid_to | string | uid последней транзакции в ответе. |
| next_uid | string | uid следующей транзакции, соответствующих параметрам в фильтре запроса, но не добавленной в ответ из-за лимита. Используйте значение этого параметра чтобы получить следующие транзакции, соответствующие |
| transactions | array | Массив транзакций, соответствующих параметрам запроса. Каждый элемент представляет собой объект транзакции, набор полей которого включает обязательные параметры ответа и те параметры, которые были указаны в response_parameters в запросе. |
| updated_at | string | Дата обновления транзакции. |
| smart_routing_verification | object | Секция с данными о прохождении проверок транзакции сервисом Умная Маршрутизация. |
Параметры секции smart_routing_verification
| Параметр | Тип | Описание |
|---|---|---|
| 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}, Merchant_{merchant_id}, Shop_{shop_id} соответственно. |
| {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. |
Пример ответа
{ "data": { "transactions": [ { "amount": 3608, "created_at": "2024-01-01T07:30:20.762000+02:00", "currency": "USD", "merchant_id": 366, "paid_at": "2024-01-01T07:30:20.964000+02:00", "shop_id": 343, "status": "successful", "type": "authorization", "uid": "95813fc8-0488-4fda-893a-d03130456d2f" }, { "amount": 879, "created_at": "2024-01-01T07:30:21.423000+02:00", "currency": "USD", "merchant_id": 366, "paid_at": "2024-01-01T07:30:21.617000+02:00", "shop_id": 343, "status": "successful", "type": "capture", "uid": "3c0c6f09-b6d6-419b-940e-7fe1b98a6ac6" }, { "amount": 1979, "created_at": "2024-01-01T07:30:22.040000+02:00", "currency": "USD", "merchant_id": 366, "paid_at": "2024-01-01T07:30:22.255000+02:00", "shop_id": 343, "status": "successful", "type": "authorization", "uid": "794734e6-3932-47d0-99b1-c640730e7293" }, { "amount": 4639, "created_at": "2024-01-01T07:30:22.841000+02:00", "currency": "USD", "merchant_id": 366, "paid_at": "2024-01-01T07:30:23.047000+02:00", "shop_id": 343, "status": "successful", "type": "payment", "uid": "1cd98e2e-7ed4-44f6-a4d3-42211e42ce3c" }, { "amount": 1257, "created_at": "2024-01-01T07:30:24.186000+02:00", "currency": "EUR", "merchant_id": 366, "paid_at": "2024-01-01T07:30:24.444000+02:00", "shop_id": 343, "status": "successful", "type": "authorization", "uid": "9084b001-6a55-4eed-b09c-0467ee6941b9" } ], "pagination": { "date_type": "created_at", "has_next_page": true, "uid_from": "95813fc8-0488-4fda-893a-d03130456d2f", "date_from": "2024-01-01T07:30:20.762000+02:00", "date_to": "2024-01-01T07:30:24.186000+02:00", "next_date": "2024-01-01T07:30:24.978000+02:00", "next_uid": "f1cb7674-e043-450b-a60c-3765f088a401", "uid_to": "9084b001-6a55-4eed-b09c-0467ee6941b9" } }}
Пример ответа с секцией smart_routing_verification
{ "data": { "transactions": [ { "created_at": "2024-01-01T05:30:20.762000+02:00", "smart_routing_verification": { "data": { "status": "passed", "object": "3405", "object_name": "gw_3405", "object_flows": [ { "name": "Test_object_flow", "system": false, "skipped": false, "rules": [ { "alias": "123456", "state": "skipped", "description": "1234567", "error_message": "Rule is inactive", "error_code": "rule_inactive" }, { "alias": "Shop_rule", "state": "skipped", "description": "7564", "error_message": "Rule is inactive", "error_code": "rule_inactive" }, { "alias": "rule_1 gw_1_33201, gw_2_33202, gw_3_33203", "state": "skipped", "description": "description", "error_message": "Rule is inactive", "error_code": "rule_inactive" }, { "alias": "Test object rule", "state": "skipped", "description": "321", "error_message": "No intersection between 'objects' and 'allowable_return_values'", "error_code": "allowed_objects_missmatch" }, { "alias": "Test object rule 2", "state": "matched", "description": "Notifications", "use_only_these_objects": true } ] } ], "object_defined_via": "rule", "action_rules": { "Psp_1_ООО beGateway1": { "Calibri": { "Test1234567": "skipped" }, "psp rule, reject EUR txns": { "psp rule": "skipped" } } }, "matched_actions": { "skipped": [ { "alias": "psp rule, reject EUR txns", "description": "psp rule", "account": "Psp_1_ООО beGateway1" }, { "alias": "Calibri", "description": "Test1234567", "account": "Psp_1_ООО beGateway1" } ] }, "wb_lists": { "merchant_black_list": "not_matched", "merchant_white_list": "not_matched", "psp_black_list": "not_matched", "psp_white_list": "not_matched", "shop_black_list": "not_matched", "shop_white_list": "not_matched" } } } }, { "created_at": "2024-01-01T05:30:21.423000+02:00", "smart_routing_verification": { "data": { "status": "passed", "object": "456", "object_name": "gw_456", "action_rules": { "Psp_1_Demo PSP": { "country flow": { "choose country": "passed" } } }, "matched_actions": { "passed": [ { "account": "Psp_1_Demo PSP", "alias": "country flow", "description": "choose country" } ] }, "object_defined_via": "allowed objects", "object_flows": [] }, "status": "successful" } } ], "pagination": { "date_from": "2024-01-02T05:30:19.720000+02:00", "date_to": "2024-01-02T05:30:20.621000+02:00", "date_type": "created_at", "has_next_page": true, "uid_from": "36d87fc6-8a51-4d8e-a573-0c8ee0764b28", "next_date": "2024-01-02T05:30:21.373000+00:00", "next_uid": "f53009ee-0781-4237-9351-21b4eeeecd93", "uid_to": "ddadaae1-812e-42c6-a551-114ca178e91f" } }}