You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/ShopifyV2.md
+49-7
Original file line number
Diff line number
Diff line change
@@ -37,24 +37,38 @@ Before diving into the setup process, ensure you have the following:
37
37
38
38
## Set up a Shopify app
39
39
40
-
First we will create a new app in the Shopify partner portal. Make sure you are registered as a [Shopify partner](https://www.shopify.com/partners) (it's free to register).
40
+
First, you need to setup a payment method on your [Shopify](https://www.shopify.com/) account.
41
+
42
+
1. In your Shopify admin page, click on `Settings` > `Payments` in the left sidebar, scroll down to "Manual payment methods", click on `(+) Manual payment method` and select `Create custom payment method` on the dropdown.
43
+
2. In `Custom payment method name` fill in `Bitcoin with BTCPay Server`, optionally you can fill in other fields, but it's not required.
44
+
3. Hit `Activate` and you've set up a payment method successfully.
45
+
46
+
:::tip
47
+
"Custom Payment method name" **must** contain at least one of the following words (case-insensitive): `bitcoin`, `btcpayserver`, `btcpay server` or `btc` to work.
48
+
:::
49
+
50
+
51
+
Next we will create a new app in the Shopify partner portal. Make sure you are registered as a [Shopify partner](https://www.shopify.com/partners) (it's free to register).
41
52
42
53
1. On Shopify Partner [dashboard](https://partners.shopify.com), click on `Apps` > `All Apps` > `Create App` > `Create app manually`. Enter the name you want to call the app (e.g. BTCPay Server) and click `Create`.
43
54
2. Once created displays your "Client ID" and "Client secret", which we need in a minute. Please note them down or come back to this page later.
44
55

45
-
3. Click on the shopify partner logo on the to return to partners dashboard
46
-
4. At the bottom of the page, click on "Settings"
56
+
3. While in your just created app page, select API access on the left menu, scroll down to `Allow network access in checkout and account UI extensions` and grant network access. You should see the following screen once network access is granted
## Deploy the Shopify-BTCPay-app on your BTCPay Server
59
73
60
74
:::tip
@@ -196,6 +210,34 @@ When you click on it you can see the payment details:
196
210

197
211
198
212
213
+
## FAQ
214
+
215
+
- What happens when an invoice is Invalid? The sum of confirmed payments up to the expiration is reflected on Shopify
216
+
217
+
- What if I mark an invoice as invalid in my BTCPay Server? BTCPay does nothing, so the Shopify order stays pending.
218
+
219
+
- What happens when an invoice is settled manually on BTCPay Server? The Shopify order is marked as fully paid in Shopify.
220
+
221
+
- What happens if the customer didn't pay? When the BTCPay invoice expires, the Shopify order is voided, and stock is returned.
222
+
223
+
- What happens if the customer did pay, but with insufficient fees for confirmation in a reasonable time? The BTCPay invoice becomes Invalid, and the Shopify order remains Payment Pending.
224
+
225
+
- What if the customer paid partially? The BTCPay invoice expires. The Shopify order stays Payment Pending or is marked Partially Paid based on confirmed payments at expiration.
226
+
227
+
- How to avoid partial payments? Partial payments often happen when customers pay from exchanges that deduct fees. You can set a small [underpayment tolerance](https://docs.btcpayserver.org/FAQ/Stores/#consider-the-invoice-paid-even-if-the-paid-amount-is-less-than-expected) in your store's settings to avoid this.
228
+
229
+
- How can I reshare an invoice link if the customer didn’t complete the payment? BTCPay Server stores the invoice link in Shopify order metafields when BTCPay is the selected payment method.
0 commit comments