API Classes and Methods
API classes and methods available for the Flutter plugin.
Documented below is the API package for the plugin.
open(map<String, dynamic> options)
Opens the checkout.
on(String eventName, Function listener)
Registers event listeners for payment events.
• eventName
: The name of the event.
• listener
: The function to be called. The listener should accept a single argument of the following type:
◦
◦ for EVENT_PAYMENT_FAILURE
◦ for EVENT_EXTERNAL_WALLET
clear()
Clears all listeners.
Handy Tips
The options
map has key
as a required property in the open checkout method. All other properties are optional. Know about all the
The event names have been exposed as strings
by the Razorpay
class.
Event Name | Description |
---|---|
EVENT_PAYMENT_SUCCESS | The payment was successful. |
EVENT_PAYMENT_ERROR | The payment was not successful. |
EVENT_EXTERNAL_WALLET | An external wallet was selected. |
Field Name | Data type Description |
---|---|
paymentId | string The ID for the payment. |
orderId | string The order ID if the payment was for an order, otherwise null . |
signature | string The signature to be used for payment verification. Only valid for orders, otherwise null . |
Field Name | Data type Description |
---|---|
code | integer The . |
message | string The . |
Field Name | Data Type Description |
---|---|
walletName | string The name of the external wallet selected. |
The error codes are exposed as integers by the Razorpay
class. The error code is available as the code field of the PaymentFailureResponse
instance passed to the callback.
Error Code | Description |
---|---|
NETWORK_ERROR | There was a network error. For example, loss of internet connectivity. |
INVALID_OPTIONS | An issue with options passed in Razorpay.open . |
PAYMENT_CANCELLED | User cancelled the payment. |
TLS_ERROR | Device does not support TLS v1.1 or TLS v1.2. |
UNKNOWN_ERROR | An unknown error occurred. |
Is this integration guide useful?
ON THIS PAGE