Перейти к содержанию

API постраничных отчётов

API постраничных отчетов рекомендуется использовать, если ожидаемый отчет может содержать более 1000 транзакций.

Запрос

Отправьте запрос на получение списка транзакций с дополнительным заголовком X-Api-Version: 3 и следующими параметрами:

обязательный
object
Секция параметров отчета.
date_type
обязательный
string
Тип даты.

Возможные значения:
created_at,
paid_at,
settled_at.
from
обязательный
string
Дата начала отчетного периода в формате YYYY-MM-DD hh:mm:ss, например 2020-01-01 12:00:00.

Для даты типа settled_at возможно указать дату начала только в формате 2020-01-01.
to
обязательный
string
Дата окончания отчетного периода в формате YYYY-MM-DD hh:mm:ss, например 2020-01-01 15:00:00.

Для даты типа settled_at возможно указать дату начала только в формате 2020-01-01.
status
обязательный
string
Статус транзакции.

Возможные значения:
all,
successful,
failed,
pending,
incomplete.
payment_method_type
обязательный
string
Способ оплаты.

Возможные значения:
credit_card,
alternative
time_zone
обязательный
string
Часовой пояс в формате, как указан здесь, например Europe/London.
starting_after
string
Параметр для прямой пагинации. Принимает значение last_object_id из ответа.
ending_before
string
Параметр для обратной пагинации. Принимает значение first_object_id из ответа.
manual_correction_from
string
Дата начала периода отчета с транзакциями, отредактированными вручную, в формате YYYY-MM-DD hh:mm:ss, например 2020-01-01 12:00:00.
manual_correction_to
string
Дата окончания периода отчета с транзакциями, отредактированными вручную, в формате YYYY-MM-DD hh:mm:ss, например 2020-01-01 15:00:00.
Пример запроса
{
"report_params": {
    "date_type":"created_at",
    "from":"2020-09-11 00:00:00",
    "to":"2020-09-11 23:59:59",
    "status":"successful",
    "payment_method_type":"credit_card",
    "time_zone":"UTC"
}
}
Ответ
обязательный
array
Массив транзакций для запрошенного отчета. Количество элементов должно быть таким же, как в секции count. Каждый элемент представляет собой транзакционный объект, набор полей которого зависит от типа платежа и способа оплаты для данной транзакции.
object
Секция информации об адресе покупателя. Узнайте у службы поддержки, должны ли вы отправлять параметры этой секции.
first_name
string
Имя покупателя.
last_name
string
Фамилия покупателя.
country
string
Страна покупателя в формате ISO 3166-1 alpha-2.
city
string
Город покупателя.
state
string
Двухбуквенная аббревиатура штата, если страна покупателя IN, US или CA.
zip
string
Почтовый индекс покупателя. Для country=US, формат почтового индекса должен иметь вид NNNNN или NNNNN-NNNN.
address
string
Адрес покупателя.
phone
string
Номер телефона покупателя.
birth_date
string
Дата рождения покупателя в формате ISO 8601 YYYY-MM-DD.
object
Секция информации о покупателе.
ip
string
IP-адрес покупателя, производящего оплату в вашем магазине.
email
string
email покупателя, производящего оплату в вашем магазине.
object
gateway_id
integer
Идентификатор шлюза, обработавшего транзакцию, в системе eComCharge.
auth_code
string
Код авторизации, предоставленный эквайером.
bank_code
string
Код ответа транзакции в банковской системе.
rrn
string
Номер транзакции в международной платёжной системе. Id транзакции, выданный сетью обработки карт.
ref_id
string
Номер транзакции в системе эквайера.
message
string
Сообщение от системы банка.
billing_descriptor
string
Идентификатор платежа, назначенный транзакции.
status
string
Статус обработанной банком-эквайером транзакции.
object
brand
string
Определенный бренд карты.
product
string
Код типа карточного продукта.
last_4
string
Последние 4 цифры карты.
first_1
string
Первая цифра карты.
exp_month
integer (2)
Месяц окончания срока действия карты.
exp_year
integer (4)
Год окончания срока действия карты.
bin
string (6)
Шестизначный банковский идентификационный номер. Первые 6 цифр номера карты.
bin_8
string (8)
Восьмизначный банковский идентификационный номер. Первые 8 цифр номера карты. Значение возвращается для карт Visa, Mastercard, Maestro и соответствующих кобрендинговых карт. Для брендов других платежных карт значение параметра – null.
issuer_country
string (2)
Страна банка, выпустившего карту в формате ISO 3166-1 alpha-2.
issuer_name
string
Название банка, выпустившего карту.
token
string
Токен карты. Позволяет сохранять данные покупателей и производить оплату, когда они делают покупку или вы возобновляете свои услуги.
object
id
integer
Идентификатор магазина в системе eComCharge.
uid
string
UID обработанной транзакции.
id
integer
Идентификатор транзакции. Значение этого параметра используется для пагинации.
payment_method_type
string
Способ оплаты.
status
string
Статус обработанной транзакции.
message
string
Сообщение с результатом обработки запроса.
gateway_note
string
Значение поля Заметки в настройках шлюза в системе eComCharge.
amount
bigInteger
Сумма запроса в минимальных денежных единицах.
discount_rate
float
Комиссия за транзакцию в процентах.
transaction_rate
float
Фиксированная комиссия за транзакцию в валюте транзакции в основных денежных единицах.
transaction_fee
float
Общая сумма комиссий, примененных к транзакции, в минимальных денежных единицах.
pay_to_merchant
float
Сумма к выплате торговцу (за вычетом комиссий эквайера, eComCharge и страховых депозитов) в минимальных денежных единицах.
test
boolean
Если true, транзакция тестовая.
currency
string
Валюта в ISO-4217 формате, например USD.
description
string
Описание заказа.
tracking_id
string
Идентификатор транзакции в системе торговца.
type
string
Тип транзакции.
order_id
integer
Идентификационный номер заказа, связанного с транзакцией. Транзакция оплаты и соответствующая ей транзакция возврата будут иметь одинаковый order_id. Транзакция авторизация и соответсвующие ей транзакции списания средств и отмены авторизации также будут иметь одинаковый order_id.
created_at
string
Дата и время создания транзакции в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ.
paid_at
string
Дата и время завершения транзакции в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ. Устанавливается в значении null, если транзакция имеет статус incomplete.
settled_at
string
Дата и время перечисления суммы транзакции на счет торговца в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ. Устанавливается в значении null, если параметр не применим к транзакции.
manually_corrected_at
string
Дата и время ручной корректировки транзакции в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ. Устанавливается в значении null, если параметр не применим к транзакции.
object
Секция с результатом проверки 3-D Secure.
eci
string or integer
Electronic Commerce Indicator. Предоставляет информацию об уровне защиты от оспоренных платежей владельцев карт или их банков.
pa_status
string
Статус аутентификации транзакции в протоколе 3-D Secure.
xid
string
Уникальный идентификатор 3-D Secure аутентификации.
cavv
string
Cardholder Authentication Verification Value (только если владелец карты был успешно аутентифицирован).
cavv_algorithm
string
CAVV алгоритм, использованный для генерации значения CAVV.
ve_status
string
Verification Enrollment Status, указывает, зарегистрирован ли держатель карты в программе 3-D Secure.
message
string
Сообщение о статусе аутентификации 3-D Secure.
status
string
Статус аутентификации 3-D Secure.
object
Секция, содержащая дополнительную информацию о транзакции.
contract
array
Значение, использованное в запросе. Возможные значения: recurring, card_on_file, oneclick, credit.
object
Параметры браузера. Параметры из секции передаются только при использовании 3DS 2.0.
accept_header
string
Значение HTTP-заголовка Accept запроса от браузера покупателя.
screen_width
integer
Ширина экрана в пикселях. Соответствует параметру screen.width в JavaScript.
screen_height
integer
Высота экрана в пикселях. Соответствует параметру screen.height в JavaScript.
screen_color_depth
integer
Глубина цвета экрана в битах на пиксель. Соответствует параметру screen.colorDepth в JavaScript. Возможные значения:

