From 27526fe8792bd4dae09fc757307c30aac4f861b7 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 15:25:34 +0300 Subject: [PATCH] docs: added user guide for manage payment (#2194) --- docs/content/user-guide/orders/payments.md | 43 ++++++++++++++++++++-- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index c225d91297..0e9ec3f87a 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -2,10 +2,47 @@ sidebar_position: 3 --- -# Manage Payments +# Manage Order's Payments -:::note +In this document, you’ll learn how to manage an order’s payment, including capturing and refunding the payment. -This guide is coming soon. +## Overview + +When a customer places an order, using the payment provider they choose during checkout, they authorize the payment. + +The payment isn’t automatically captured. You must capture it manually from the Medusa admin. + +## Capture Payment + +:::info + +Payment can only be captured once. ::: + +To capture an order’s payment: + +1. Open the order details page. +2. Scroll to the Payment section. +3. Click on the Capture Payment button. + +## Refund Payment + +:::caution + +Payment can only be refunded after it has been captured. Refunding payments can’t be undone. + +::: + +To refund an order’s payment: + +1. Open the order details page. +2. Scroll to the Payment section. +3. Click on the Refund button. +4. In the new window that opens: + - Enter the Refund amount. It must be less than the Total Paid amount specified in the Payment section. + - Choose a reason for the refund and optionally provide a note. + - If you don’t want the customer to receive an email that the refund has been made, uncheck the “Send notifications” checkbox. +5. Once you’re done, click on the Complete button. + +You can check refund details in the Payment, Summary, and Timeline sections.