Skip to main content

Documentation

Rapyd Payments Plugin for Magento

Connect your Magento ecommerce site to card acceptance and hundreds of local payment methods across the globe.

Offering more payment methods drives increased conversions and customer loyalty. Rapyd offers this plugin for over 50 countries.

Rapyd Account Connection Limit

You can only connect one store per Rapyd Account.

You must be domiciled in one of the following countries in order to accept payments.

Andorra, Armenia, Austria, Australia, Belgium, Bosnia and Herzegovina, Brazil, Bulgaria, Canada, Chile, Colombia, Croatia, Cyprus, Czech Republic, Denmark, Dominican Republic, El Salvador, Estonia, Finland, France, Georgia, Germany, Gibraltar, Greece, Greenland, Hong Kong, Hungary, Iceland, India, Indonesia, Ireland, Israel, Italy, Japan, Latvia, Liechtenstein, Lithuania, Luxembourg, Macedonia, Malaysia, Malta, Mexico, Moldova, Monaco, Montenegro, Netherlands, New Zealand, Norway, Peru, Philippines, Poland, Portugal, Romania, San Marino, Singapore, Slovakia, Slovenia, South Africa, South Korea, Spain, Sweden, Switzerland, Taiwan, Thailand, Turkey, UK, USA, Vatican, Vietnam, Virgin Islands (USA)

Rapyd Client Portal account

With a Rapyd Client Portal account, you can:

  • Activate and set up your plugin.

  • Access sandbox mode and test payments.

  • View supported payment methods.

  • View payment reports.

  • Invite team members.

  • Complete KYB steps to fully activate your account.

Sign up

How to Activate Magento
  1. Sign in to Client Portal and navigate to Plugins. Select Magento.

  2. In the Magento window, click the Active toggle button.

    Note

    You can search supported countries in the search bar.

    648090577eb77.gif
  • Enable the cron command on your system. See also Magento's documentation.

  • Verify that the web server has full write permissions to the Magento directory. This can be achieved by running the following terminal command:

$ chown –R <www-username> /magento_directory
  1. Place an order for the Rapyd plugin via the Magento Marketplace.

    Note

    Magento calls its Plugins 'Extensions'.

  2. Sign in to your Magento Admin Panel.

  3. Navigate to System > Tools > Web Setup Wizard.

    6480906beabe6.png
  4. Click on Extension Manager

  5. Enter your Magento Marketplace authentication keys that can be found on the Magento Marketplace.

  6. Go to your Magento Marketplace Account section, and click Install in New Purchases. Follow the other instructions on that page to fully install the plugin.

    Note

    The installation may take 5 minutes or more. Leave the window open to allow the installation to finish. A successful installation can be verified by checking that the contents in the the directory var/.update_* have been updated.

  1. Run the following terminal command in your Magento directory:

    $ composer require rapyd/rapydmagento2

    Note

    Verify that you saved the authentication keys.

  2. Set up the plugin by running the following terminal commands:

    $ php bin/magento setup:upgrade
    > php bin/magento cache:flush
    > php bin/magento cache:clean
  3. Compile and deploy the static files via the following terminal commands:

    $ php bin/magento setup:di:compile
    > php bin/magento setup:static-content:deploy
  1. In the Admin Panel, go to Stores > Configuration.

    6480906e0ad83.png
  2. In the Configuration window, click on Sales > Payment Methods.

    6480906fb9c62.png
  3. Scroll down to the Rapyd Payment Settings that is located in the Other Payment Methods section.

    6480907186c5b.png
  4. Set the Enabled and Test Mode fields to 'Yes'

  5. Enter your Rapyd Access Key and Secret Key for the sandbox environment in the Test access key and Test secret key fields. See also Plugins and Add-Ons

  6. Enter '1' in the Sort Order field.

    Note

    The Rapyd Client Portal must be in sandbox mode during the testing phase. Refer to Developers on how to switch to sandbox.

    648090730e299.png
  7. Click on the Save Config button.

  1. Go to your Magento test site as a customer and add an item to the cart.

  2. Click on the number next to the shopping cart icon, and then click on the Proceed to Checkout banner.

    64809074788b4.png
  3. Fill in all the required Shipping fields and click Next.

    648090761a811.png
  4. Select a Rapyd payment method.

  5. Click on the Place Order button.

    64809077f2438.png
  6. If required, enter additional payment details, and click the Click to Pay button.

    64809079d37d1.png

     

  7. Click the Finish button on the screen that appears.

    6480907b6fd52.png
  8. The last payment screen displays the status of the payment.

    6480907d54876.png
  9. Go to the Sales > Orders section of the Magento Admin panel and verify that the payment you have made is displayed.

    6480907f1c606.png

    After you have finished testing the plugin, you can switch to production mode.

  1. Access the Rapyd Client Portal and set the Client Portal to production mode.

  2. Sign in to your Magento Admin Panel, and scroll down to the Rapyd Payment Settings that is located in the Other Payment Methods section.

    648090730e299.png
  3. Set the Enabled field to 'Yes', and enter your Rapyd Secret Key and Access Key for the production environment. Note that these keys are different from the sandbox keys. See also Plugins and Add-Ons.

  4. Set the Test Mode field to 'No'.

    64809081e7c56.png
  5. Click on the Save Config button.

After the checkout process completes, the customer can be forwarded to a landing page. This may be the main URL of the ecommerce site or any other landing page that you may want to define. To set the landing page URL:

  1. Sign in to the Client Portal and navigate to Settings > Branding.

    648090a7f0443.png
  2. Click on the link icon and enter the URL of the landing page in the Fallback URL field.

    648090aa75383.png
  3. Click Save.