From d6de6b48090ef78f2f794e17e8a0db7abb4ef4d4 Mon Sep 17 00:00:00 2001
From: yixian <astro.dai@royalpay.com.au>
Date: Tue, 17 Aug 2021 03:02:58 +0800
Subject: [PATCH] =?UTF-8?q?=E6=92=A4=E5=8D=95api=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/document/openapi/cn/document.yml | 29 +++++++++++++++++++++++++
 src/document/openapi/en/document.yml | 32 ++++++++++++++++++++++++++++
 2 files changed, 61 insertions(+)

diff --git a/src/document/openapi/cn/document.yml b/src/document/openapi/cn/document.yml
index e378b8311..ff8d7f5cd 100644
--- a/src/document/openapi/cn/document.yml
+++ b/src/document/openapi/cn/document.yml
@@ -1014,6 +1014,35 @@ paths:
                     description: 支付宝线上汇率
                     example:
                       4.411111
+  /gateway/partners/{partner_code}/orders/{partner_order_id}/revoke:
+    put:
+      summary: 发起撤单
+      description: 撤销订单，若订单未支付，系统会尝试拦截支付行为，若拦截失败，在确认支付的同时会自动退款。若订单已支付，系统将全额退款
+      tags:
+        - QRCode
+        - JSAPI
+        - MobileH5
+        - MiniProgram
+        - CardPayment
+        - ChannelGateway
+        - RetailPay
+        - CB Bank
+        - SDK Payment
+      parameters:
+        - name: partner_code
+          in: path
+          required: true
+        - name: partner_order_id
+          in: path
+          required: true
+          description: 需要撤销订单的单号
+      response:
+        200:
+          description: Order Status
+          content:
+            application/json:
+              schema:
+                $ref: 'components_order.yml#/orderStatus'
   /gateway/partners/{partner_code}/orders/{partner_order_id}/refunds/{partner_refund_id}:
     put:
       summary: 发起退款
diff --git a/src/document/openapi/en/document.yml b/src/document/openapi/en/document.yml
index 9fe9f7de9..cf8c00777 100644
--- a/src/document/openapi/en/document.yml
+++ b/src/document/openapi/en/document.yml
@@ -1038,6 +1038,38 @@ paths:
                     description: Alipay online exchange rate
                     example:
                       4.411111
+  /gateway/partners/{partner_code}/orders/{partner_order_id}/revoke:
+    put:
+      summary: Revoke Order
+      description: |
+        Revoke the order. If order was not paid, system will try to stop paying from customer.
+        If failed, system will make full refund after confirmed paid.
+        If order was paid already, system will make full refund directly
+      tags:
+        - QRCode
+        - JSAPI
+        - MobileH5
+        - MiniProgram
+        - CardPayment
+        - ChannelGateway
+        - RetailPay
+        - CB Bank
+        - SDK Payment
+      parameters:
+        - name: partner_code
+          in: path
+          required: true
+        - name: partner_order_id
+          in: path
+          required: true
+          description: 需要撤销订单的单号
+      response:
+        200:
+          description: Order Status
+          content:
+            application/json:
+              schema:
+                $ref: 'components_order.yml#/orderStatus'
   /gateway/partners/{partner_code}/orders/{partner_order_id}/refunds/{partner_refund_id}:
     put:
       summary: Refund Order