The Rapyd Works With Developer Hub

Welcome to the Rapyd Works With developer hub. You'll find comprehensive guides and documentation to help you start working with Rapyd Works With as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

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.

See List of Supported Countries (You must be domiciled here 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 Account Connection Limit

You can only connect one store per Rapyd Account.

Step 1: Get Started with Rapyd Payments

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.

Step 2: Activate the Plugin in Rapyd Client Portal

A. Sign in to Client Portal and navigate to Plugins. Select Magneto.
B. In the Magento window, click the Active toggle button.

  • Note: You can search supported countries in the search bar.

Step 3: Plugin Installation on Magento


  • 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

Installation via Magento Admin Panel

A. Place an order for the Rapyd plugin via the Magento Marketplace.



Magento calls its Plugins 'Extensions'.

B. Sign in to your Magento Admin Panel.
C. Navigate to System > Tools > Web Setup Wizard.


D. Click on Extension Manager.
E. Enter your Magento Marketplace authentication keys that can be found on the Magento Marketplace.
F. 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.



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.

Installation via Composer

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

$ composer require rapyd/rapydmagento2



Verify that you saved the authentication keys.

B. 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

C. Compile and deploy the static files via the following terminal commands:

$ php bin/magento setup:di:compile
> php bin/magento setup:static-content:deploy

Step 4: Configure the Plugin for Testing

A. In the Admin Panel, go to Stores > Configuration.


B. In the Configuration window, click on Sales > Payment Methods.


C. Scroll down to the Rapyd Payment Settings that is located in the Other Payment Methods section.


D. Set the Enabled and Test Mode fields to 'Yes'.
E. Enter your Rapyd Access Key and Secret Key for the sandbox environment in the Test access key and Test secret key fields. See also Viewing plugin keys.
F. Enter '1' in the Sort Order field.



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


H. Click on the Save Config button.

Step 5: Testing the Plugin

A. Go to your Magento test site as a customer and add an item to the cart.
B. Click on the number next to the shopping cart icon, and then click on the Proceed to Checkout banner.


C. Fill in all the required Shipping fields and click Next.


D. Select a Rapyd payment method.
E. Click on the Place Order button.


F. If required, enter additional payment details, and click the Click to Pay button.


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


H. The last payment screen displays the status of the payment.


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


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

Step 6: Configuring the Plugin for Production

A. Access the Rapyd Client Portal and set the Client Portal to production mode.
B. Sign in to your Magento Admin Panel, and scroll down to the Rapyd Payment Settings that is located in the Other Payment Methods section.


C. 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 Viewing plugin keys.
D. Set the Test Mode field to 'No'.


E. Click on the Save Config button.

Step 7: Setup a Landing Page URL

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:
A. Sign in to the Client Portal and navigate to Settings > Branding.


B. Click on the link icon and enter the URL of the landing page in the Fallback URL field.

C. Click Save.

Updated 6 months ago

Rapyd Payments Plugin for Magento

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

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.