Webhook Payload

Given below is the sample payload for webhook events for Razorpay Optimizer. All the parameters and events will remain the same as shown in the sample payloads for payment webhooks except for one additional parameter, gateway_provider.

Razorpay

payu_optimizer

payu_optimizer

Indicates the payment provider information.

payu_optimizer

API Response

Know how to use the Razorpay Optimizer to write rules and route transactions through different payment providers.

Given below are the supported payment providers and payment methods for Cards, Netbanking, UPI and Wallets.

Razorpay Optimizer supports wallets for PayU, CCAvenue and Paytm. Know more about wallets supported by Razorpay.

some specific information

information

Apart from the default rule, you can also create a set of custom rules for transactions. Also, you can set up priority levels. This means that if the success rate (SR) of a particular gateway assigned to Priority 1 drops below a certain level, all transactions will automatically be routed to the gateway assigned to Priority 2.

• 20% of transactions to be routed via Paytm

In addition to standard and dynamic rule-based routing, Optimizer allows you to assign priority levels to all your transactions. This means that if the success rate (SR) of a particular gateway assigned to Priority 1 drops below a certain level, all transactions will automatically be routed to the gateway assigned to Priority 2, creating a temporary downtime for the gateway assigned to Priority 1. This ensures that payment processing remains smooth and uninterrupted for your customers, even if some payment gateways are experiencing issues. Once the temporary downtime is automatically resolved, that is, when the SR of the gateway assigned to Priority 1 retains a certain level, the transactions will be routed back to the gateway assigned to Priority 1.

transactions will automatically be routed to the gateway assigned to Priority 2

all

particular

Optimizer allows you to assign priority levels to all your transactions.

Watch Out!Manual Capture settings only apply to payments processed via Razorpay and do not apply to any external payment gateway.

settle it

Manual Capture settings only apply to payments processed via Razorpay.

After the capture, the amount is settled to your account as per the settlement schedule.

Watch Out! The time frame set for Manual Capture will not apply to payments processed via external gateways. Even if you have set a manual capture setting for any number of days, the payment will be auto-refunded as per the time frame set for Auto Capture. Manual Capture settings only apply to payments processed via Razorpay.

Auto-capture + Manual Capture Timeouts

Configure Payment Capture Settings Using Orders API Capture values passed in the Orders API take precedence over the Payment Capture settings configured on the Razorpay Dashboard. You can use this to change the capture settings for individual payments.

Let us say you want to: Auto-capture payments that are authorized within 2 days from creation. Manually capture payments that are authorized within 3 days from creation. Capture SettingsSelect Automatic Capture Automatic capture timeout = 2 days.Manual capture timeout = 3 days.Payments auto-refunded ifPayments not captured by you within 2 days. Payments are authorized after 3 days. Watch this video to see how to set up the Automatic and Manual Capture with Timeout option. To configure capture settings: Log in to your Dashboard. Navigate to the Account & Settings → Capture and refund settings (under Payments and refunds section). Click Change next to Automatic Capture. Under Automatic Capture, click the drop-down and select the time period in the Capture all payments authorised within field. For example, 2 days. Click Next. Select Capture manually via dashboard or API. Click the drop-down and select the time period in the Capture payments manually authorised within field. For example, 3 days. Click Next. Click Normal Speed and Save.

and manual

manually capture payments that are authorized after that time period.

Payment Capture settings are applicable only for payments created using the Orders API. For Direct Settlement merchants, payments will be auto-captured even if they are created without using the Orders API.

Manual capture timeoutAllows you to define custom manual capture timeout.The minimum value is 12 minutes. The maximum value (default) is 5 days.

You must ensure that all payments in the authorized state are moved to captured state within 5 days of creation. This is mandatory because payments that are not captured within this time period will be refunded automatically to customers.

Late authorization

However, the payment can remain in the authorized state in the following scenarios:

Specific business use case Some businesses such as those in the Ecommerce industry, may retain the payment in the authorized state and later move them to the captured state.

Razorpay

from the bank

Due to external factors such as network issues or technical errors

Razorpay

Razorpay

, either manually or automatically

by Razorpay

Razorpay

Razorpay

Configure auto payment capture settings from the Razorpay Dashboard and using APIs.

