2,250 Matching Annotations
  1. Apr 2022
    1. Address Verification System

      Should we add this under Related Information as a hyperlink as we have done for other integration docs rather than adding this as a page here? Check with Vinita.

    1. Best Practices & Glossary

      Dont group this together.

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

      remove

    3. HTTPS Status Codesđź”—

      HTTP Status Codes

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

      Add sample codes for each type

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

      Add small code samples along with responses

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

      What the server does when the client calls an API depends on the following information: * An identifier for the resource: This is the URL for the resource also known as the endpoint. * Operation you want to perform on the resource (in the form of an HTTP method or verb): GET, POST, PUT, PATCH and DELETE.

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

      Example

      Use the Razorpay Payments API to fetch a specific payment (the resource) details. The API response returns the state of the payment, including payment amount, currency, payment method and more. The representation of the state can be in a JSON format.

      Add Sample code

    8. 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).

      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 (e.g., creating a new user) or changing existing resources (e.g., editing a post).

    9. Back to Basicsđź”—

      API Basics<br> Make this a separate page below Introduction

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

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

    11. conform to

      follow

    12. s?đź”—

      remove question mark

    13. The Partners APIs use the following gateway URL:

      Partners API Gateway URL<br> https://api.razorpay.com/v2 Blue color callout

    14. Versioningđź”—

      Make this H1

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

      Example

    16. and Glossary

      Make Glossary as the last bullet

    17. API Authentication and Sandbox Setup

      API Authentication & Sandbox Setup

    18. Quick Start videođź”— Watch this video to know how to get started with Razorpay APIs.

      Move this after Try Razorpay APIs section

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

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

    20. API Keys.

      this is broken link

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

      Test and Live Mode 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.

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

      After the integration or product testing is complete: 1. Switch to the live mode of the Razorpay Dashboard and generate the live API keys. 2. Switch the test API keys with the live keys to take the integration live.

    2. the test mode.

      Add a screen shot

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

      Your customers cannot make payments in the test mode.

    4. ,

      full stop.

    5. Live Mode API Keys

      Live Mode API Keys

      Watch this video to see how to generate API keys in the live mode.

    6. Test Mode API Keys

      Test Mode API Keys

      Watch this video to see how to generate API keys in the test mode.

    7. Generate API Keysđź”—

      Heading 1

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

      Check how to authenticate the APIs.

    9. below:

      add a screen shot

  2. betasite.razorpay.com betasite.razorpay.com
    1. , business

      or business.

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

      All successful responses return the HTTP status code 200. In case of failures, Razorpay APIs return JSON error responses with parameters that explain the failure reasons.

    3. and Glossary

      separate bullet

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

      Razorpay uses a request Rate Limiter to limit the number of requests received by the API within a time frame. Rate Limiter helps maintain system stability during heavy traffic loads.

      • While integrating with any APIs, watch for HTTP status code 429 and build the retry mechanism based on the requirement.
      • Use an Exponential backoff/stepped backoff strategy to reduce request volume and stay within the limit.
      • Add some randomization within the backoff schedule to avoid the thundering herd effect.
    2. ,

      remove

    3. ,

      remove

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

      Example

      <br> If you want to get information on all the payments received from customers, the result could be a massive response with hundreds of payments.

      Use a combination of the query parameters given below to receive a specific number of records in the API response.

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

      Follow these best practices while working with APIs. * 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. * If you are using Razorpay SDKs, our SDKs can handle DNS caching and honor the TTLs that are set in the records.

    1. and Glossary

      Glossary separate last bullet

    2. For example, you can store the notes related to:

      Example

    3. In this section, we discuss

      Understand the API entity structure and how to send metadata using the notes object parameter in the API request body.

    4. and

      &

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

      Indent

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

      Indent

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

      Indent

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

      Indent

    1. Build Integration

      Add something like this: Follow the steps given below to integrate Razorpay Payment Gateway with your PHP website. The integration process is explained using the Ruby sample app, which contains the following files:

      We used something similar for mobile SDKs. Please check

    2. 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:
    3. If case

      If you want to...

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

      Indent

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

      Indent

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

      Indent

    1. with other

      Integrate With Other Razorpay Products

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

      This should come right after the Page Title

    1. 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:

      You can either download or run a composer command to install Razorpay PHP SDK.

      Download

      Download the latest razorpay-php.zip file from the releases section on GitHub. The razorpay-php.zip is pre-compiled to include all dependencies.

      Using Composer Command

      You can install Razorpay using a composer command. Run the below command on your Composer: Unzip the SDK file and include the Razorpay.php file in your project.

    1. s. Replace the order id.

      add sample code

    2. 1. I have configured the payment method, yet the error thrown in payment method is not configured. What shall I do?đź”—

      I have configured the payment method. But, I still see the following error message, payment method is not configured. How do I fix this? This error may also appear if the API key ID is not added to the checkout code. Check and add the API key ID.

      add sample code

    3. Frequently Asked Questions

      Frequently Asked Questions (FAQs) FAQs in the left nav

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

      Indent

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

      Indent

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

      Indent correctly

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

      Add this in a Callout

      Watch Out! After you cancel an existing subscription is canceled, you cannot restart it.

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

      Razorpay Subscriptions plugin for WooCommerce does not support updating of an existing subscription product. So, if you want to update a subscription product, you should create a new subscription product.

      Watch Out! 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. The reactivate button will only be displayed where the payment is not due.
    3. OR

      remove

    4. altogether

      remove

    5. 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 refund the subscription amount to a customer, 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 drop-down list.

    6. to cancel a subscription:

      To cancel a subscription:

    7. Update the Subscription Productđź”—

      Update Subscriptions Product

    1. Webhook Events

      Do we need this page here? I do not see anything different between this and the other Subscribe to Webhooks page.

    1. Understand the Subscription Statusđź”—

      WooCommerce Subscriptions Status And Razorpay Subscription Status Mapping

    2. Refer to the Razorpay Subscriptions status flow here.

      Know more about the Razorpay Subscriptions states. Hyperlink Razorpay Subscriptions states

    1. the

      remove

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

      To integrate Razorpay Payment Gateway on your Go website:

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

      Follow the steps given below to integrate Razorpay Payment Gateway with your Go website. The integration process is explained using the Go sample app, which contains the following files:

    1. If you have any queries, raise a ticket on Razorpay Support Portal. If you have a feature request, create an issue on GitHub.
      • Queries: If you have queries, raise a ticket on the Razorpay Support Portal.
      • Feature Request: If you have a feature request, create an issue on GitHub.
    2. GO SDK

      Go SDK

    3. GO

      Go

    4. Razorpay GO SDK

      Razorpay Go SDK

    1. the

      remove

    2. Install the Razorpay Python SDKđź”—

      Install Razorpay Python SDKđź”—

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

      To integrate Razorpay Payment Gateway on your Python website:

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

      Follow the steps given below to integrate Razorpay Payment Gateway with your Python website. The integration process is explained using the Python sample app, which contains the following files:

    1. If you have any queries, raise a ticket on Razorpay Support Portal. If you have a feature request, create an issue on GitHub.
      • Query: If you have any queries, raise a ticket on Razorpay Support Portal.
      • Feature Request: If you have a feature request, create an issue on GitHub.
    2. Supported Python versions: 3.3 and above. Also support the older versions 2.7 and 2.7.6.

      Supported Python Versions: 2.7, 2.7.6, 3.3 and above

    1. to integrate Razorpay Payment Gateway with Java SDK:

      To integrate Razorpay Payment Gateway with Java SDK:

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

      The time is represented as Unix timestamp, which can be obtained using the Utils.ToUnixTimestamp method.

    3. Amount must always be in currency subunits
      • The amount must always be in currency subunits
    4. ntegration

      Add these sentences: Follow the steps given below to integrate Razorpay Payment Gateway with your Java website. The integration process is explained using the Java sample app, which contains the following files:

    1. Java based

      Java-based

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

      Razorpay supports these payment methods and international currencies. [Hyperlink payment methods, international currencies]

    3. using

      Using

    1. Store Fields in your Serverđź”—

      Store Fields in Your Server

    2. Create an Order on Your Serverđź”—

      Create an Order in Your Serverđź”—

    3. Know more about configuring payment methods.

      remove

    4. Add the Checkout Codeđź”—

      Add Checkout Code

    5. The

      remove

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

      To integrate the Payment Gateway on your .NET website:

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

      Follow the steps given below to integrate Razorpay Payment Gateway with your .Net website. The integration process is explained using the .NET sample app, which contains the following files:

    1. dll

      DLLs

    2. download the SDK from GitHub

      hyperlink

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

      No bullets Razorpay supports these payment methods and international currencies. [Hyperlink payment methods, international currencies]

    1. If you have any queries, raise a ticket on Razorpay Support Portal. If you have a feature request, create an issue on GitHub.
      • Queries: If you have queries, raise a ticket on the Razorpay Support Portal.
      • Feature Request: If you have a feature request, create an issue on GitHub.

      [For consistency]

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

      TLS version 1.2 works only with .NET version 4.5. Using it with a lower .NET version will lead to errors. Check the FAQs & Troubleshooting steps. [Hyperlink FAQs & Troubleshooting]

    1. Commerce

      Have a few comments about the left navigation, please talk to me.

    2. Prerequisitesđź”—

      Follow the same standards for the other integrations docs.

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

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

    4. Customers are not redirected from your website to make payments.

      Customers can make payments on your website without any redirections.

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

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

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

      Razorpay Subscriptions plugin provides a quick and customer-friendly integration.

    1. Setup Webhooksđź”—

      Are these steps different from the generic webhook setup? If no, lets just redirect the user.

      Know more about how to set up webhooks and the list of available events and sample payloads. Hypelink setting up webhooks, available events and sample payloads.

    2. webhook

      link to webhooks article

    3. Enable Webhooksđź”—

      Step 4: Enable Webhooks

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

      The product is created successfully. Similarly, create another Subscriptions product for GoFlicks StandardWatch.

      • Check that the products are visible on the website to the users so that they can add it to their cart.
      • Make a test transaction to ensure that the integration is working properly.
    5. Let's assum

      Add a heading 3 as Example

    6. ,

      remove comma

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

      Enter the price. Select every as the interval and month as the duration.

    8. -

      Use colons at all places

    9. In

      Under

    10. checkbox

      check box

    11. dropdown

      drop-down

    12. checkout.

      remove the extra cell from the table

    13. screen

      page

    14. In

      On

    15. In

      Under

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

      Remove the extra cell in the last row of the table

    17. Dashboard.

      Check the font size in the table. It looks different at certain places.

    18. in

      on

    19. Complete the webhook enablement process on Razorpay Dashboard.

      Set up webhooks from the Razorpay Dashboard. Hyperlink set up webhooks

    20. screen

      page

    21. In

      On

    22. In

      Under

    23. Create a Subscriptions Productđź”—

      Step 3: Create a Subscriptions Products

    24. Configure WooCommerce Settingsđź”—

      Step 2: Configure WooCommerce Settings

    25. Install the Razorpay Subscriptions for WooCommerce Plugin

      Step 1: Install Razorpay Subscriptions for WooCommerce Plugin

    26. On Razorpay Dashboard:

      Use heading 4 and remove the colon

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

      Follow the steps given below to integrate Razorpay Payment Gateway to your WooCommerce-enabled WordPress site using the Razorpay Subscription for WooCommerce plugin.

    28. To start accepting subscription payments using the plugin:

      Follow these steps to complete the integration:

    29. On Your WordPress Site:

      Use Heading 4 and remove the colon

  4. Feb 2022
    1. Zap

      What is a Zap [Handy Tips] Provide a brief description about what is a zap. You can find the information from the Zapier help articles.

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

      Bullet these

    3. Zapier

      Integrate Razorpay Payment Pages with Zapier [hyperlink Zapier] and move data between applications with triggers and actions. Zapier is a tool that helps you automate repetitive tasks between two or more apps without using a single line of code. When an event happens in one app, Zapier can tell another app to perform a particular action.

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

      fix the code for hyperlink

    2. Installation Without Composerđź”—

      Install Without Composer

    3. Installation via Composerđź”—

      Install Using Composer

    4. ur test mode

      fix the alignment of the screen shot

    5. Learn

      Know

    6. upgrade to the the latest version using composer.

      hyperlink upgrade

    7. :

      remove colon

    8. existing

      an

    9. Select Yes for the option Enabled.

      Select Yes for the Enabled option. Check numbering

    10. Scroll down,

      Scroll down. Click Razorpay.. Check the numbering and the screen shot numbering

    11. Configuration

      the Configuration Highlight in the screen shot

    12. Step 2: Configure Magento Store 1.xđź”—

      Use Heading 2

    13. Install without Magento Connectđź”—

      Heading 4

    14. Install via Magento Connectđź”—

      Use Heading 4

    15. Install the Repositoryđź”—

      Install Repository [Use Heading 3]

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

      With Onepage Checkout you can gather the required information from the shopper and complete the checkout process quickly.

    17. Onepage Checkout (IWD or Fire Checkout)

      bold this

    18. download

      hyperlink download

    19. Download

      Hyperlink download

    20. Download the Required Repositoryđź”—

      Download Repository [Use Heading 3]

    21. Step 1: Download and Install via Repositoryđź”—

      Use Heading Style 2

    1. Sign up for a Razorpay account.

      Create a Razorpay account. Hyperlink Razorpay account

    2. plugin.

      which version is this? mention that within a bracket

    3. We support the following versions of Magento:

      In continuation to the previous sentence

    4. ,

      remove comma

    1. If Not Collecting Customer Consentđź”—

      Business Not Collecting Customer Consent

    2. If Collecting Customer Consentđź”—

      Business Collecting Customer Consent

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

      Follow these steps:

      1. Log into the Razorpay Dashboard.
      2. Navigate to Settings → Configuration.
      3. Enable the Collect Consent from Customers feature. This means that Razorpay is responsible for collecting the customer consent.
    4. 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:

      If you can collect consent from a few of your users (possibly, new app versions) but unable to collect consent for the rest of your users (possibly, on old app versions), follow the steps below.

    5. Scenario 3 - Business can Seek Consent from some Customers Only

      Same changes as in Scenario 1

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

      Put this as Handy Tips Delete Saved Card Details Customers can delete their card details. [Hyperlink delete saved card details. Check this demo and follow the on-screen instructions.