Import package#

Use the below code to import the razorpay_flutter.dart file to your project.

Copyimport 'package:razorpay_flutter/razorpay_flutter.dart';

Create Razorpay instance#

Use the below code to create a Razorpay instance.

Copy_razorpay = Razorpay();

Attach Event Listeners#

The plugin uses event-based communication and emits events when payments fail or succeed.

The event names are exposed via the constants EVENT_PAYMENT_SUCCESS, EVENT_PAYMENT_ERROR and EVENT_EXTERNAL_WALLET from the Razorpay class.

Use the on(String event, Function handler) method on the Razorpay instance to attach event listeners.

Copy_razorpay.on(Razorpay.EVENT_PAYMENT_SUCCESS, _handlePaymentSuccess);
_razorpay.on(Razorpay.EVENT_PAYMENT_ERROR, _handlePaymentError);
_razorpay.on(Razorpay.EVENT_EXTERNAL_WALLET, _handleExternalWallet);

The handlers would be defined in the class as:

Copyvoid _handlePaymentSuccess(PaymentSuccessResponse response) {
  // Do something when payment succeeds
}

void _handlePaymentError(PaymentFailureResponse response) {
  // Do something when payment fails
}

void _handleExternalWallet(ExternalWalletResponse response) {
  // Do something when an external wallet is selected
}

To clear event listeners, use the clear method on the Razorpay instance.

Copy_razorpay.clear(); // Removes all listeners

Setup Options#

Copyvar options = {
  'key': '<YOUR_KEY_ID>',
  'amount': 100, //in the smallest currency sub-unit.
  'name': 'Acme Corp.',
  'description': 'Fine T-Shirt',
  'prefill': {
    'contact': '9123456789',
    'email': 'gaurav.kumar@example.com'
  }
};

For a complete list of options for the checkout form, refer to our standard checkout documentation.

Open Checkout#

Use the below code to open the Razorpay checkout.

Copy_razorpay.open(options);

Class#

Razorpay

Method (Open Checkout)#

The below method opens the checkout.

open(map<String, dynamic> options)

The options map has key as a required property. All other properties are optional. Refer to our standard checkout documentation for a complete list of options for the checkout form.

Method (Register Event Listeners)#

The below method registers event listeners for payment events.

on(String eventName, Function listener)

• eventName: The name of the event.
• listener: The function to be called. The listener should accept a single argument of the following type:
  • PaymentSuccessResponse for EVENT_PAYMENT_SUCCESS
  • PaymentFailureResponse for EVENT_PAYMENT_FAILURE
  • ExternalWalletResponse for EVENT_EXTERNAL_WALLET

Method (Clear all Listeners)#

clear()

Error Codes#

The error codes have been exposed as integers by the Razorpay class.

The error code is available as the code field of the PaymentFailureResponse instance passed to the callback.

Event Names#

The event names have been exposed as strings by the Razorpay class.

PaymentSuccessResponse#

PaymentFailureResponse#

ExternalWalletResponse#