1 - 1 bit
4 - 4 bits
8 - 8 bits
15 - 15 bits
16 - 16 bits
24 - 24 bits
32 - 32 bits
48 - 48 bits.
window_width
integer
Размер окна браузера по горизонтали в пикселях. Соответствует параметру document.body.clientWidth в JavaScript.
window_height
integer
Размер окна браузера по вертикали в пикселях. Соответствует параметру document.body.clientHeight в JavaScript.
language
string
Язык навигатора. Соответствует параметру navigator.language в JavaScript.
java_enabled
boolean
Параметр показывает, включен ли java в текущем браузере или нет. Соответствует параметру navigator.javaEnabled() в JavaScript.
user_agent
string
Строка агента пользователя текущего браузера. Соответствует параметру navigator.userAgent в JavaScript.
time_zone
integer
Смещение часового пояса относительно часового пояса UTC в минутах для текущей локали. Соответствует параметру new Date().getTimezoneOffset() в JavaScript.
challenge_window_size
integer
Рекомендуемое значение для окна 3-D Secure проверки, которое вычисляется, используя значения window_width и window_height. Возможные значения: 1, 2, 3, 4, 5.
time_zone_name
string
Название часового пояса. Соответствует параметру Intl.DateTimeFormat().resolvedOptions().timeZone в JavaScript.
object
Секция с результатом проверки 3-D Secure.
status
string
Статус аутентификации 3-D Secure.
message
string
Сообщение о статусе аутентификации 3-D Secure.
ve_status
string
Verification Enrollment Status, указывает, зарегистрирован ли держатель карты в программе 3-D Secure.
acs_url
string
URL c ACS формой в системе эмитента карты, куда покупатель перенаправляется для завершения 3-D Secure аутентификации.
pa_req
string
Зашифрованный запрос на аутентификацию держателя карты.
md
string
Идентификатор транзакции, используемый для связи между сервером торговца и сервером банка-эмитента.
pa_res_url
string
URL, на который сервер банка-эмитента отправляет ответ на запрос аутентификации транзакции.
eci
string or integer
Electronic Commerce Indicator. Предоставляет информацию об уровне защиты от запросов на возврат платежей владельцев карт или их банков.
pa_status
string
Статус аутентификации транзакции в протоколе 3-D Secure.
xid
string
Уникальный идентификатор 3-D Secure аутентификации.
cavv
string
Cardholder Authentication Verification Value (только если владелец карты был успешно аутентифицирован).
cavv_algorithm
string
CAVV алгоритм, использованный для генерации значения CAVV.
fail_reason
string
Незашифрованное сообщение о причине непрохождения 3-D Secure аутентификации.
method_process_url
string
URL для дополнительной проверки на основе данных браузера.
creq
string
Запрос на аутентификацию 3-D Secure.
object
Данные о результатах AVS/CVC проверки транзакции.
object
Секция с результатами AVS проверки.
result_code
string
Код результата AVS проверки.
object
Секция с результатами CVC проверки.
result_code
string
Код результата CVC проверки.
object
Секция с данными о прохождении проверок транзакции сервисом Умная Маршрутизация.
status
string
Статус обработки транзакции сервисом.
count
обязательный
integer
Количество транзакций в запрошенном отчете.
has_more
обязательный
boolean
true - указывает, что ещё есть транзакции, удовлетворяющие параметрам запроса, но не попавшие в ответ.
false - указывает, что все транзакции, удовлетворяющие параметрам запроса, попали в ответ.
first_object_id
обязательный
string
ID первого объекта, возвращаемого в ответе.
last_object_id
обязательный
string
ID последнего объекта, возвращаемого в ответе.
Пример ответа в случае успешной обработки запроса
{
    "transactions": [
        {
            "billing_address": {
                "first_name": null,
                "last_name": null,
                "address": null,
                "country": null,
                "city": null,
                "zip": null,
                "state": null,
                "phone": null,
                "birth_date": null
            },
            "customer": {
                "ip": "127.0.0.1",
                "email": null
            },
            "payment": {
                "gateway_id": 312,
                "ref_id": null,
                "message": null,
                "status": "incomplete",
                "gateway_name": "Demo",
                "auth_code": null,
                "bank_code": null,
                "rrn": null,
                "billing_descriptor": null
            },
            "credit_card": {
                "holder": "JJJJ",
                "token": "544ffa4a-d16f-4ebb-b390-d997c29858c9",
                "brand": null,
                "last_4": "0000",
                "first_1": "4",
                "bin": "420000",
                "issuer_country": "IT",
                "issuer_name": "INVESTBANK",
                "exp_month": 12,
                "exp_year": 2027,
                "product": "VISA"
            },
            "shop": {
                "id": 1
            },
            "gateway_note": "",
            "uid": "20528-f87e29fa35",
            "id": 28860,
            "payment_method_type": "credit_card",
            "status": "incomplete",
            "message": null,
            "amount": 1000,
            "discount_rate": 0.0,
            "transaction_rate": 0.0,
            "pay_to_merchant": 0.0,
            "transaction_fee": 0.0,
            "test": false,
            "currency": "USD",
            "description": "Test description",
            "tracking_id": null,
            "type": "payment",
            "order_id": 27724,
            "created_at": "2022-01-27T14:07:00Z",
            "paid_at": null,
            "settled_at": null,
            "manually_corrected_at": null,
            "additional_data": {
                "request_id": "cb8ada4d-59cb-49c5-b6c5-3e679dd2c7c7",
                "browser": {
                    "screen_width": 1440,
                    "screen_height": 900,
                    "screen_color_depth": 24,
                    "language": "it",
                    "java_enabled": false,
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36",
                    "time_zone": -180,
                    "time_zone_name": "Europe/London",
                    "window_height": 666,
                    "window_width": 600,
                    "accept_header": "application/json"
                },
                "vendor": {
                    "name": "CTP",
                    "token": "18b3e6fe3d08edf84bb2fe60c9077c8b898a5bd58f7dc27cd2b286b6b10197d2"
                },
                "tdsecure": {
                    "status": "incomplete",
                    "message": "Authentication Available",
                    "ve_status": "Y",
                    "acs_url": "https://test.pc.com:8443/pareq/15524/003ec8b2-4bef-4036-84ba-f27721c99d86/",
                    "pa_req": "eJxVUtFy2jAQ/BVP3vFJslMwc9GMiRtCZkIpMCXpm7APYxJsIpsW/31PgJtWT7ennb3blXC5tUTJgtKjJY3PVNcmJ6/I7m5e5w8v4U8lF7civp/0B+OXZHajcRbP6UPjL7J1UZVa+sJXCB1kBZtuTdloNOnHaDLVkZQqihCuEPdkJ4mOuoNwaWBp9qTXdDBF5q9bhDPGtDqWjW01iyB0AI/2XW+b5lAPAXZ1r25MXpS5v6bcNPTbtH5a7QHB0RA+N5odXVWz7KnI9OrH03iVzM3z7mE5XY5G38Vb8O1rxrbjOwTHwIzltBJKCan6ngyHoj8UXxDOfTR7t4+WwhfCG71O2eOlgwc3KO6uhUD4t4OctaUybXUUBOyqQ0inQ1USM9jr3xozqlMd9JKFt6ms19iTp8StGvQ2gz6paGOCkBdyHIRPg/eP7gHShpOVQoYseEVuSMEZqtAlegUIjg/Xp+XEzr+Aq/9+xx/mJ7T7",
                    "md": "42877",
                    "pa_res_url": "https://processing.ecomcharge.com/process/20528-f87e29fa35",
                    "eci": null,
                    "pa_status": null,
                    "xid": null,
                    "cavv": null,
                    "cavv_algorithm": null,
                    "fail_reason": null,
                    "method_process_url": null
                },
                "avs_cvc": {
                    "avs_verification": {
                        "result_code": null
                    },
                    "cvc_verification": {
                        "result_code": null
                    }
                }
            },
            "three_d_secure_verification": {
                "eci": null,
                "pa_status": null,
                "xid": null,
                "cavv": null,
                "cavv_algorithm": null,
                "ve_status": "Y",
                "message": "Authentication Available",
                "status": "incomplete"
            }
        },
        {
            "billing_address": {
                "first_name": null,
                "last_name": null,
                "address": null,
                "country": null,
                "city": null,
                "zip": null,
                "state": null,
                "phone": null,
                "birth_date": null
            },
            "customer": {
                "ip": "79.98.55.24",
                "email": null
            },
            "payment": {
                "gateway_id": 312,
                "ref_id": null,
                "message": null,
                "status": "incomplete",
                "gateway_name": "Demo",
                "auth_code": null,
                "bank_code": null,
                "rrn": null,
                "billing_descriptor": null
            },
            "credit_card": {
                "holder": "John Doe",
                "token": "3379480e-4c10-4dbd-83a3-7a14d16baf1f",
                "brand": null,
                "last_4": "0007",
                "first_1": "4",
                "bin": "420000",
                "issuer_country": "IT",
                "issuer_name": "INVESTBANK",
                "exp_month": 1,
                "exp_year": 2027,
                "product": "VISA"
            },
            "shop": {
                "id": 1
            },
            "gateway_note": "",
            "uid": "20529-66a8451797",
            "id": 28861,
            "payment_method_type": "credit_card",
            "status": "incomplete",
            "message": null,
            "amount": 1000,
            "discount_rate": 0.0,
            "transaction_rate": 0.0,
            "pay_to_merchant": 0.0,
            "transaction_fee": 0.0,
            "test": false,
            "currency": "USD",
            "description": "Test description",
            "tracking_id": null,
            "type": "payment",
            "order_id": 27725,
            "created_at": "2022-01-27T14:11:53Z",
            "paid_at": null,
            "settled_at": null,
            "manually_corrected_at": null,
            "additional_data": {
                "request_id": "9e97e8ad-54e6-487f-9bc0-eae0b497f73f",
                "browser": {
                    "screen_width": 1920,
                    "screen_height": 1080,
                    "screen_color_depth": 24,
                    "language": "it",
                    "java_enabled": false,
                    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0",
                    "time_zone": -180,
                    "time_zone_name": "Europe/London",
                    "window_height": 666,
                    "window_width": 600,
                    "accept_header": "application/json"
                },
                "vendor": {
                    "name": "CTP",
                    "token": "179a4105e3f25b2c0ec3e6daf6135629f2fc4caf66667346ae5aeb776c958b4b"
                },
                "tdsecure": {
                    "status": "incomplete",
                    "message": "Authentication Available",
                    "ve_status": "Y",
                    "acs_url": "https://test.pc.com:8443/pareq/15525/a52d019a-440b-450a-b72c-67b24f02a56c/",
                    "pa_req": "eJxVUl1v4jAQ/CtR34k/AvSCFkvQqOpHgiCQVjwaZy+kVxJwQpv8+7MDoXd+mlmPZnfHhs1eIwZrVGeNAiKsKpmhk6fTu1X4kizDx9l8FUY8jrdeuA3uBCxnMZ4EfKGu8rIQzKUuB9JT46DVXha1AKlO8+eF8Bnjvg/kSuGA+jkQfn+AXApQyAOKHR5lnrq7FkjHQZXnotatMCZAegJn/Sn2dX2sJoR8VIOqllleZO4OM1njt2xdVR4IECsD8jPR8mxRZWybPBVJ0ry+vc2j+M/jg8GL6PNl/b5ZRO/JagrEKiA1doJTzinj9w4bThibjDwgXR3kwc4jGHUpdebbhdnxUoGjbTTrrykF8m8FTNYaC9UK3zNmNwbYHMsCjcLsesOQYqWENwjWzu9SO7VuHE5H3B+Mx/LXcMTu/bEZyGqA/Cz48GQfQNUmWUbZ0BhemW2SmwztTl0XS4BYPbk+rUms+wUG/fc7/gJV8bWH",
                    "md": "42878",
                    "pa_res_url": "https://processing.ecomcharge.com/process/20529-66a8451797",
                    "eci": null,
                    "pa_status": null,
                    "xid": null,
                    "cavv": null,
                    "cavv_algorithm": null,
                    "fail_reason": null,
                    "method_process_url": null
                },
                "avs_cvc": {
                    "avs_verification": {
                        "result_code": null
                    },
                    "cvc_verification": {
                        "result_code": null
                    }
                }
            },
            "three_d_secure_verification": {
                "eci": null,
                "pa_status": null,
                "xid": null,
                "cavv": null,
                "cavv_algorithm": null,
                "ve_status": "Y",
                "message": "Authentication Available",
                "status": "incomplete"
            }
        }
    ],
    "count": 2,
    "has_more": false,
    "first_object_id": 28860,
    "last_object_id": 28861
}

Движение по страницам

Если параметр ответа has_more имеет значение true, то это означает, что есть ещё транзакции, удовлетворяющие параметрам запроса, но не попавшие в ответ.

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

Для обратной пагинации нужно использовать параметр ending_before и передавать в нем first_object_id.