Integration Steps

Steps to integrate your WordPress website with Razorpay Payment Gateway.

Available in🇮🇳 India🇸🇬 Singapore

Follow the steps given below to integrate Razorpay Payment Gateway with your WordPress website.

1. Build Integration

Install and configure the WordPress plugin.

2. Test Integration

Test the integration by making a test payment.

3. Go-Live Checklist

Check the go-live checklist.

1. Build Integration

Follow the steps given below:

1 Installation and Configuration

Watch Out!

This plugin does not support dynamic amount calculation from your webpage. You can accept only fixed amounts using this plugin. Explore our WooCommerce plugin for your use case.

1. Download the plugin from the WordPress Plugin Directory.
2. Open your WordPress site and navigate to Plugins → Add New.
3. Upload the plugin.
4. Click Activate Plugin.
5. Click Settings.
6. Make the following changes in the Edit Settings screen:
   1. Select Enable Razorpay Payment Module.
   2. Edit Title and Description as required.
   3. Add your [KEY_ID] and [KEY_SECRET]. These can be generated from your Razorpay Dashboard.
   4. Set the Payment Action to Authorize and Capture to auto-capture payments.
   5. Click Save Changes.

2 Add Custom Fields

1. In your WordPress site, open the page or blog post where you want the button to appear.
2. Click the more icon and select Preferences.
3. Click Panels and enable the Custom Fields checkbox in the Additional section. Now you will have the option to add custom fields on your page/blog post.
4. Scroll down the current page till you see the Custom fields section.

Handy Tips

If you are using WordPress 4.8 or later, the custom fields can be added via Screen Option. If you are still not able to view the custom field, refer to the FAQs.

1. Add the following three custom fields as metadata:
   1. amount (in SGD).
   2. name (name of the product).
   3. description (description of the product that is being sold).

1. Add the [RZP](shortcode indicated by square brackets) in the content section to display the Pay with Razorpay button anywhere.
2. Publish or update the page. The page appears with the Pay with Razorpay button.

Watch Out!

If the payment button does not appear, ensure the Button script is placed inside the <form> tag. This issue might be caused by certain cache plugins (for example, SpeedyCache) or Optimizer plugins (for example, SiteGround Optimizer). To resolve it, please deactivate these plugins. Once they are deactivated, the payment button should work properly.

2. Test Integration

After the integration, a Pay button will appear on your web page/app. You need to click the button and make a test transaction to ensure the integration works as expected. You can start accepting actual payments from your customers once the test is successful.

You can make test payments using one of the payment methods configured at the Checkout.

• No money is deducted from the customer’s account as this is a simulated transaction.
• Ensure you have entered the API keys generated in the test mode in the Checkout code.

Supported Payment Methods

After the integration is complete, a Pay button appears on your webpage/app.

Click the button and make a test transaction to ensure the integration is working as expected. You can start accepting actual payments from your customers once the test transaction is successful.

Watch Out!

This is a mock payment page that uses your test API keys, test card and payment details.

• Ensure you have entered only your Test Mode API keys in the Checkout code.
• Test mode features a mock bank page with Success and Failure buttons to replicate the live payment experience.
• No real money is deducted due to the usage of test API keys. This is a simulated transaction.

Following are all the payment modes that the customer can use to complete the payment on the Checkout. Some of them are available by default, while others may require approval from us. Raise a request from the Dashboard to enable such payment methods.

Payment Method	Code	Availability
Debit and Credit Cards	card	✓
PayNow	paynow	✓

You can make test payments using one of the payment methods configured at the Checkout.

Cards

You can use one of the following test cards to test transactions for your integration in Test Mode.

Card Network	Card Number	CVV & Expiry Date
Mastercard	5272 0088 0623 5705	Use a random CVV and any future date ^^
Visa	4111 1111 1111 1112

Check the following lists:

• Supported Card Networks.
• Cards Error Codes.

PayNow

You can scan the QR code and make the payment using your PayNow-enabled bank app. Razorpay will redirect to a mock page where you can make the payment a success or a failure. Since this is Test Mode, we will not redirect you to the bank portals. Know more about PayNow.

Verify Payment Status

Handy Tips

On the Razorpay Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to capture payments automatically.

You can track the payment status in three ways:

Verify Status from Dashboard

To verify the payment status from the Razorpay Dashboard:

1. Log in to the Razorpay Dashboard and navigate to Transactions → Payments.
2. Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.

Subscribe to Webhook Events

You can use Razorpay webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook’s configured URL. Know how to set up webhooks.

Example

If you have subscribed to the order.paid webhook event, you will receive a notification every time a customer pays you for an order.

Poll APIs

Poll Payment APIs to check the payment status.

3. Go-live Checklist

Follow these steps before taking the integration live:

1 Accept Live Payments

Perform an end-to-end simulation of funds flow in the Test Mode. Once confident that the integration is working as expected, switch to the Live Mode and start accepting payments from customers.

Watch Out!

Ensure you are switching your test API keys with API keys generated in Live Mode.

To generate API Keys in Live Mode on your Razorpay Dashboard:

1. Log in to the Razorpay Dashboard and switch to Live Mode on the menu.
2. Navigate to Account & Settings → API Keys → Generate Key to generate the API Key for Live Mode.
3. Download the keys and save them securely.
4. Replace the Test API Key with the Live Key in the Checkout code and start accepting actual payments.

2 Payment Capture

After payment is authorized, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.

Watch Out

• You should deliver the products or services to your customers only after the payment is captured. Razorpay automatically refunds all the uncaptured payments.
• You can track the payment status using our Fetch a Payment API or webhooks.

Auto-capture Payments (Recommended)

Authorized payments can be automatically captured. You can auto-capture all payments using global settings on the Razorpay Dashboard. Know more about capture settings for payments.

Watch Out!

Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the Orders API.

Manually Capture Payments

Each authorized payment can also be captured individually. You can manually capture payments using Payment Capture API or Dashboard. Know more about capture settings for payments.