How to configure Cashfree payment gateway?
Cashfree Payment Gateway allows you to accept online payments from customers. Enter the required Cashfree credentials, activate the gateway, and configure the BuildMyStore webhook to receive payment status updates.
Prerequisites
- You need an active Cashfree account.
- You need the credentials provided by Cashfree.
- Online Payment must be enabled before configuring the gateway.
Step-by-Step Guide
- Web App
- Mobile App
- Open Payments: Log in to BuildMyStore Web App, open Settings, and click Payments.
- Enable Payment Gateways: Turn on the Payment Gateways toggle.
- Open Cashfree: Find Cashfree and click Configure.
- Enter Cashfree Credentials: Enter the App ID and Secret Key.
- Save Credentials: Click Save Credentials.
- Activate Cashfree: Click Activate.
Cashfree is now activated for your store.
- Open Payment Methods: Log in to BuildMyStore Mobile App, open More, and select Payments & Tax → Payment Methods.
- Enable Online Payment: Turn on the Online Payment toggle.
- Open Cashfree: Find Cashfree and tap Setup.
- Enter Cashfree Credentials: Enter the App ID and Secret Key.
- Save Credentials: Tap Save Credentials.
- Activate Cashfree: Turn on the Cashfree toggle.
Cashfree is now activated for your store.
Configure the BuildMyStore Webhook in Cashfree
Configure the BuildMyStore webhook from the Cashfree Dashboard to receive payment status updates.
Step-by-Step Guide
- Open Webhooks: Log in to the Cashfree Dashboard, open Developers, and select Webhooks.
- Add a webhook endpoint: Click Add Webhook Endpoint.
- Enter the BuildMyStore webhook URL: In Endpoint URL, enter:
https://api.buildmystore.io/api/pg-webhook/update-cashfree-payment-status - Select the webhook version: Select the latest Webhook Version from the dropdown.
- Add the policy: Under Add Policy, use the Default retry policy.
- Select payment events: Select these payment events: Success payment, Failed payment, Refund, and User dropped payment.
- Save the webhook: Complete the webhook setup and save the configuration.
The BuildMyStore webhook is now configured in Cashfree.
Frequently Asked Questions
You need the App ID and Secret Key provided by Cashfree.
No. After saving the credentials, you must activate Cashfree from the payment gateway settings.
Yes. Use Configure on Web App or Edit on Mobile App to update the credentials.
Troubleshooting
Cause
Payment Gateways may be turned off on Web App, or Online Payment may be turned off on Mobile App.
Solution
Turn on the required payment option and check for Cashfree again.
Cause
The required credentials may not have been saved successfully.
Solution
Enter the App ID and Secret Key, save the credentials, and then activate Cashfree.