Entity🔗

now

Razorpay Invoices enables

:

Watch Out

You can share the short URL with customers to accept payments. You can print and download it. You can create QR Codes for single or multiple use and for specific or all customers.

:

QR Code Entity🔗

Retrieve details about QR Codes using the unique identifier linked to the Customer ID or a Payment ID.

refer to the:

Razorpay QR Codes enables you t

Use the below endpoint to delete a token

Use the below endpoint to fetch all tokens linked to a customer.

Use the below endpoint to fetch the token_id using a payment_id.

about

Once our system validates and successfully processes the payment request, a razorpay_payment_id is returned. In the case of some banks such as HDFC Bank and Axis Bank, the payment entity returned will be in the created state since the charge system of these banks are file-based and can take a few hours.

Use the below endpoint to create a payment and charge the customer.

Use the below endpoint to create an order:

Use the below endpoint to cancel a registration link.

Use the following endpoint to send/resend notifications with the short URL to the customer:

on Link🔗

Use the following endpoint to create a registration link.

API Dashboard

the following ways: Razorpay APIs. Registration Link.

andler Function Callback URL When you use the handler function, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Checkout Form. You need to collect these and send them to your server. When you use a Callback URL, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Callback URL.

thorization Payment🔗

The following endpoint creates an order.

Authorization transaction + auto-charge first payment You can register a customer's mandate AND charge them the first recurring payment as part of the same transaction. Know more abo

1.1. Using Razorpay APIs🔗

The following endpoint creates a customer.

Let us look at the sample given below. Looking at the source, step and reason provided in the error description, it is apparent that the payment failed at the authentication step as the customer entered an incorrect OTP. An elegant way to handle this error would

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.

Error Structure🔗

Razorpay aims to make every transaction successful for its customers. However, in the financial ecosystem errors might still occur because of intermittent communication and technical issues at multiple hops. Hence, it becomes critical for businesses to identify the source of the error, the payment step where the error occurred and the reason that caused the error. In short, you can identify the who, where and why of every payment error. This enables you to minimize or fix errors to reduce any losses. With the new error codes, Razorpay helps you build your own logic and take remedial action at your end, wherever possible. Deriving these insights can help your business to: Map and analyse top failure reasons. Identify the source of failure. Narrow down and understand if cause of the failure. Can be due to customer action or external factors (Razorpay, Gateway, Bank or Network) Identify the payment step and the exact failure reason. Display valid responses and provide meaningful next steps to your customers.

le.

Add-on Entity🔗

Know more about Add-ons

add-ons

:

Handler Function vs Callback URL:

L:

:

:

:

Know more about Offers

Offer

For example, a Subscription is to be charged on the 1st of every month. It was charged on January 01, 2021. On January 15, 2021, it was updated using the end of cycle option for the schedule_change_at parameter. In this case, the update goes live after the Subscription is charged on February 01, 2021. Such updates are said to be scheduled updates and can be cancelled using this API.

For example, a Subscription is to be charged on the 1st of every month. It was charged on January 01, 2021. On January 15, 2021, it was updated using the end of cycle option for the schedule_change_at parameter. In this case, the update goes live after the Subscription is charged on February 01, 2021. Such updates are said to be scheduled updates and details of such updates can be fetched using this API.

immediately

:

The Subscription can either be cancelled immediately or at the end of the current billing cycle. Once cancelled, the Subscription cannot be renewed or reactivated.

ns

C

These operations can also be performed using the Razorpay Dashboard.

Subscriptions allow you

ns Entity🔗

The following endpoint lets you create a plan. /plans

The plan entity has the following attributes:

Plan Entity

plan

You can create, fetch, query or cancel plans, Subscriptions and add-ons using Subscriptions APIs.

Razorpay Subscriptions lets you set up and manage recurring payments.

Razorpay Dashboard

Once an item is created, it will appear

against

View

once

payment will remain in the Authorised state and not be included in the settlement.

Upload In

Accept

besides

on a case-to-case basis.

will charge

ansfer

FAQs🔗

customer

