Скасування платежу: відмінності між версіями

Версія за 10:14, 13 серпня 2025

Вступ

Метод викликається лише для платежів у статусі "accepted". Для успішного скасування має бути достатньо суми прийнятих платежів у день скасування. Можна скасовувати платежі, які не старші 30 днів. Успішне повернення після цього терміну – не гарантується, залежить від умов банків-еквайєрів.

Повернення суми на картку відбувається в строк 0-3 робочих дні, в окремих випадках – до 30 робочих днів. Це залежить від умов банку-еквайєра, через який пройшов основний платіж, а також банку-емітента.

Скасування звичайного платежу

POST /api/merchant/cancelOrder

Request

headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
  "serviceKey": "MERCHANT-TEST",
  "orderId": "test_20210217-121843",
  "transactionId": "913141164",
  "amount":"1"
}

Response

headers
body
{
  "merchantKey":"easypay-test",
  "transactionId":913141164,
  "refundTransactionId":913141464,
  "orderId":"test_20210217-121843",
  "amount":1.000000,
  "paymentState":"accepted",
  "error":null
}

Опис параметрів

Параметр	Характеристика	Коментарій
`amount`	скасована сума	для часткового скасування - передається із сумою, яку потрібно скасувати. для скасування повної суми - параметр amount не передається
`transactionId`	оригінальна транзакція	магазину чи послуги передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
`refundTransactionId`	транзакція рефанду (скасування)	транзакція рефанду (скасування)
`paymentState`	статус транзакції рефанду (скасування). Можливі значення:	Можливі значення: accepted - скасування успішне. Створено транзакцію рефанду з негативною сумою declined - скасування пройшло неуспішно pending або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен повертати "paymentState":"declined", а запит статусу транзакції скасування - "paymentState": "accepted"

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація (Повідомлення про платіж), на Merchant.UrlNotify буде одноразово надіслано POST - запит із параметром "action": "refund" та сумою (amount), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

@@ Рядок 3: / Рядок 3: @@
 Повернення суми на картку відбувається в строк 0-3 робочих дні, в окремих випадках – до 30 робочих днів. Це залежить від умов банку-еквайєра, через який пройшов основний платіж, а також банку-емітента.
+===== Скасування звичайного платежу =====
+----
+<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
+    <span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
+    <span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
+</p>
+'''Request''' <syntaxhighlight lang="json" line="1">
+headers
+"Content-Type": "application/json"
+"PartnerKey": "partnerName"
+"locale": "ua"
+"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
+"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
+"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="
+body
+{
+  "serviceKey": "MERCHANT-TEST",
+  "orderId": "test_20210217-121843",
+  "transactionId": "913141164",
+  "amount":"1"
+}
+</syntaxhighlight>
+'''Response'''<syntaxhighlight lang="json" line="1">
+headers
+body
+{
+  "merchantKey":"easypay-test",
+  "transactionId":913141164,
+  "refundTransactionId":913141464,
+  "orderId":"test_20210217-121843",
+  "amount":1.000000,
+  "paymentState":"accepted",
+  "error":null
+}
+</syntaxhighlight>
+'''<br />Опис параметрів'''
+<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
+    <!-- Перший рядок - заголовок -->
+    <tr>
+      <th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
+      <th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
+      <th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
+    </tr>
+    <!-- Другий рядок -->
+    <tr>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">скасована сума </td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">для часткового скасування - передається із сумою, яку потрібно скасувати.
+для скасування повної суми - параметр amount не передається
+</td>
+    </tr>
+    <!-- Третій рядок -->
+    <tr>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція</td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
+передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
+</td>
+    </tr>
+    <!-- Четвертий рядок -->
+    <tr>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>''' </td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">транзакція рефанду (скасування)
+</td>
+    </tr>
+    <!-- П'ятий рядок -->
+    <tr>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''  </td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування). Можливі значення: </td>
+      <td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:
+* a'''ccepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
+* '''declined''' - скасування пройшло неуспішно
+* p'''ending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
+</td>
+  </table>
+Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен  повертати '''"'''<code>paymentState</code>'''":"'''<code>declined</code>'''",''' а запит статусу транзакції скасування - '''"'''<code>paymentState</code>'''": "'''<code>accepted</code>'''"'''
+При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація ([[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]), на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром "<code>action</code>": "<code>refund</code>'''"''' та сумою (amount), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.