RozetkaPay

Reports API

Отримання реєстрів операцій та списків транзакцій через RozetkaPay 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-14",
    "register_type": "transactions_list",
    "operation_types": ["purchase", "refund"],
    "statuses": ["Success"]
  }'

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

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

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

  • auth — авторизація (блокування)
  • void — скасування блокування
  • purchase — списання
  • capture — підтвердження блокування
  • refund — повернення
  • payment — платіж
  • payout — виплата
  • 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_idID замовлення в системі
transaction_idID транзакції
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Код авторизації
rrnReference 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-14",
    "operation_types": ["refund"],
    "statuses": ["Success", "Pending"]
  }'