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

Отчеты для магазина

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

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

Info

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


Список транзакций для магазина

Запрос

Отправьте POST запрос на https://admin.pay-cross.com/api/reports с дополнительным заголовком X-Api-Version: 2 и следующими параметрами:

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

Возможные значения:
created_at,
paid_at,
settled_at.
date
обязательный
string
Дата в формате YYYY-MM-DD, например 2020-01-01.
status
обязательный
string
Статус транзакции.

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

Возможные значения:
credit_card,
alternative
time_zone
обязательный
string
Часовой пояс в формате, как указан здесь, например Europe/London.
Пример запроса
{
"report_params": {
    "date_type":"created_at",
    "date":"2022-01-27",
    "status":"failed",
    "payment_method_type":"credit_card",
    "time_zone":"Etc/UTC"
}
}
Ответ
обязательный
array
Массив транзакций для запрошенного отчета. Каждый элемент представляет собой объект транзакции, набор полей которого зависит от типа платежа и способа оплаты для данной транзакции.
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
Идентификатор шлюза, обработавшего транзакцию, в системе PayCross.
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
Идентификатор магазина в системе PayCross.
uid
string
UID обработанной транзакции.
id
integer
Идентификатор транзакции. Значение этого параметра используется для пагинации.
payment_method_type
string
Способ оплаты.
status
string
Статус обработанной транзакции.
message
string
Сообщение с результатом обработки запроса.
gateway_note
string
Значение поля Заметки в настройках шлюза в системе PayCross.
amount
bigInteger
Сумма запроса в минимальных денежных единицах.
discount_rate
float
Комиссия за транзакцию в процентах.
transaction_rate
float
Фиксированная комиссия за транзакцию в валюте транзакции в основных денежных единицах.
transaction_fee
float
Общая сумма комиссий, примененных к транзакции, в минимальных денежных единицах.
pay_to_merchant
float
Сумма к выплате торговцу (за вычетом комиссий эквайера, PayCross и страховых депозитов) в минимальных денежных единицах.
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
Количество транзакций в запрошенном отчете.
Пример ответа в случае успешной обработки запроса
{
    "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
            },
            "authorization": {
                "gateway_id": 2,
                "ref_id": null,
                "message": "Card check error",
                "status": "failed",
                "auth_code": null,
                "bank_code": null,
                "rrn": null,
                "billing_descriptor": null
            },
            "credit_card": {
                "holder": "JJJ",
                "token": "f1ed1ac4-875a-48bf-ae15-e2b2092969c1",
                "brand": "visa",
                "last_4": "0000",
                "first_1": "4",
                "bin": "420000",
                "issuer_country": "IT",
                "issuer_name": "INVESTBANK",
                "exp_month": 10,
                "exp_year": 2027,
                "product": "VISA"
            },
            "shop": {
                "id": 1
            },
            "uid": "20527-b7ea8c95f4",
            "id": 28859,
            "payment_method_type": "credit_card",
            "status": "failed",
            "message": null,
            "amount": 1000,
            "discount_rate": 1.0,
            "transaction_rate": 0.3,
            "pay_to_merchant": 960.0,
            "transaction_fee": 40.0,
            "test": false,
            "currency": "USD",
            "description": "Test description",
            "tracking_id": null,
            "type": "authorization",
            "order_id": 27723,
            "created_at": "2022-01-27T13:48:51Z",
            "paid_at": null,
            "settled_at": null,
            "manually_corrected_at": null,
            "additional_data": {
                "customer": {
                    "id": "b17727a9-0632-4454-b639-b941826be36f"
                },
                "request_id": "2a906819-5fbc-4dcb-8aaf-fe7ac17da248",
                "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": 744,
                    "window_width": 600,
                    "accept_header": "application/json"
                },
                "vendor": {
                    "name": "CTP",
                    "token": "cb15c0e3d6419c24bda4823b5b32559a2f30c16cdbb30539ade2c449c7cd453c"
                },
                "tdsecure": {
                    "status": "failed",
                    "message": "Card check error",
                    "ve_status": "E",
                    "acs_url": null,
                    "pa_req": null,
                    "md": null,
                    "pa_res_url": "https://gateway.pay-cross.com/process/20527-b7ea8c95f4",
                    "eci": "07",
                    "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": "07",
                "pa_status": null,
                "xid": null,
                "cavv": null,
                "cavv_algorithm": null,
                "ve_status": "E",
                "message": "Card check error",
                "status": "failed"
            }
        },
        {
            "billing_address": {
                "first_name": "Jane",
                "last_name": "Smith",
                "address": "Gilbert 104",
                "country": "IT",
                "city": "Milan",
                "zip": null,
                "state": null,
                "phone": null,
                "birth_date": null
            },
            "customer": {
                "ip": "127.0.0.1",
                "email": "[email protected]"
            },
            "p2p": {
                "gateway_id": 2,
                "ref_id": null,
                "message": "Can't make",
                "status": "failed",
                "auth_code": null,
                "bank_code": null,
                "rrn": null,
                "billing_descriptor": null
            },
            "credit_card": {
                "holder": "Dof Hag",
                "token": "a1e442d1-0633-4f48-b6ab-4dc36d71356d",
                "brand": "master",
                "last_4": "0707",
                "first_1": "5",
                "bin": "515464",
                "issuer_country": null,
                "issuer_name": null,
                "exp_month": 6,
                "exp_year": 2027,
                "product": null
            },
            "shop": {
                "id": 1
            },
            "uid": "20532-cb06cfeeed",
            "id": 28864,
            "payment_method_type": "credit_card",
            "status": "failed",
            "message": null,
            "amount": 100,
            "discount_rate": 0.0,
            "transaction_rate": 0.0,
            "pay_to_merchant": 0.0,
            "transaction_fee": 0.0,
            "test": false,
            "currency": "USD",
            "description": "Test transaction",
            "tracking_id": "tracking_id_000",
            "type": "p2p",
            "order_id": 27728,
            "created_at": "2022-01-27T15:03:01Z",
            "paid_at": null,
            "settled_at": null,
            "manually_corrected_at": null,
            "additional_data": {
                "tdsecure": {
                    "status": "successful",
                    "message": "Authentication Successful",
                    "ve_status": "Y",
                    "acs_url": null,
                    "pa_req": null,
                    "md": null,
                    "pa_res_url": "https://gateway.pay-cross.com/process/20532-cb06cfeeed",
                    "eci": "02",
                    "pa_status": "Y",
                    "xid": "8GamGXlGw6o2QTwXDd2cjz70qr0=",
                    "cavv": "ADlWFgxrq8BtAU6/rKnuAoABFA==",
                    "cavv_algorithm": null,
                    "fail_reason": null,
                    "method_process_url": null
                },
                "verify_p2p": {
                    "status": "failed",
                    "message": "Can't make",
                    "amount": 100,
                    "currency": "USD",
                    "bank_fee": 0.0,
                    "required_fields": {
                        "p_id": null
                    }
                }
            },
            "three_d_secure_verification": {
                "eci": "02",
                "pa_status": "Y",
                "xid": "8GamGXlGw6o2QTwXDd2cjz70qr0=",
                "cavv": "ADlWFgxrq8BtAU6/rKnuAoABFA==",
                "cavv_algorithm": null,
                "ve_status": "Y",
                "message": "Authentication Successful",
                "status": "successful"
            },
            "recipient_card": {
                "holder": "Qwert Qwerty",
                "token": "516638c8-a113-4061-97a1-a58874cd9cd2",
                "brand": "visa",
                "last_4": "3101",
                "first_1": "4",
                "bin": "401200",
                "issuer_country": null,
                "issuer_name": null
            }
        }
    ],
    "count": 2
}

Подсчёт количества транзакций для магазина

Запрос

Отправьте HTTP POST запрос на https://admin.pay-cross.com/api/reports/countс дополнительным заголовком 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.
to
обязательный
string
Дата конца отчетного периода в формате YYYY-MM-DD hh:mm:ss, например 2020-01-01 15:00:00.
status
обязательный
string
Статус транзакции.

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

Возможные значения:
credit_card,
alternative
time_zone
обязательный
string
Часовой пояс в формате, как указан здесь, например Europe/London.
Пример запроса
{
  "report_params": {
      "date_type":"created_at",
      "from":"2022-01-25 00:00:00",
      "to":"2022-01-27 23:59:59",
      "status":"incomplete",
      "payment_method_type":"credit_card",
      "time_zone":"Etc/UTC"
  }
}
Ответ
object
count
обязательный
integer
Количество транзакций в запрошенном отчете.
Пример ответа в случае успешной обработки запроса
{
    "transactions": {
        "count": 2
    }
}