Запит Check Status використовується для перевірки статусу платежу по orderReference.
Запит формується на стороні продавця та передається методом POST на URL https://api.wayforpay.com/api
Параметри запиту:
Параметр | Опис | Обов'язкове |
transactionType | Тип запиту, приймає значення CHECK_STATUS | так |
merchantAccount | Унікальний ідентифікатор продавця. | так |
orderReference | Унікальний номер замовлення в системі торговця | так |
merchantSignature | Підпис запиту | так |
apiVersion | Версія протоколу. Значення за замовчуванням: 1 Значення 2 - надає передачу розширених даних у вiдповiдi - додатковi поля, доставка, коментарі. | так |
З метою підтвердження валідності даних необхідно згенерувати і передати в запиті HMAC_MD5 контрольний підпис з використанням SecretKey торговця.
Рядок, що підлягає HMAC_MD5, генерується шляхом конкатенації параметрів merchantAccount, orderReference розділених ";" (крапка з комою) в кодуванні UTF-8
Параметри відповіді:
Рядок, що підлягає HMAC_MD5, генерується шляхом конкатенації параметрів merchantAccount, orderReference, amount, currency, authCode, cardPan, transactionStatus, reasonCode розділених ";" (крапка з комою) в кодуванні UTF-8
Параметр | Опис | Приклад |
merchantAccount | Ідентифікатор продавця | test_merch_n1 |
orderReference | Унікальний номер замовлення в системі торговця | 1212dd1 |
merchantSignature | hash_hmac | |
аmount | Сума замовлення | 100 |
currency | Валюта замовлення | UAH |
authCode | Код авторизації - присвоюється банком | 324567 |
createdDate | Дата створення запиту в psp | 123456789 |
processingDate | Дата процесування транзакції | 12345678 |
cardPan | Маскування номеру картки | 42****4242 |
cardType | Тип карти: Visa / MasterCard | Visa |
issuerBankCountry | Країна карти | 980 |
issuerBankName | Ім'я Банку Банку емітента карти | PrivatBank |
transactionStatus | Статус транзакції | Approved |
reason | Причина відмови | Ok |
reasonCode | Код відмови | 1100 |
settlementDate | Дата відшкодування транзакції мерчанту | 123456789 |
settlementAmount | Сума відшкодування | 98.50 |
fee | Комісія psp | 1.50 |
refundAmount | Сума всіх повернутих коштів | 2.3 |
Приклад запиту і відповіді
{
"transactionType":"CHECK_STATUS",
"merchantAccount": "test_merch_n1",
"orderReference": "DH783023",
"merchantSignature": "b95932786cbe243a76b014846b63fe92",
"apiVersion": 1
}
{
"merchantAccount": "test_merch_n1",
"orderReference": "DH783023",
"merchantSignature":"b95932786cbe243a76b014846b63fe92",
"amount": "100",
"currency": "UAH",
"authCode": "221562",
"createdDate": 123456789,
"processingDate": 123456789,
"cardPan": "44****1212",
"cardType": "Visa",
"issuerBankCountry": "UA",
"issuerBankName": "PrivatBank",
"transactionStatus": "Approved",
"reason": "ok",
"reasonCode": "1100",
"settlementDate": "123456789",
"settlementAmount": 98.50,
"fee": 1.50
}