Let us assume you want to set up a custom rule wherein you want to route all payments coming from a particular referrer code (custom identifier) to a particular payment gateway (for example, Paytm).

custom identifiers

• Channels (Website, Android, iOS) • Payment Method (Card, Netbanking, UPI Intent and UPI Collect) • BIN Number (Card IIN Number) • Card Type (Debit, Credit, Prepaid, Corporate) • Card Brand (American Express, Diners Club, Discover and so on) • Card Issuer (SBIN, HDFC, ICIC, UTIB, KKBK) • Banks (SBIN, HDFC, ICIC, UTIB) • Amount (In Paise)

Let us assume you want to set up a custom rule wherein: Priority LevelsTransaction Split - Payment Gateway/ProviderPriority 1• 70% of transactions to be routed via Paytm • 30% of transactions to be routed via RazorpayPriority 2• 100% of transactions to be routed via PineLabs This means that if the transaction attempted through Paytm and Razorpay fails in Priority 1, then as per Priority 2, the transaction will be re-attempted through PineLabs. Watch this video to see how to perform method-based routing.

Example 1 Let us assume you want to set up a custom rule wherein: Priority LevelsTransaction Split - Payment Gateway/ProviderPriority 1• 80% of transactions to be routed via Paytm • 20% of transactions to be routed via PayUPriority 2• 100% of transactions to be routed via Razorpay This means that if the transaction attempted through Paytm and PayU fails in Priority 1, then as per Priority 2, the transaction will be re-attempted through Razorpay. Watch this video to see how to perform channel-based routing.

payment

transactions

In addition, fallback priority levels can be configured. This means that if a transaction assigned as Priority 1 fails, a secondary fallback Priority 2 can be established to ensure the transaction is redirected appropriately. This provides a level of redundancy and flexibility in the routing process.

Custom Identifiers Know more about Custom Identifiers.

Custom Identifiers

You can create a set of customised rules for your transactions on the basis of various parameters.

of

All your paymnets will have a standard rule set by default. You can edit this rule as per your business requirement. With Standard Routing you can: Set basic priority for all your payments. Prioritise the gateways for all your transactions. You can set the basic priorities and manage the payment gateways by using the Default Rule. This default rule acts as a backup plan, ensuring that all transactions have a path for processing even if they do not meet the criteria specified in any of the rules.

prerequisites

We support a range of bank gateways and payment providers

Banks like Axis, ICICI, HDFC, and so on, which provide their own payment gateway accounts to accept payments. While aggregators work with banks and provide you with the ability to accept a wide range of payments.

Bank Gateways and Aggregators are the two types of payment service providers.

,

We support a range of payment methods and payment providers.

You can add Payment Providers on the Razorpay Dashboard by submitting details through a self-serve flow.

This is a secure process, where access is restricted and the details are not shared internally for any purpose other than supporting your integration. Know more about Razorpay Security.

Each gateway has a different set of prerequisites that you should adhere to. The video given below shows how to add Cashfree as a provider:

which is available on your dashboard

,

Razorpay Optimizer allows you to set up customized rules for routing transactions through multiple payment gateways. These rules can be configured based on the specific requirements of your business. Additionally, Razorpay Optimizer allows you to dynamically route transactions using various available parameters, ensuring that transactions are processed through the most appropriate payment gateway based on various factors such as payment method, amount, issuer, and more.

This process is secure, as access is limited and your information is not shared internally for anything other than assisting with your integration.

for adding

payment

Partial payments Allow your customers to make partial payments. You can also decide the first installment amount to be paid by customers in case of partial payments.

Seamlessly optimize success rates with priorities and a smart router.

Advantages

Optimize success rates and cost. Distribute traffic across payment providers. Add payment providers within rule priorities as fallback.

Watch this video to know what is Razorpay Optimizer.

Video Tutorial

You can create different rules based on payment methods, channels, card IIN number, card type, card brand, card issuer, banks and transaction amount.

You can also set up rules to route the transactions to them using various parameters like method, amount, issuer and so on.

This helps ensure a higher success rate when processing transactions.

Select Billdesk in the list of gateways available and click Next.

Configure

n the Cashfree Dashboard, select the old version for webhook responses.

Know how to save customer card details as tokens on Optimizer using Razorpay's TokenHQ solution.

