148 Matching Annotations
  1. Feb 2024
    1. You can configure the theme colour and logo as per your platform theme to provide a seamless onboarding experience for your sub-merchants.

      Can we add the same 3 color image from overview here?

    1. The parameter descriptions are present in the Account API Entity.

      Lets add the account entity here. Referencing to another page makes it difficult to read. If this makes the page too long, we can break the Onboarding SDK into mutiple pages

    2. Use onboarding APIs to add KYC details of your clients. You can pre-fill all or a few KYC details using APIs and let the users fill in the remaining on the onboarding form.

      Lets add a statement after this

      "Here are the APIs that are available for Onboarding customers"

    1. Custom Onboarding SDK enables you to onboard customers to Razorpay Payments within your platform. You can create a customer account using APIs and pre-fill KYC details, or have your client sign up and complete KYC verification.

      Custom Onboarding SDK allows you to perform Razorpay signup and KYC steps through API. With this, you can collect details and documents within your UI instead of Razorpay hosted UI.

    2. Prerequisites

      Can we move pre-requisites to the end? We are introducing two types of onboarding in previous statement. Ideally it should be followed by explaining those two types..

    3. Co-branded Onboarding UI offers customisation for Partners to configure colour, theme, logo and brand name to mimic your platform environment.

      Can we add the 3 color image post this statement?

  2. Jul 2023
    1. Razorpay APIs are generally authenticated using Basic Auth, but as a Platform, you need to authenticate using Bearer Auth with your access_token.

      Lets not make this a call out. We already established this. Lets add a regular text that says we need to use auth token created in so and so step for accessing this API

  3. Jun 2023
    1. To create a Partner account, contact your sales point of contact or submit a request form. Our team will further help you with onboarding.

      Sign-up as Razorpay Partner using steps here. Contact your sales POC to enable Platform Partnerships for your account

    2. Etsy, for example, enables artists to sell their artwork online. From the amount received from customers, Etsy charges their fee, routes the delivery fees to the logistics partner, and sends the remaining to the artists.

      Lets break this into next para

    3. Shopify, for example, allows sellers to set up online stores. Shopify enables sellers to accept payments from their customers using Razorpay. Shopify can charge a fixed monthly fee or a percentage fee on transactions through its platform.

      Can we put this into next paragraph? This is one long para right now

    4. Use Razorpay for Platforms and Marketplaces to offer end-to-end payment solutions to businesses on your platform. Onboard businesses, process payments and control the flow of funds.

      Razorpay for Platforms and Marketplaces allows you to onboard businesses, process payments and control flow of funds all within your platform.

    1. Third-party service providers can download reports from their Linked Account Dashboards. To download reports, you (the Platform) must provide Dashboard access to the Linked Account. Know how Linked Accounts can view and download reports.

      I updated content for this section in doc. Please check

    1. Once the token is generated, use the below API to create an Order and process payments.

      Using the access token generated, you can view create payments, refunds, payment links or other entities on behalf of your sub-merchants.

      Use our API reference guide <here> to see full list of all APIs available from Razorpay.

      Here is a sample API request using OAuth Access Token

  4. May 2023
  5. Feb 2023
  6. May 2022
    1. Authorisation Response

      Can we do this with a request and response code block that we user everywhere? A separate section is not needed for both. A simple code block with a section explaining all params is good enough

    1. 1. Create Application

      Can we have the end to end integration in one page? This is a simple integration. I feel we should try and cut down the content to make it simple. To fit in one page..

    1. The application redirects to the Razorpay authorisation URL. This URL requests the merchant's approval for granting access to the requested resource on Razorpay.

      Let's add another point before this where a user have to login if not logged already.

      Once logged in they will be presented a Authorisation screen

      Lets add a screenshot of authorise screen here

    2. Front-end interface to connect with Razorpay. This could be a button on your UI that points to the Razorpay OAuth page.

      "A front end interface for your app with a button to redirect the user to Razorpay OAuth page"

    3. You should have the following ready:

      Top most pre-requisite, they need to have a platform partner account with Razorpay.

      They can get the platform partner account created by reaching out to support

    4. Example

      Can we have a user flow diagram or a video that explains this rather than a paragraph? Basically the end the end flow for OAuth.. Or if we are doing it later, then lets make this example more structured with bullets maybe

    5. The token is short-lived, with an expiry time of generally 15-20 days, which lowers the chance of misuse.

      As of today, the token don't have any expiry. We are planning to add but not available now.

  7. Feb 2022
  8. Jan 2022
  9. Oct 2021
    1. Throttling🔗

      The structure of the content doesn't look correct. Throttling Techniques, Rules and limits and Dashboard actions should be subsections under Throttling. If required we can make a separate section under platform called "Edge - Throttling"

  10. May 2021
    1. Order of Webhooks

      The actual point of this section is that webhooks will not be delivered in the same order as they occur. We should highlight that.

      Currently, that is not prominent here.

    2. Idempotency means calling a method multiple times without changing the result. The idempotent methods are required for Webhooks because a resource may be called multiple times if the network is interrupted. In this scenario, non-idempotent operations can cause significant unintended side-effects by creating additional resources or changing them unexpectedly. For businesses that rely on data, non-idempotency poses a considerable risk.

      I don't think we need this paragraph.

      We can start with -

      There could be scenarios where your endpoint might receive same webhook event multiple times. This is expected as per design and can be handled easily using x-razorpay-event-id header

      Check the value of x-razorpay-event-id in the webhook request header. The value for this header is unique per event You can cross reference on your end to identify if an event with same header is processed on your end already to avoid duplicates.

      But why do Razorpay sends same event multiple times? To avoid an event being missed, Razorpay follows at-least-once delivery semantics. In this approach, if we do not receive a successful response from your server, we resend the Webhook.

      There could be situations where your server accepts the event but fails to return a response in 5 seconds. In such cases, the session is marked timeout. It is assumed that the Webhook has not been processed and is sent again. Ensure your server is configured to handle or receive the same event details multiple times using the solution as mentioned above.

    1. In the Alert Email field, enter the email address to which the notifications should be sent in case of webhook failure

      In next line -

      You will receive webhook deactivation notifications to this address. Refer <webhook deactivation> for more details.

    2. Razorpay will send you an email notification when a webhook gets disabled due to multiple failures.

      When a webhook gets disabled, Razorpay will send you an email notification on "alert email" as configured during set-up.

    3. Enter a Secret for the webhook endpoint. The secret is used to validate that the webhook is from Razorpay. Do not expose the secret publicly.

      Can we give a reference to Validate webhooks here? May a one liner that says, if you configured a secret, here is how you can validate the signature on your end. <link>

  11. betasite.razorpay.com betasite.razorpay.com
    1. APIs send you the data when you request for it. Webhooks send you the data when it is available.

      APIs send you the data when you request for it. For Webhooks, you don't need to make a request. You receive the data when it is available.

  12. Apr 2021
  13. betasite.razorpay.com betasite.razorpay.com
    1. Webhooks

      This section can be cut down to a 2-3 sentences with an line example.

      "APIs send you the data when you request for it. For Webhooks, you don't need to make a request. You receive the data when it is available"

      Ex: Imagine, you need to know if of a payment link is paid. With API, you will have keep polling every few seconds until someone pays. With Webhooks, you will receive the update when payment happens.

    1. You

      This can be combined with Set-up.

      The flow for set-up and edit comes together functionality wise. Separate guide may not be necessary.

      Right after set-up add a paragraph with screenshot that users can edit the webhooks whenever they want using 'edit option' '

  14. Oct 2020
    1. Against an application running on localhost.

      These two as well. Lets make it "Testing against an application running on localhost" or something else which makes the heading complete..

  15. betasite.razorpay.com betasite.razorpay.com
  16. Sep 2020
  17. betasite.razorpay.com betasite.razorpay.com
    1. Razorpay delivers webhook notifications as soon as possible. In most cases, notifications will arrive within 10 seconds of the associated event. While we try to send them in a timely manner, we do not recommend relying on webhooks for events that are time-sensitive. For business-critical, synchronous use cases, please poll our APIs for the data.

      In most cases, webhook events will be delivered within few seconds of the associated event. However, in some cases this can be delayed by few minutes due to various reasons.

      While we try to send them in a timely manner, we do not recommend relying on webhooks for events that are time-sensitive. For business-critical, synchronous use cases, please poll our APIs for the data.

  18. Jul 2020
  19. betasite.razorpay.com betasite.razorpay.com
    1. Header Value host en1kh32w54d59.x.pipedream.net Accept-Encoding gzip Content-Type application/json Request-Id FKkBreMa8jb9xh User-Agent Razorpay-Webhook/v1 X-Razorpay-Event-Id FKkBreMa8jb9xh X-Razorpay-Signature 427eb1cad49e9c0e3a69d156de61d5df041cbe6ef8ec80c8deaeaee9d5c07748 Content-Length 760 Connection keep-alive

      On second thought, I think we can remove this table. The paragraph before this table is pretty self-explanatory and clear.

  20. betasite.razorpay.com betasite.razorpay.com
  21. betasite.razorpay.com betasite.razorpay.com