Reports API

Reports API дозволяє отримувати реєстри операцій для розрахунків та історію транзакцій.

Реєстр платежів (Settlements)

Отримання реєстру операцій, по яких був здійснений розрахунок.

curl -X POST https://api.rozetkapay.com/api/reports/v1/payments \
  -u "login:password" \
  -H "Content-Type: application/json" \
  -d '{
    "date_from": "2024-01-01",
    "date_to": "2024-01-31",
    "scope": "current_login",
    "register_type": "transactions_list_dwh"
  }'

Параметри запиту

Параметр	Обов’язковий	Опис
date_from	Так	Дата виплати на рахунок (початок періоду)
date_to	Так	Дата виплати на рахунок (кінець періоду)
scope	Так	current_login — один проєкт, all_keys — всі проєкти партнера
register_type	Ні	Версія реєстру: transactions_list або transactions_list_dwh
fields	Ні	Список полів для включення у відповідь

Відповідь

{
  "payments": [
    {
      "amount": 10000,
      "card_pan": "424242******4242",
      "currency": "UAH",
      "description": "Оплата замовлення #12345",
      "external_id": "order_12345",
      "internal_commission": 150,
      "payer_external_fee": 0,
      "payment_id": "pay_abc123",
      "payment_method": "card",
      "payment_system": "VISA",
      "payment_type": "purchase",
      "payout_amount": 9850,
      "payout_date": "2024-01-15",
      "processing_date": "2024-01-14",
      "project_name": "My Shop",
      "client_email": "user@example.com",
      "client_first_name": "Іван",
      "client_last_name": "Петренко"
    }
  ]
}

Поля відповіді

Поле	Опис
amount	Сума замовлення
card_pan	Маска картки платника
currency	Валюта операції
description	Опис замовлення
external_id	Унікальний номер замовлення
internal_commission	Комісія партнера
payer_external_fee	Зовнішня комісія з платника
payment_id	Внутрішній номер операції
payment_method	Тип платіжного методу
payment_system	Платіжна система (VISA, MASTERCARD)
payment_type	Тип операції
payout_amount	Сума виплати партнеру
payout_date	Дата виплати
processing_date	Дата обробки транзакції
project_name	Назва проєкту

Список транзакцій

Отримання списку транзакцій за період з фільтрацією.

curl -X POST https://api.rozetkapay.com/api/reports/v1/transactions \
  -u "login:password" \
  -H "Content-Type: application/json" \
  -d '{
    "date_from": "2024-01-01",
    "date_to": "2024-01-31",
    "register_type": "transactions_list",
    "operation_types": ["purchase", "refund"],
    "statuses": ["Success"]
  }'

Параметри запиту

Параметр	Обов’язковий	Опис
date_from	Так	Початкова дата
date_to	Так	Кінцева дата
register_type	Ні	transactions_list
operation_types	Ні	Фільтр по типах операцій
statuses	Ні	Фільтр по статусах

Типи операцій (operation_types)

• auth — авторизація (блокування)
• void — скасування блокування
• purchase — списання
• capture — підтвердження блокування
• refund — повернення
• payment — платіж
• payout — виплата
• p2p — переказ
• credit — кредит
• create — створення

Статуси (statuses)

• Success — успішна
• Failed — невдала
• Unsuccessful — неуспішна
• Created — створена
• Cancel — скасована
• Pending — в обробці
• Rejected — відхилена

Відповідь

{
  "transactions": [
    {
      "order_id": "84e79700-5175-4954-be11-cbc07042d0db",
      "transaction_id": "f8323ed1-097b-42b7-9809-8558555daba2",
      "external_id": "order_777",
      "operation_type": "purchase",
      "status": "Success",
      "status_code": 1000,
      "payment_method": "card",
      "project_name": "My Shop",
      "order_description": "Оплата замовлення",
      "payer_card_mask": "424242******4242",
      "payer_bank_name": "ПриватБанк",
      "bin_payment_system": "VISA",
      "bin_country_digit_code": "804",
      "original_amount": 500.48,
      "payer_amount": 517.48,
      "currency": "UAH",
      "payer_fee": 17,
      "merchant_fee": 7.51,
      "auth_code": "123456",
      "rrn": "333334788615",
      "created_at": "2024-01-15 10:17:57",
      "processed_at": "2024-01-15 10:17:59"
    }
  ]
}

Поля транзакції

Поле	Опис
order_id	ID замовлення в системі
transaction_id	ID транзакції
external_id	Зовнішній ID замовлення
operation_type	Тип операції
status	Статус транзакції
status_code	Код статусу
payer_card_mask	Маска картки
payer_bank_name	Банк-емітент
bin_payment_system	Платіжна система
original_amount	Початкова сума
payer_amount	Сума з комісією платника
payer_fee	Комісія платника
merchant_fee	Комісія мерчанта
auth_code	Код авторизації
rrn	Reference Retrieval Number
created_at	Дата створення
processed_at	Дата обробки

Приклади використання

Щоденний звіт по продажах

curl -X POST https://api.rozetkapay.com/api/reports/v1/transactions \
  -u "login:password" \
  -H "Content-Type: application/json" \
  -d '{
    "date_from": "2024-01-15",
    "date_to": "2024-01-15",
    "operation_types": ["purchase"],
    "statuses": ["Success"]
  }'

Звіт по поверненнях за місяць

curl -X POST https://api.rozetkapay.com/api/reports/v1/transactions \
  -u "login:password" \
  -H "Content-Type: application/json" \
  -d '{
    "date_from": "2024-01-01",
    "date_to": "2024-01-31",
    "operation_types": ["refund"],
    "statuses": ["Success", "Pending"]
  }'