Квитанції за платежами
Квитанція — це документ для вашого клієнта, який підтверджує факт успішної оплати. Формується за типами операцій Оплата (purchase) та Зарахування резерву (capture). Може бути у двох форматах: PDF-файл чи raw HTML.
Квитанція містить таку інформацію:
- Номер квитанції, дату та час проведення оплати
- Унікальний ідентифікатор вашого проєкту, через який проводилася оплата
- Ідентифікатори платежу
- Призначення платежу та вид операції
- Сума платежу та комісія за ним
- Дані про платіжний засіб, за допомогою якого проводилася оплата.
Способи отримання квитанцій:
- Автоматична відправка квитанцій за платежами в межах певного проєкту на вашу е-пошту.
- Отримання квитанцій через запит до API.
- Завантаження квитанцій вручну через мерчант-портал.
Автоматична відправка квитанцій
За кожною успішною транзакцією вам на вказану е-пошту будуть приходити листи з квитанціями у PDF-форматі Для налаштування цього способу отримання квитанцій зверніться до Служби підтримки Tranzzo.
Завантаження квитанцій через запит до API
Цей спосіб дозволяє отримувати квитанції у HTML- або PDF-форматах на запит до API.
Для отримання квитанції за конкретним платежем вам необхідно сформувати запит з HTTP-методом GET та таким набором параметрів:
| Parameter | Type | Required | Description |
|---|---|---|---|
POS_ID | String | ✅ | Merchant's identifier (POS_ID) |
ORDER_ID | String | ✅ | Merchant's order identifier |
FORMAT | String | ✅ | Receipt format (html, pdf) |
Приклад запиту:
$ curl -i "https://cpay.tranzzo.com/api/v1/pos/${POS_ID}/orders/${ORDER_ID}/report/receipt?format=${FORMAT}" \
-H "Content-Type: application/json" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
У відповідь буде отримано raw HTML.
Окрім того, за необхідності також можна отримати квитанції за всіма успішними платежами, що мали місце у певну дату. Для цього запит має містити такі параметри:
| Parameter | Type | Required | Description |
|---|---|---|---|
POS_ID | String | ✅ | Merchant's identifier (POS_ID) |
DATE | String | ✅ | Date in yyyy-MM-dd format |
FORMAT | String | ✅ | Receipt format (html, pdf) |
Приклад запиту:
$ curl -i "https://cpay.tranzzo.com/api/v1/pos/${POS_ID}/date/${DATE}/report/receipt?format=${FORMAT}" \
-H "Content-Type: application/json" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
У відповідь на такий запит вам буде відправлено ZIP-архів зі всіма квитанціями за платежами, проведеними у вказану у запиті дату.
Завантаження квитанцій через мерчант-портал
Cпособи завантажити квитанцію через мерчант-портал:
Через загальний список платежів.
Перейти на сторінку “Платежі”, знайти необхідну транзакцію у списку, натиснути три крапки (кнопку ініціювання додаткових дій) та обрати відповідну опцію у списку.
Через деталі конкретної транзакції.
На сторінці “Платежі” знайти необхідну транзакцію та перейти до перегляду її деталей, клікнувши на відповідний запис. В деталях транзакції обрати відповідну опцію у списку додаткових дій, розташованому у верхньому правому куті сторінки.
Після використання одного зі способів, файл з квитанцією буде завантажено на ваш компьютер чи мобільний пристрій.