Yes, you can offer services to your international customers from the US, UK, Europe and Canada by providing them with a local currency bank account, and they can pay in their respective currency. In the initial phase, USD ACH is available to you, whereas, in the later phases, other currency support, including SWIFT, will be available.

We have customers spread across the US, UK and Europe. We want to offer our customers a cheaper, reliable, and better payment experience. Can we collect payments in USD, GBP or EUR currency?🔗

account.

Upload Invoices🔗 You must provide invoices for all the payment transactions accepted via local currency account as mandated by our Banking partners and RBI. Razorpay allows you to upload invoices and share them for all the payments collected via the Razorpay Dashboard.

on the Razorpay Dashboard

Given below are the steps

r is given as belo

List of frequently asked questions:

his

will get

will be

activate an international Payment Link on your account through Razorpay Dashboard.

payment link

payment link or a payment page

How it Works🔗

ou

In the initial phase, USD ACH is available to you, whereas, in the later phases, other currency support, including SWIFT, will be available.

Ac

We achieve higher

Current Challenges

This is an on-demand feature. Please raise a request on your Razorpay Dashboard (My Account -> Payment Methods). Alternatively, you may connect with our Support team to get this feature activated on your Razorpay account.

Using the Local Currency Bank Transfer payment method, Indian businesses can open foreign currency accounts and accept payments from international buyers across the US and other countries without additional paperwork. This significantly improves the customer experience by allowing the international buyers to make local bank account transfer to Indian businesses. The final settlement is done in the bank accounts of Indian businesses in INR.

:

Use the following endpoint to retrieve th

the following endpoint to retrieve

You can fetch the expanded EMI details for payments using the expand[] query parameter with the Fetch Multiple Payments API.

You can fetch the expanded card details for payments using the expand[] query parameter with the Fetch Multiple Payments API.

Using this parameter will cause a sub-entity to be added to the response.

:

expand[]=card Used to expand the card details when the payment method is emi. expand[]=emi Used to expand the EMI plan details when the payment method is em

:

After the customer's bank authorises the payment, you must verify if the authorised amount deducted from the customer's account is the same as the amount paid by the customer on your website or app. You can configure automatic capture of payments on the Razorpay Dashboard. Use the above endpoint to change the payment status from authorized to captured.

Allowed values are:

You can close a smart collect account using the Close a Virtual Account API. Use the following endpoint for the same.

Code for Bank Account🔗

Code for vpa🔗

You can

You can

Use the following endpoint for the same.

Parameters🔗

Bank Transfer🔗

The response parameters are the same as those mentioned in Fetch a Payment API.

counts🔗

Entity🔗

eters🔗

You can retrieve payment details for a single virtual account using the Fetch Payments for a Virtual Account API. Use the following endpoint for the same.

You can retrieve details for all virtual accounts using the Fetch all Virtual Accounts API. Use the following endpoint for the same.

Use the following endpoint for the same.

You can create a smart collect account

You can

given on the right

Refer to the Customer API documentation to learn how to create a customer.

Use the following endpoint for the same.

receivers

With Smart Collect, you can:

then

Going forward, vpa and bank_account will be the only receiver types that will be supported.

virtual accounts

alidate that it is

nse Parameters🔗

ntity🔗

pay servers.

Note

allows you to cancel

Note

arameters🔗

by any other means as well,