Watch Out! If a merchant is a Token Requestor(TR) and tries to process a payment through PayU, the payment will not be processed. To enable this, please contact us at payments_optimizer@razorpay.com.

e Card Payment Flow🔗

Coming Soon Paytm Coming Soon

d Payment Flow🔗

If a merchant is a Token Requestor(TR) and tries to process a payment through PayU, the payment will not be processed. To enable this, please contact us at

Razorpay offers an end-to-end RBI-compliant solution that allows you to save customer credentials as tokens with card networks and card-issuing banks

the payment must be completed from the merchant or the external gateway.

Given below are a few examples of Optimizer Tokenisation flow when Razorpay is the Token Requestor.

You can use Optimizer and process payments on Razorpay and external gateways

We initiate the tokenisation request at checkout.

Feature Enablement This is an on-demand feature. Get in touch with us to get this feature enabled on your account.

If you do not wish to enable Tokenisation for Optimizer, you won't be able to use saved card flow on standard checkout.

If you have enabled Tokenisation for Optimizer, you must redirect cards traffic to the supported payment gateways only. Know more about supported payment gateways.

To enable tokenisation for external gateways on Razorpay Optimizer, please contact your external gateways support.

With this solution, you can: Process payments through any PA/PG while tokenising cards through Razorpay. Use Razorpay Optimizer to route payments through the PA/PG of your choice.

details

Enable ENACH for your account.

issues at the customers bank, UPI apps or wallets.

to t

analyse

as All Banks

analyse

as per

analyse

transactions as

various

Analyse the contribution of each payment gateway or provider to overall payments. View the payment volume distribution with the help of a pie diagram

NetBanking

ayment providers breakdown of the total success rate with the hel

View the graphical presentation of all the payment providers for Cards transactions by selecting the individual payment provider label or overall label as per your requirement.

as mentioned above

of the total success rate

failure reasons

View the payment method level breakdown of the payment volume distribution with the help of a pie diagram.

You can also view the above information in graphical representation.

for graphical representation

most top

r overall label as

high-level view of all UPI transactions and recent performance along with the payment providers details.

View the success rate

tile

success rate breakup

payment method level

significant

upported providers

If you want your unique identifier (Order ID) to be visible on PayU's dashboard, write to your PayU Relationship Manager asking to make the specific column (the one having your Order Id) visible on the dashboard. Know more about how to send your order id to Payu.

same value to PayU

In the receipt parameter, enter the Order Id you want to be visible on the PayU's dashboard.

A unique order id is generated whenever a payment is processed via Optimizer. This order id will not be visible on the PayU's dashboard as it is specific only to the merchant. You can pass your Order Id to PayU using Razorpay's Orders API.

Send Merchant Order ID to External Gateway🔗

according to

Credits

TDR charges

These credits are available only for specific business categories to help them meet regulatory requirements.

add

Refund speed for payments that were not captured (automatically or manually). Possible values:

Time in minutes till when you can manually capture payments in the authorized state.

Time in minutes till when payments in the authorized state should be auto-captured.Minimum value 12 minutes

orders

razorpay

J

D

razorpay.orders.create

v

order = Razorpay::Order.create

o

DATA

$order = $client->order->create

n this case, Razorpay polls the APIs intermittently to check the status. Once the bank confirms it to be successful, the payment attains authorized state.

override

Once a payment is created, you can auto-capture payments that are authorized within a certain time period and manually capture payments within a time period beyond that.

Payments are auto-refunded if ● Payments are not captured by you within 3 days.● Payments are authorized after 3 days.

capture authorized

Payments are auto-refunded if ● Payments are not captured by you within 3 days.● Payments are authorized after 3 days.

Payments are auto-refunded if Payments authorized after 2 days are auto-refunded.

In this case, Razorpay polls the APIs intermittently to check the status. If the bank confirms payment success, the payment is moved to authorized state.

Payments in the authorized state after the timeout are auto-refunded.

Allows you to define custom auto-capture and manual capture timeouts. ● Minimum value is 12 minutes. ● Maximum value (default) is 5 days. Manual capture timeouts Allows you to define custom auto-capture and manual capture timeouts.● Minimum value is 12 minutes.● Maximum value (default) is 5 days

Once the bank confirms it to be successful, the payment attains authorized state. Learn more about late authorization.

your

Note: