Address Verification System

-Serve

Best Practices & Glossary

Let us look at the success and error response status codes.

HTTPS Status Codes🔗

Path Parameters: Path parameters are part of the endpoint itself and are not optional. Query Parameters: Query parameters appear after a question mark (?) in the endpoint. Each parameter is listed in the query string right after the other, with an ampersand (&) separating them. Request Parameters: Request parameters are included in the request body and are used to send and receive data via the REST API. Response Parameters: Response parameters represent the response to a request.

Fetch all payments received by you. POST The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server. Create a Payment Link. PUT The PUT method replaces all current representations of the target resource with the request payload. Edit customer details. DELETE The DELETE method deletes the specified resource. Delete an Invoice. PATCH The PATCH method applies partial modifications to a resource. Update a Subscription.

What the server does when the client calls one of its APIs depends on the following information provided to the server: An identifier for the resource: This is the URL for the resource, also known as the endpoint. The operation you want the server to perform on that resource, in the form of an HTTP method or verb. The common HTTP methods are GET, POST, PUT, PATCH and DELETE.

For example, when a developer calls the Razorpay Payments API to fetch a specific payment (the resource), the API will return the state of that payment, including the payment amount, currency, payment method and more. The representation of the state can be in a JSON format.

A RESTful web application exposes information about itself in the form of information about its resources. It also enables the client to take actions on those resources, such as creating new resources (that is, creating a new user) or changing existing resources (that is, editing a post).

Back to Basics🔗

REST is an architectural style, or design pattern, for APIs. When a RESTful API is called, the server will transfer to the client a representation of the state of the requested resource. Web services that conform to the REST architectural style are called RESTful web services.

conform to

s?🔗

The Partners APIs use the following gateway URL:

Versioning🔗

For example, if you want to access Payments resources, the URL should be https://api.razorpay.com/v1/payments

and Glossary

API Authentication and Sandbox Setup

Quick Start video🔗 Watch this video to know how to get started with Razorpay APIs.

You can try out our APIs on the Razorpay Postman Public Workspace. Watch this video to see how to use the Razorpay Postman Public Workspace.

API Keys.

You can use Razorpay APIs in two modes, Test and Live. The API key is different for each mode. Know about generating API Keys.

After the integration or product testing is complete, you can switch to the live mode of the Razorpay Dashboard and generate the live API keys. Switch the test API keys with the live ones to take the integration live.

the test mode.

your customers will not be able to make payments in this mode.

,

Live Mode API Keys

Test Mode API Keys

Generate API Keys🔗

This section will discuss how to authenticate the APIs and test them in a sandbox environment.

below:

, business

All successful responses are returned with HTTP Status code 200. In case of failure, Razorpay API returns a JSON error response with the parameters that detail the reason for the failure.

and Glossary

Razorpay employs a request rate limiter that limits the number of requests received by the API within a time window. This is to maintain system stability in the event of unintentional high traffic loads. While integrating with any APIs, watch for HTTP status code 429 and build the retry mechanism based on the requirement. To make the best use of the limits, it is recommended to use an Exponential backoff/stepped backoff strategy to reduce request volume and stay within the limit. It is also recommended to have some randomization within the backoff schedule to avoid the thundering herd effect.

,

,

For example, if you want to get information on all the payments received from customers, the result could be a massive response with hundreds of payments.

Do not share your API Key secret with anyone or on any public platforms. This can pose security threats for your Razorpay account. While sending API requests to Razorpay servers, it is recommended to honor the TTL of the entries and not cache the DNS aggressively at your end. This is applicable when you are not using Razorpay SDKs. However, if you are using Razorpay SDKs, be informed that our SDKs can handle DNS caching and honor the TTLs that are set in the records.

and Glossary

For example, you can store the notes related to:

In this section, we discuss

and

either

Follow these steps to create:

Live

accept live payments

testing

In case of failed payments, the checkout is displayed again to facilitate payment retry.

Razorpay makes a POST call to the callback URL with the razorpay_payment_id, razorpay_order_id and razorpay_signature in the response object of the successful payment. Only successful authorisations are auto-submitted.

The customer sees your website page. The checkout returns the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature). Collect these and send them to your server.

The customer is notified about payment failure and asked to retry the payment. Know about the error parameters.

Build Integration

Download the latest razorpay-php.zip file from the releases section on GitHub. The razorpay-php.zip is pre-compiled to include all dependencies. Alternatively, you can install Razorpay using a composer command. Run the below command on your Composer:

If case

The customer is notified about payment failure and asked to retry the payment. Know about the error parameters.

The customer sees your website page. The checkout returns the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature). Collect these and send them to your server.

Razorpay makes a POST call to the callback URL with the razorpay_payment_id, razorpay_order_id and razorpay_signature in the response object of the successful payment. Only successful authorisations are auto-submitted. On Payment Failure In case of failed payments, the checkout is displayed again to facilitate payment retry.

Alternatively, you can install it by executing the following command:

with other

Razorpay offers a range of payment products to meet your business requirements. Visit our GitHub repository for sample codes.

Download the latest razorpay-php.zip file from the releases section on GitHub. The razorpay-php.zip is pre-compiled to include all dependencies. Alternatively, you can install Razorpay using a composer command. Run the below command on your Composer:

s. Replace the order id.

1. I have configured the payment method, yet the error thrown in payment method is not configured. What shall I do?🔗

Frequently Asked Questions

n case of failed payments, the checkout is displayed again to facilitate payment retry.

The customer is notified about payment failure and asked to retry the payment. Know about the error parameters.

The customer sees your website page. The checkout returns the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature). Collect these and send them to your server.

Once an existing subscription is canceled, it cannot be restarted.

Razorpay Subscriptions plugin for WooCommerce does not support the updation of an existing subscription product. It is recommended to create a new subscription product instead of updating an existing one. You cannot update the details of a subscription for a customer or upgrade or downgrade the subscription for them once it has gone live. If you modify the details of an existing subscription product on WooCommerce and make a test payment, it will appear as a New Plan on the Razorpay Dashboard. Hence, you must cancel the existing subscription and create a new one and hereafter the customer will have to subscribe to the newly created subscription. When a subscription has been put on-hold, you can use the reactivate option to restart the subscription, once you successfully charge the customer's card. This changes the subscription status to active on the Razorpay Dashboard. Note that the reactivate button will only be displayed where the payment is not due.

OR

altogether

If you need to refund money to a customer for any reason, you need to do this manually from the Razorpay Dashboard. You also need to mark the subscription as refunded on WooCommerce in WordPress Dashboard by selecting the Refunded option from the Order Status dropdown list.

to cancel a subscription:

Update the Subscription Product🔗

Webhook Events

Understand the Subscription Status🔗

Refer to the Razorpay Subscriptions status flow here.

the

Follow these steps to integrate Razorpay Payment Gateway on your GO website.

In this document, we will explain the integration process using the GO sample app, which contains the following files:

If you have any queries, raise a ticket on Razorpay Support Portal. If you have a feature request, create an issue on GitHub.

GO SDK

GO

Razorpay GO SDK

the

Install the Razorpay Python SDK🔗

Follow these steps to integrate Razorpay Payment Gateway on your Python website.

In this document, we will explain the integration process using the Python sample app, which contains the following files:

Visit our GitHub repository for sample codes.

If you have any queries, raise a ticket on Razorpay Support Portal. If you have a feature request, create an issue on GitHub.

Supported Python versions: 3.3 and above. Also support the older versions 2.7 and 2.7.6.

to integrate Razorpay Payment Gateway with Java SDK:

Time represented as Unix timestamp, which can be obtained using the Util

Amount must always be in currency subunits

ntegration

Java based

Razorpay supports these payment methods. Razorpay supports these international currencies.

using

Visit our GitHub repository for sample codes.

Frequently Asked Questions (FAQs)

Resolution:

Cause:

Error

Fix 2: Force TLS v1.2

Fix 1: Upgrade to TLS v1.1

Resolution:

Cause:

Error:

Store Fields in your Server🔗

Create an Order on Your Server🔗

Know more about configuring payment methods.

Add the Checkout Code🔗

The

After downloading the .NET sample app, follow these steps to integrate the Payment Gateway on your .NET website.

In this document, we will explain the integration process using the .NET sample app, which contains the following files:

dll

download the SDK from GitHub

Razorpay supports these payment methods. Razorpay supports these international currencies.

If you have any queries, raise a ticket on Razorpay Support Portal. If you have a feature request, create an issue on GitHub.

TLS version 1.2 will work only with .NET version 4.5. Using it with a lower .NET version will lead to errors. Refer to the FAQs section.

Commerce

Prerequisites🔗

You can accept recurring payments using Razorpay Subscription Plugin on your WooCommerce website itself via Credit Card, Debit Card, Netbanking and UPI payment methods.

Customers are not redirected from your website to make payments.

There is no need to create Plans or Subscriptions using the Razorpay Dashboard or Razorpay APIs. All this can be done easily from your WooCommerce Dashboard.

Razorpay Subscription Plugin has a very quick and customer-friendly integration.

Setup Webhooks🔗

webhook

Enable Webhooks🔗

Similarly, create another Subscriptions product for GoFlicks StandardWatch. Your product has been successfully created. Ensure that the product is visible to the website users so that they can add it to their cart. You can do this by displaying the product on your website's Shop page. Users on your site can visit this page and buy the product. For example, they can add GoFlicks PremiumWatch HD to their cart and complete the payment. Learn how to make a test transaction to ensure that the integration is working properly.

Let's assum

,

Enter the price, select every as the interval and month as the duration.

-

In

checkbox

dropdown

checkout.

screen

In

In

verification. This must match with the one added in the Razorpay Dashboard.

Dashboard.

in

Complete the webhook enablement process on Razorpay Dashboard.

screen

In

In

Create a Subscriptions Product🔗

Configure WooCommerce Settings🔗

Install the Razorpay Subscriptions for WooCommerce Plugin

On Razorpay Dashboard:

Know how to integrate Razorpay Payment Gateway to your WooCommerce-enabled WordPress site using the Razorpay Subscription for WooCommerce plugin.

To start accepting subscription payments using the plugin:

On Your WordPress Site:

the Signature🔗

r from your Server🔗

Presently,

with

Payment Capture Settings🔗

Zap

Send automated notifications from popular email automation tools like Mailchimp or Gmail for new Razorpay payments. Update your customer data in your CRM tools like Hubspot or Salesforce without any hassle. Sync information seamlessly between your accounting apps like Zoho Books or Tally. Enrol students in learning courses with new successful payments on Razorpay. Add newly-captured Razorpay payments to rows in Google Sheets. Send SMS messages through messaging tools for new payments made through Razorpay.

Zapier

Learn more about <a href="/docs/webhooks/#validation>.

Installation Without Composer🔗

Installation via Composer🔗

ur test mode

Learn

upgrade to the the latest version using composer.

:

existing

Select Yes for the option Enabled.

Scroll down,

Configuration

Step 2: Configure Magento Store 1.x🔗

Install without Magento Connect🔗

Install via Magento Connect🔗

Install the Repository🔗

The purpose of Onepage Checkout is to gather the information that is needed and to complete the sale as quickly as possible without requiring extra clicks for the shopper

Onepage Checkout (IWD or Fire Checkout)

download

Download

Download the Required Repository🔗

Step 1: Download and Install via Repository🔗

into

Download

here.

Sign up for a Razorpay account.

plugin.

We support the following versions of Magento:

,

If Not Collecting Customer Consent🔗

If Collecting Customer Consent🔗

On the Razorpay Dashboard, enable the Collect Consent from Customers feature. This means that Razorpay is responsible for collecting the consent.

In case, you are going to collect consent from few of your users (possibly, new app versions) but may not be able to collect consent for the rest of your users (possibly, on old app versions), then you have to do the following:

Scenario 3 - Business can Seek Consent from some Customers Only

Scenario 2 - Business will not Seek Customer Consent and wants Razorpay to Seek Consent

Handy Tips The customer can choose at any point of time to delete their saved card details from here.