The razorpay_payment_link_id​ attribute should have been stored in your system against an order, right after it was returned in the create Payment Link response. This is displayed as just id (for example, "id": "plink_FKeEiabyAAiSVQ") in the response. The razorpay_signature should be validated by your server. In order to verify the signature, you need to create a signature using razorpay_payment_link_id, razorpay_payment_link_reference_id, razorpay_payment_link_status and razorpay_payment_id​ as payload and your key_secret​ (your API secret) as secret. Java Python Ruby Go PHPCopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); String secret = "EnLs21M47BllR3X8PSFtjtbd"; JSONObject options = new JSONObject(); options.put("payment_link_reference_id", "TSsd1989"); options.put("razorpay_payment_id", "pay_IH3d0ara9bSsjQ"); options.put("payment_link_status", "paid"); options.put("payment_link_id", "plink_IH3cNucfVEgV68"); options.put("razorpay_signature", "07ae18789e35093e51d0a491eb9922646f3f82773547e5b0f67ee3f2d3bf7d5b"); boolean status = Utils.verifyPaymentLink(options, secret); Copyimport razorpay client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET")) client.utility.verify_payment_link_signature({ 'payment_link_id': payment_link_id, 'payment_link_reference_id': payment_link_reference_id, 'payment_link_status':payment_link_status, 'razorpay_payment_id': razorpay_payment_id, 'razorpay_signature': razorpay_signature }) Copyrequire "razorpay" Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET') payment_response = { payment_link_id: 'plink_IH3cNucfVEgV68', payment_link_reference_id: 'TSsd1989', payment_link_status: 'paid', razorpay_payment_id: 'pay_IH3d0ara9bSsjQ', razorpay_signature: '07ae18789e35093e51d0a491eb9922646f3f82773547e5b0f67ee3f2d3bf7d5b' } Razorpay::Utility.verify_payment_link_signature(payment_response) Copyimport ( razorpay "github.com/razorpay/razorpay-go" ) client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET") params := map[string]interface{} { "payment_link_id": "plink_IH3cNucfVEgV68", "razorpay_payment_id": "pay_IH3d0ara9bSsjQ", "payment_link_reference_id": "TSsd1989", "payment_link_status": "paid", } signature := "07ae18789e35093e51d0a491eb9922646f3f82773547e5b0f67ee3f2d3bf7d5b"; secret := "EnLs21M47BllR3X8PSFtjtbd"; utils.VerifyPaymentLinkSignature(params, signature, secret) Copy$api = new Api($key_id, $secret); $api->utility->verifyPaymentSignature(array('razorpay_payment_link_id' => $razorpayPaymentlinkId, 'razorpay_payment_id' => $razorpayPaymentId, 'razorpay_payment_link_reference_id' => $razorpayPaymentLinkReferenceId, 'razorpay_payment_link_status' => $razorpayPaymentLinkStatus, 'razorpay_signature' => $razorpayPaymentLinkSignature)); After validating the signature, you should fetch the order in your system corresponding to the razorpay_payment_link_id​ and mark this order as successful.

Verify Signature🔗

appear appended

Using callback_url Parameter🔗

:

Sample Codes for UPI Payment Links🔗

Sample Codes for Standard Payment Links🔗

:

Refer to the list of supported currencies. Refer to the list of supported currencies.

Following table lists the attributes and their explanations, which are sent in the request body:

Use these sample codes for UPI Payment Links.

Use these sample codes for Standard Payment Links.

Basic Payment Links

normal

as per your business preferences.

You have the option to create basic or customized Payment Links:

/payment_links

Use the below endpoint to create a basic Payment Link.

, non-customized

t methods.

Note

-

accept_partial optional

The following table details some of the attributes related to Payment Links:

Retrieve information about payment links.

Payment Links

You can easily set up and use Payment Links with these APIs.

t by ID🔗

ments🔗

on on APIs used as

Content🔗

nformation🔗

ument🔗

Post successful document creation, the corresponding document_id (present in response) can be provided in cases such as dispute evidence submission.

ments Entity🔗

ntity🔗

ispute🔗

irreversible

pute🔗

putes🔗

Entity🔗

You can manage your customer disputes using the Razorpay Disputes APIs.

dispute

meters table.

You can modify an existing order to update the Notes field only. Notes can be used to record additional information about the order. A key-value store, the notes field can have a maximum of 15 key-value pairs, each of 256 characters (maximum).

Using the PATCH operation, you can replace the entire notes object for the entity.

meters🔗

You can retrieve all the payments made for an order. The response contains all the authorised or failed payments for that order.

-

page

owing fields:

Payment Links, Payment Pages, Subscription Links, Invoices and Smart Collect.

Visit our Introduction to Razorpay page to find the right integration method for you.

Know more about Orders.

Order creation is important as it helps you associate every payment with an order, thus preventing multiple payments. It is compulsory to create orders to capture payments automatically. The order ID secures the payment request and one cannot tamper with the order amount

orders

Refer the webhook documentation to know more about Razorpay Webhooks.