Connect Cashfree

Take UPI, card and netbanking payments in Indian rupees through Cashfree.

Where to find itShopSettingsPayment GatewaysCashfree

Before you start

The Payment Gateways tab must be available to you, and your platform must allow this gateway for your shop. Ask support if the Payment Gateways tab or a gateway is missing.

Needs

Turned on by support

Who can use this

Shop owner

Cashfree takes UPI, card and netbanking payments. Customers see it at checkout as "UPI / Cards / Netbanking".

Before you start

You need your own account with the provider.
Cashfree charges in INR only. Your shop's currency must be INR. It also needs the payer's Indian mobile number. So the website offers it only when your shop is in India or your checkout accepts Indian phone numbers.
You can only do this when you see the Payment Gateways tab. See Who manages your payments.

Screenshot coming soon

The Cashfree connection card on the Payment Gateways tab

Open the card
Go to Shop › Settings › Payment Gateways and select the Cashfree card to unfold it.

Fill in the connection details

Field	Required	What to enter
Is Sandbox Mode	No	On: the Cashfree sandbox. Sandbox keys work only with it on, production keys only with it off.
App ID	Yes	From the Cashfree dashboard › Developers › API Keys (Payment Gateway).
Secret Key	Yes	From the same page as the App ID. It also verifies Cashfree's webhooks. Write-only.
Pay on the checkout page	No	On: customers pay without leaving your website. Off: they are sent to the Cashfree payment page.
Saved cards	No	Returning customers see the cards they saved with Cashfree. Off: every payment starts fresh.

Point the gateway at your shop
The card shows a webhook address. It is sent with each order, so sandbox needs no set-up. In production, also add it in the Cashfree dashboard under Developers › Webhooks (Payment Gateway, latest version).
Switch it on and save
Add Cashfree to the Payment Gateways list at the top of the tab, then select Save Settings. The card shows Switched on.

Sandbox and live

The Is Sandbox Mode switch decides. On means the provider's test environment; off means live.

Test it

Connect with test credentials first, so the card reads Sandbox. Place a test order, choose this method and pay with a test payment from the provider's own documentation. Check that the order arrives in Orders. Then enter your live credentials, switch Is Sandbox Mode off and confirm the pill reads Live.

Before going live

The card lists the domains under Before going live with Cashfree. Cashfree takes live payments only from whitelisted domains. Add each one in the Cashfree dashboard under Developers › Whitelisting and wait for Cashfree's review. Sandbox does not need this.

Apple Pay through Cashfree also needs each website domain registered for Apple Pay in the Cashfree dashboard. Ask Cashfree support to enable it on your account first.

Common problems

The save is refused with "Cashfree is switched on but is missing: …". Fill the fields it names, or take Cashfree out of the list.
The card reads Not connected: a required field is empty.
Other cases: Payments troubleshooting.

Before you start

You need your own account with the provider.

Cashfree charges in INR only. Your shop's currency must be INR. It also needs the payer's Indian mobile number. So the website offers it only when your shop is in India or your checkout accepts Indian phone numbers.

You can only do this when you see the Payment Gateways tab. See Who manages your payments.

Screenshot coming soon

The Cashfree connection card on the Payment Gateways tab

Open the card

Go to Shop › Settings › Payment Gateways and select the Cashfree card to unfold it.

Fill in the connection details

Field	Required	What to enter
Is Sandbox Mode	No	On: the Cashfree sandbox. Sandbox keys work only with it on, production keys only with it off.
App ID	Yes	From the Cashfree dashboard › Developers › API Keys (Payment Gateway).
Secret Key	Yes	From the same page as the App ID. It also verifies Cashfree's webhooks. Write-only.
Pay on the checkout page	No	On: customers pay without leaving your website. Off: they are sent to the Cashfree payment page.
Saved cards	No	Returning customers see the cards they saved with Cashfree. Off: every payment starts fresh.

Point the gateway at your shop

The card shows a webhook address. It is sent with each order, so sandbox needs no set-up. In production, also add it in the Cashfree dashboard under Developers › Webhooks (Payment Gateway, latest version).

Switch it on and save

Add Cashfree to the Payment Gateways list at the top of the tab, then select Save Settings. The card shows Switched on.

Test it

Before going live

Apple Pay through Cashfree also needs each website domain registered for Apple Pay in the Cashfree dashboard. Ask Cashfree support to enable it on your account first.