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 Add-On for Xero

Accept more payment methods across the globe

Improve your customer experience and decrease late payments by offering more payment methods for online invoices sent from Xero. Rapyd’s all-in-one Xero add-on enables cards, bank transfers (including direct debit), ewallets and cash in over 50 countries.

Rapyd offers this Xero Add-on in 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)

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 Add-On Plugin from the Rapyd Client Portal

A. Sign in to Client Portal and navigate to Plugins. Select the Xero panel.

C. Set the Client Portal to Sandbox mode. See also Select environment.
D. On the Xero page, click the Active toggle button.


E. In the Xero window, click the Connect Account button.

Step 3: Login to Xero and Give Rapyd Permissions

A. Sign in to your Xero dashboard.


The Organization data page appears.
B. Select one of your organizations and click Allow Access.



Currently, you cannot connect to more than one organization.


Step 4: Configure Payments

After access is granted, the Rapyd Payments Configuration page appears.

  1. Fill in the following fields:
    - Bank Account: Select the bank account where Rapyd Payments are deposited.
    - Transaction Fee Account: Select the expense account in Xero where transaction fees are posted.
    - Branding Themes: Select Xero branding themes of invoices that will be available for Rapyd payments.
  2. Click Save.

Step 5: Create a Test Transaction on Rapyd Sandbox

Test the Rapyd payments plugin by sending an invoice and paying it in the sandbox environment.

A. Create an invoice for testing purposes, and assign it to a test contact with a billing address, phone number and email address. You must be able to sign in to the email address of this test contact.



If you are in the Xero classic invoicing mode then scroll down to the bottom of the new invoice page and click on the Switch to new invoicing link.

B. Select a currency for the invoice.
C. Click on Manage Online Payments.


The Online Payments window appears.
D. Select the Rapyd Payments Sandbox checkbox to enable this invoice to be paid via Rapyd, and click Done.



Selecting the Rapyd Payments checkbox enables multiple payment methods including credit card payments.


E. Enter the test contact’s email address and click Send.


F. Go to the inbox of the test contact’s email address and open the email that was sent from Xero.
G. Click on the Select Payment Method... button.


The browser displays the invoice online.
H. Click on the Select Payment Method... button.



Apple Pay

European customers with an Apple account may use Apple Pay for purchases when using Safari. See supported countries here.

The browser redirects you to a Rapyd checkout page for completing the payment.
I. For testing purposes, select any type of payment and if required, fill in the additional fields. For example, select a specific bank account:


J. Click Place your order.
K. Simulate a successful payment by selecting Success and clicking Pay.


The invoice is displayed as paid.


Step 6: Configure the Production Mode

A. Set the Client Portal to production mode. See also Select environment.
B. Repeat steps 2 and 3.

From this stage, when you send an invoice to a customer select Rapyd Payments from the Online Payments window.



To fully activate your account for production mode you’ll need to complete the KYB form for compliance review in the Rapyd Client Portal.

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.



Disabling requires deactivation on the Xero dashboard and deactivation on the Plugins page of the Client Portal.

Updated 24 days ago

Rapyd Payments Add-On for Xero

Accept more 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.