Перейти до основного вмісту

Квитанції за платежами та кредитні довідки

Квитанція — це документ для вашого клієнта, який підтверджує факт успішної оплати/операції. Формується за типами операцій Оплата (purchase) (звичайні та спліт-платежі), Резервування (auth) та Виплата (credit). Може бути у двох форматах: PDF-файл чи raw HTML.

Квитанція за вхідними платежами (purchase, auth) може містити таку інформацію:

  • Номер квитанції/операції
  • ПІБ платника
  • Маска картки та її бренд
  • РНОКПП платника
  • Ідентифікатор платника у вашій системі
  • Назва вашого бізнесу
  • ЄДРПОУ/РНОКПП вашого бізнесу
  • IBAN вашого бізнесу
  • Сума замовлення
  • Зовнішня комісія
  • Загальна сума
  • Дата та час операції
  • Дата валютування
  • Призначення платежу
  • Сайт вашого бізнесу
  • Ідентифікатор в банку-еквайрі
  • Код авторизації
  • Вид операції
  • Ідентифікатор еквайра
  • Ідетнифікатор платіжного пристрою
  • Інформація про фінансову компанію, через яку було проведено платіж

Квитанція (платіжна інструкція) за вихідними транзакціями (credit) може містити таку інформацію:

  • Номер платіжної інструкції/операції
  • Назва вашого бізнесу
  • ЄДРПОУ/РНОКПП вашого бізнесу
  • IBAN вашого бізнесу
  • Сайт вашого бізнесу
  • ПІБ отримувача
  • Маска картки отримувача та її бренд
  • РНОКПП отримувача
  • Ідентифікатор отримувача у вашій системі
  • Сума
  • Дата та час прийняття до виконання
  • Дата та час здійснення операції
  • Номер замовлення
  • Ідентифікатор в банку-еквайрі
  • Код авторизації
  • Вид операції
  • Ідентифікатор еквайра
  • Ідентифікатор платіжного пристрою
  • Інформація про фінансову компанію, через яку було проведено транзакцію
інформація

Перелік полів, що містяться у квитанціях залежить від обсягу інформації, яка передається у кожному окремому платіжному запиті.

Способи отримання квитанцій:

  • Автоматична відправка квитанцій за платежами в межах певного проєкту на вашу е-пошту (тільки за транзакціями оплати).
  • Отримання квитанцій через запит до API.
  • Завантаження квитанцій вручну через мерчант-портал.

Окрім того, за виплатами (credit) можна отримати довідки, що є офіційними документами (вихідними листами) фінансових компаній і підтверджують факт прийняття до виконання платіжної інструкції на зарахування коштів отримувачу (позичальнику). На такі документи накладається КЕП фінансової компанії, який можна перевірити за допомогою наявних у публічному доступі ресурсів, наприклад, через сайт Дія.

Важливо

Для отримання можливості роботи з кредитними довідками зверніться до Служби підтримки Financial Line.

Кредитні довідки містять таку інформацію:

  • Унікальний вихідний номер
  • Дату формування довідки
  • Дату проведення credit-транзакції
  • Унікальний ідентифікатор транзакції
  • Суму, що була перерахована позичальнику та валюту
  • ПІБ позичальника та маска його картки
інформація

Повторно сформовані за одними й тими самими транзакціями довідки матимуть новий номер.

Способи отримання кредитних довідок:

  • Отримання довідок через запит до API.
  • Завантаження довідок вручну через мерчант-портал.

Автоматична відправка квитанцій

За кожною успішною транзакцією вам на вказану е-пошту будуть приходити листи з квитанціями у PDF-форматі Для налаштування цього способу отримання квитанцій зверніться до Служби підтримки Financial Line.

Завантаження квитанцій та кредитних довідок через запит до API

Цей спосіб дозволяє отримувати квитанції у HTML- або PDF-форматах на запит до API.

Для отримання квитанції за конкретним платежем вам необхідно сформувати запит з HTTP-методом GET та таким набором параметрів:

Path variables:

ParameterTypeRequiredDescription
POS_IDUUIDMerchant's identifier (POS_ID)
ORDER_IDStringMerchant's order identifier

Query parameters:

ParameterTypeRequiredDescription
TRANSACTION_IDUUIDMandatory for credit transactions.
If not provided, the receipt for the incoming transaction within the order will be received
FORMATStringReceipt format (html, pdf)

Приклад запиту:

$ curl -i "http://api.finline.io/api/v1/pos/${POS_ID}/orders/${ORDER_ID}/report/receipt?transactionId=TRANSACTION_ID&format=pdf" \
-H "Content-Type: application/json" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"

У відповідь буде отримано raw HTML.

Для отримання кредитних довідок query-параметр FORMAT повинен містити значення: signed_pdf

Окрім того, запит також повинен містити додатковий query-параметр:

ParameterTypeRequiredDescription
CREDIT_REFERENCEbooleanWhen true is passed, a credit reference will be received

Приклад запиту на отримання кредитної довідки:

$ curl -i "http://api.finline.io/api/v1/pos/${POS_ID}/orders/${ORDER_ID}/report/receipt?transactionId=TRANSACTION_ID&creditReference=true&format=signed_pdf" \
-H "Content-Type: application/json" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"

Окрім того, за необхідності також можна отримати квитанції за всіма успішними транзакціями певного типу, що мали місце у певну дату. Для цього запит має містити такі параметри:

ParameterTypeRequiredDescription
POS_IDStringMerchant's identifier (POS_ID)
DATEStringDate in yyyy-MM-dd format
FORMATStringReceipt format (html, pdf)
METHODENUMPayment method (purchase, auth, credit). If not provided, receipts for purchase and auth transactions will be sent

Приклад запиту:

$ curl -i "https://api.finline.io/api/v1/pos/${POS_ID}/date/${DATE}/report/receipt?format=${FORMAT}&method=credit" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"

У відповідь на такий запит вам буде відправлено ZIP-архів зі всіма квитанціями за транзакціями відповідного типу, проведеними у вказану у запиті дату.

Важливо

Квитанції за певну дату не можуть бути отримані за транзакціями purchase для спліт-платежів.

Для отримання кредитних довідок за credit-транзакціями за певний період запит повинен містити такі параметри:

ParameterTypeRequiredDescription
POS_IDStringMerchant's identifier (POS_ID)
DATEStringDate in yyyy-MM-dd format
FORMATStringsigned_pdf
METHODENUMCredit

Приклад запиту:

$ curl -i "https://api.finline.io/api/v1/pos/${POS_ID}/date/${DATE}/re port/receipt?format=signed_pdf&method=credit" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"

У відповідь на такий запит вам буде відправлено ZIP-архів зі всіма кредитними довідками за credit-транзакціями, проведеними у зазначений у запиті період.

Завантаження квитанцій та кредитних довідок через мерчант-портал

Cпособи завантажити квитанцію/кредитну довідку через мерчант-портал:

  1. Через загальний список платежів.
    Перейти на сторінку “Платежі”, знайти необхідну транзакцію у списку, натиснути три крапки (кнопку ініціювання додаткових дій) та обрати відповідну опцію у списку. Схема взаємодії сервісів

  2. Через деталі конкретної транзакції.
    На сторінці “Платежі” знайти необхідну транзакцію та перейти до перегляду її деталей, клікнувши на відповідний запис. В деталях транзакції обрати відповідну опцію у списку додаткових дій, розташованому у верхньому правому куті сторінки. Схема взаємодії сервісів

Після використання одного зі способів, файл з квитанцією/кредитною довідкою буде завантажено на ваш компʼютер чи мобільний пристрій.