API hutkoВерсия 1.0

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

Параметр Тип Опис Приклад переданого мерчантом значення
order_id string(1024) Унікальний ідентифікатор замовлення. Призначається мерчантом.

обов’язковий
ID1234
merchant_id integer(12) Унікальний ідентифікатор мерчанта. Видається мерчанту після реєстрації.

обов’язковий
1
signature string(40) Підпис замовлення. Слугує для перевірки цілісності та автентичності запиту на стороні сервера платіжного шлюзу

обов’язковий
1773cf135bd89656131134b98637894dad42f808
version string(10) Версія протоколу.

Значення за замовчуванням: 1.0
1.0
amount integer(12) Сума реверсу

обов’язковий
1020 (USD) — означає 10 доларів 20 центів
currency string(3) Валюта замовлення. Допустимі значення:
UAH — українська гривня
USD — долар США
EUR — євро
GBP — фунт стерлінгів

обов’язковий
USD
comment string(1024) Коментар мерчанта, що описує причину реверсу. Кодування UTF-8 “Клієнт повернув товар”

Параметри відповіді

Параметр Тип Опис Приклад відповіді
order_id string(1024) Унікальний ідентифікатор замовлення. Призначається мерчантом. ID1234
merchant_id integer(12) Унікальний ідентифікатор мерчанта. Видається мерчанту після реєстрації. 1
reverse_status string(50) Статус обробки повернення. Може містити такі значення:
created — повернення було створено, але ще не оброблено
declined — повернення відхилено платіжним шлюзом Hutko, зовнішньою платіжною системою або банком-еквайром
approved — повернення успішно здійснено
approved
response_status string(50) Статус обробки запиту. Якщо виникла помилка під час валідації переданих параметрів, то повертається failure, інакше success  
signature string(40) Підпис замовлення. Слугує для перевірки цілісності та автентичності запиту на стороні сервера платіжного шлюзу
1773cf135bd89656131134b98637894dad42f808
response_code integer(4) Код відмови 1008
response_description string(1024) Причина відмови Parameter `amount` is mandatory

Параметри відповіді в разі помилки

Див. Параметри відповіді в разі помилки

Формування запиту

Запит реверсу на сервер Hutko завжди формується способом host-to-host на URL https://pay.hutko.org/api/reverse/order_id

Приклад host-to-host JSON

Content Type: application/json

Запит

{
   "request":{
      "order_id":"test7926651365",
      "currency":"UAH",
      "amount":"1",
      "merchant_id":"1700002",
      "signature":"b1ed592ff76ddca287503b11c1aad70bb1c67f37"
   }
}

Нормальна відповідь

{
   "response":{
      "order_id":"test309906285",
      "response_status":"success",
      "response_code":"",
      "reverse_status":"approved",
      "response_description":"",
      "merchant_id":"1700002"
   }
}

Відповідь у разі помилки

{
   "response":{
      "response_status":"failure",
      "error_message":"Order Not Found",
      "error_code":"1018"
   }
}

Хочу приймати платежі з Hutko!