Запит Settle використовується для підтвердження списання платежу Auth. Результатом обробки запиту є списання заблокованих раніше грошових коштів з картки клієнта. Операція доступна для транзакцій Purchase і Charge (host-2-host) з типом merchantTransactionType = AUTH.
Параметри запиту
Запит c необхідними параметрами формується на стороні продавця та передається методом POST по протоколу HTTP на URL https://api.wayforpay.com/api
З метою підтвердження валідності даних повинно бути згенеровано і передано в запиті HMAC_MD5 контрольний підпис з використанням SecretKey торговця.
Рядок, що підлягає HMAC_MD5, генерується шляхом конкатенації парамаетров merchantAccount, orderReference, amount, currency розділених ";" (крапка з комою) в кодуванні
| Параметр | Опис | Обовя'зкове |
| transactionType | Тип запиту, приймає значення SETTLE | так |
| merchantAccount | Унікальний ідентифікатор продавця.. | так |
| orderReference | Унікальний номер замовлення в системі торговця | так |
| amount | Сума підтвердження списання | так |
| currency | Валюта списання | так |
| merchantSignature | підпис замовлення | так |
| apiVersion | Версія протоколу. Значання за замовчуванням: 1 | так |
| productName[] | Масив з найменуванням замовлених товарів | ні |
| productPrice[] | Масив з цінами за одиницю товару. Ця інформація буде видна на сторінці оплати замовлення | ні |
| productCount[] | Масив з кількістю замовленого товару по кожній з позицій. | ні |
Параметри відповіді:
Параметри ВІДПОВІДІ:
Рядок, що підлягає HMAC_MD5, генерується шляхом конкатенації параметрів merchantAccount, orderReference, transactionStatus, reasonCode розділених ";" (крапка з комою) в кодуванні UTF-8
| Параметр | Опис | Приклад |
| merchantAccount | ідентифікатор продавця | test_merch_n1 |
| orderReference | Унікальний номер замовлення в системі торговця | 1212dd1 |
| merchantSignature | hash_hmac | |
| amount | Сума підтвердження списання заблокованих коштів. Сума може бути ≤ сумі AUTH | 100 |
| currency | Валюта | UAH |
| authCode | код авторизації - присвоюється банком | 324567 |
| createdDate | дата створення запиту в psp | 123456789 |
| processingDate | дата процесування транзакції | 12345678 |
| cardPan | маскування номеру картки | 42****4242 |
| cardType | тип картки: Visa/MasterCard | Visa |
| issuerBankCountry | Країна карти | 980 |
| issuerBankName | Ім'я Банку карти | PrivatBank |
| recToken | токен платежу для рекаренгових списань | 121213321-3213213-3213213-321-3 |
| transactionStatus | статус транзакції | Approved |
| reason | Причина відмови | Ok |
| reasonCode | код відмови | 1100 |
| fee | Комісія psp | 0.00 |
| paymentSystem | Платіжна система, через яку був здійснений платіж. | card |
Приклад запиту та відповіді
{
"transactionType":"SETTLE",
"merchantAccount":"test_merchant",
"orderReference":"DH783023",
"amount":100,
"currency":"UAH",
"merchantSignature":"b95932786cbe243a76b014846b63fe92",
"apiVersion": 1
}{
"merchantAccount":"test_merch_n1",
"orderReference":"DH783023",
"merchantSignature":"",
"amount":100,
"currency":"UAH",
"authCode":"541963",
"createdDate":12345678,
"processingDate":12345678,
"cardPan":"41****8217",
"cardType":"visa",
"issuerBankCountry":"980",
"issuerBankName":"Privatbank",
"recToken":"",
"transactionStatus":"Approved",
"reason":ok,
"reasonCode":"1100",
"fee":0,
"paymentSystem":"card"
}