Flutter Integration
Learn more about integrating Cashfree Flutter SDK in your mobile app
Flutter Integration Guide
This integration allows you to integrate with a Cashfree Flutter SDK in your app. You can view the integration video on Youtube.
The Flutter SDK is hosted on https://pub.dev/ you can get the sdk here. The example app is located here.
Setting Up SDK
Our Flutter SDK supports Android SDK version 19 and above and iOS minimum deployment target of 11 and above. Open your project’s pubspec.yaml
and add the following under dependencies: flutter_cashfree_pg_sdk: 2.1.7+37
iOS
Add this to your application’s info.plist
file.
Step 1: Creating an Order
The first step in the Cashfree Payment Gateway integration is to create an Order. You need to do this before any payment can be processed. You can add an endpoint to your server which creates this order and is used for communication with your frontend.
API Request for Creating an Order
Here’s a sample request for creating an order using your desired backend language. Cashfree offers backend SDKs to simplify the integration process.
You can find the SDKs here.
After successfully creating an order, you will receive a unique order_id
and payment_session_id
that you need for subsequent steps.
You can view all the complete api request and response for /orders
here.
Step 2: Opening the payment page
Web Checkout is a streamlined payment solution that integrates Cashfree’s payment gateway into your iOS app through our SDK. This implementation uses a WebView to provide a secure, feature-rich payment experience.
Your customers are presented with a familiar web interface where they can enter their payment details and complete their transaction seamlessly. All payment logic, UI components, and security measures are managed by our SDK, eliminating the need for complex custom implementation.
To complete the payment, we can follow the following steps:
- Create a CFSession object.
- Create a Web Checkout Payment object.
- Set payment callback.
- Initiate the payment using the payment object created
Create a session
This object contains essential information about the order, including the payment session ID (payment_session_id
) and order ID (order_id
) obtained from Step 1. It also specifies the environment (sandbox or production).
Create a Web Checkout Payment object
Use CFWebCheckoutPaymentBuilder
to create the payment object. This object acceps a CFSession
, like the one created in the previous step.
Setup callback
You need to set up callback handlers to handle events after payment processing.
Step 3: Sample Code
Step 4: Confirming the Payment
Once the payment is completed, you need to confirm whether the payment was successful by checking the order status. Once the payment finishes, the user will be redirected back to your activity.
To verify an order you can call our /pg/orders
endpoint from your backend. You can also use our SDK to achieve the same.
Testing
You should now have a working checkout button that redirects your customer to Cashfree payment page. If your integration isn’t working:
- Open the Network tab in your browser’s developer tools.
- Click the button and check the console logs.
- Use console.log(session) inside your button click listener to confirm the correct error returned.
Error Codes
To confirm the error returned in your android application, you can view the error codes that are exposed by the SDK.
Was this page helpful?