Shopify

In this guide

• Install the Pin Payments app on Shopify
• Configure the app settings
• Test payments in sandbox mode
• Begin processing live payments
• Refunds, captures and voids after setup

Install the Pin Payments app on Shopify

You will need to access both the Shopify Admin Portal and your Pin Payments Dashboard during these steps.

Retrieve your Pin Payments API keys

1. Sign in to your Pin Payments Dashboard.
2. Go to the Account Section.
3. Go to API Keys.
4. Copy Secret Key.

Install the Pin Payments app

1. Browse to the Pin Payments App listing on the Shopify app store then select Add app.
2. You'll be redirected to your Shopify store where you'll be prompted to install the Pin Payments App. Select Install app.

---

Configure the app settings

After installing the app you will need to configure it before it can be activated. In Shopify, select Manage to configure the application settings.

1. Enter your Secret API Key (from your Pin Payments account).
2. Enter the billing descriptor details. This is what appears on your customers bank statement.
3. Select Save.
4. After configuring the Account Settings section, navigate to Webhooks.
5. Select Register Webhook and ensure the webhook is created successfully.

6. In the Account Settings section, validate that the Account Not Ready tag has changed to Account Ready.

7. Select the Back to Payments Settings button.
8. You will be redirected to the alternative providers page in your Shopify store.
9. Optionally, select Enable test mode if testing your integration using the Sandbox mode.
10. Select the Activate button.

---

Test payments in sandbox mode

1. In the Shopify Admin Portal, browse to Settings > Payments.
2. Under Pin Payments, select Manage.
3. In the Test mode section, select Enable test mode.
4. In the app’s settings page, ensure Sandbox mode is enabled.
5. Browse to your storefront and add a product to your cart.
6. Select your cart then proceed to checkout.
7. Enter the required billing details. We recommend using a real email address so you can receive the order confirmation.
8. Select Continue to shipping, then Continue to payment.
9. Enter the following card details:
   • Number: 4200 0000 0000 0000
   • Expiry date: any date in the future
   • CVV: 100
10. Select Pay. If you entered a genuine email address in the billing details, you'll also receive an order confirmation email.
11. In the Shopify store admin, browse to Orders to confirm that the order has gone through.
12. Sign in to your Pin Payments Dashboard.
13. Browse to Charges, and click the Test button at the top of the screen. The order payment will be displayed with a status indication, such as Success.

---

Begin processing live payments

If you're happy with the outcome of your testing and are ready to start accepting live payments, follow these steps to go live.

Pin Payments configuration

1. Sign in to your Pin Payments Dashboard.
2. Go to Account Section.
3. Go to API Keys.
4. Copy Live Secret API Key.

Shopify configuration

1. In your Shopify store's back office, browse to Settings, Payments, then select Manage next to Pin Payments.

2. Select Manage in the More Actions section.

3. On the App's configuration page, replace the API credentials with your Pin Payments live secret API key.
4. Select Disabled to disable Sandbox mode, then select Save.
5. Verify that the app’s status tag is now Account Not Ready.
6. Navigate to Webhooks.
7. Select Register Webhook and ensure the webhook was created successfully.

8. In the Account Settings section, ensure that the Account Not Ready tag has changed to Account Ready.
9. Select Back to Payments Settings to return to your store’s Payments page.
10. Deselect Test mode.

11. Select Save.

You are now ready to accept live payments from your Shopify store.

Payment refunds, captures, or voids after setup

After migrating to the new integration, orders from your original integration will still be available for post-authorization actions within Shopify's Order Management interface.

Payments that were processed using the original integration can be refunded, captured, and voided using the Shopify Order Management interface in your store’s back office.