Installing Updated Apps

Migrating to the new PayPlan by RBC Apps

Shopify has moved to a new Payments Platform. If you added PayPlan to your store prior to July of 2022, you will need to install the new PayPlan Payment App (checkout) and Messaging App (PDP & Cart placements) in your Shopify store. This update is required in order to continue accepting PayPlan without interruption. Per Shopify, the move to a new Payments Platform will allow for more flexibility, scalability and higher performance. See press release here.

Updating will be completed in 2 Parts:

Part 1 - Installing the PayPlan App handles the checkout experience, allowing consumers to complete a transaction with PayPlan as their payment method.

Part 2 - Installing the PayPlan Messaging App allows for pre-qualification and 'as low as' pricing to be displayed on the Product and Shopping Cart pages.

App Migration Steps:

The PayPlan app allows customers to select PayPlan as a payment method on the Shopify checkout page. Updating to this app takes 5 minutes or less.

Step 1: Locate your api key, api secret, and integration keys

If you need to find your keys, you can log into your merchant portal. Sandbox keys will be needed if you plan to run any test transactions.

PayPlan Live Credentials: https://merchants.rbc.breadpayments.com/
PayPlan Sandbox Credentials: https://merchants-preview.rbc.breadpayments.com/

Once logged in, first click on "Account Settings". Then click on the Account Settings drop down and select "Access Keys" to view your credentials. Keep this page open as you will need to reference these keys shortly.

Step 2: Uninstall your existing PayPlan Gateway

Ensure that you are logged into Shopify with store owner privileges. This level of access is required to make payment method changes.

In your store admin page, navigate to settings > payments and find PayPlan under “supported payment methods”.

Click “manage”

Click “Deactivate PayPlan”

Step 3: Uninstall the existing PayPlan App

From your store admin home page, click on "Settings" in the bottom left

Then click on "Apps and sales channels"

Locate the existing PayPlan App in the list and click "Remove"

Click "Delete" to confirm.

Step 4: Install the New PayPlan App

Navigate to the New PayPlan App here: https://apps.shopify.com/rbc-payplan-app

Click “Add app”

Then click “Install app”

Click “Activate PayPlan”

Click "Manage"

Verify your desired settings and enter the keys you located in Step 1. If your previous configuration has pre-populated here, confirm that everything is correct.

Click "Save", in the top right corner.

The new PayPlan app is now installed and configured. You can continue to offer PayPlan as a payment method on your store.

Next you will need to install the PayPlan Messaging App. This app allows you to place PayPlan pre-qualification buttons throughout your site, increasing awareness of your financing option and ultimately driving conversions.

Step 5: Install the New PayPlan Messaging App

Navigate to the PayPlan Messaging App here: https://apps.shopify.com/rbcpayplan-messaging

Click “Add app”

Then click “Install app”

Now take a moment to configure the Messaging app to your needs. It is highly recommend to enable Web-hooks and Show As low as promotional pricing

IMPORTANT: To ensure that your current PayPlan integration continues to function, It is necessary to enable "Add PayPlan Scripts to 2.0 Themes". Without this setting enabled, your current PayPlan Placements may not render.

Click "Save", in the top right corner.

Congratulations, app migration is complete.

Testing Your New App

📘

We recommend you test your PayPlan integration with your sandbox keys and use a sandbox environment if you have one.

Ensure that you have entered the Sandbox Keys, that were gathered in step 1, and have checked the box labeled "Use sandbox (test) mode".

In your store admin page, navigate to settings > payments and find PayPlan under “supported payment methods”, click "Manage".

Select the box labeled "Enable test mode", then click "Save".

You can leverage the following dummy data to run test transaction while in test mode:

  • Any name, address and email
  • Mobile Number: A random sequence of 10 digits – don’t use duplicates or sequential numbers (e.g. 555-555-5555 or 123-456-7890)
  • Birth Date: A birth date before 2000
  • Last 4 Digits of SSN: 07xx (Any 4-digit number starting with 07, such as 0789) to simulate approval, or 0400 to simulate denial
  • Mobile Code / Token: 1234

When Testing is complete:

  1. From your store admin page, navigate to settings > payments and find PayPlan under “supported payment methods”, click "Manage", uncheck the "Enable Test Mode" option, then click "Save".
  2. Click "Manage in the account status section, uncheck the box labeled "Use sandbox (test) mode".

Note: You will not receive emails nor text messages when testing in sandbox mode. Please refer our Testing documentation for additional guidelines.

📘

Merchants Operating in Multiple Regions

Note: For merchants operating in multiple regions, please be sure that automatic domain redirection is configured as described here.

📘

Additional Shopify Guidance

Shopify provides additional support documentation here: https://help.shopify.com/en/manual/apps/working-with-apps