Cashfree Payment Gateway API
★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey6 EndpointsREST
For Agents
Create payment orders, generate checkout sessions, issue refunds, send payment links, and pull settlements for Indian merchants on Cashfree.
Use for: I need to charge an Indian customer 1499 INR via UPI, Create a Cashfree order for a new e-commerce checkout, Issue a partial refund on a Cashfree order, Send a payment link to a customer over WhatsApp
Not supported: Does not handle payouts to bank accounts, KYC onboarding, or cross-border remittance — use for Indian payment gateway order creation, refunds, links, and settlements only.
Jentic publishes the only available OpenAPI specification for Cashfree Payment Gateway API, keeping it validated and agent-ready. Cashfree is an India-focused payment platform that handles UPI, card, net banking, and wallet payments through a single order-and-session model. The API lets merchants create orders, generate payment sessions for checkout, issue refunds, send shareable payment links, and pull settlement reports. It targets Indian e-commerce, SaaS billing, and marketplace flows where domestic payment methods and INR settlement are required.
Install Jentic One Beta
Connect the Cashfree Payment Gateway API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cashfree Payment Gateway API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Cashfree Payment Gateway API.
Create a Cashfree order with amount, currency, and customer details before checkout
Generate a payment session that hands off to UPI, card, or wallet checkout flows
Look up an order's payment status and gateway response after checkout
Issue full or partial refunds against a completed Cashfree order
Send a shareable payment link to a customer for ad-hoc collection
Retrieve settlement records to reconcile payouts into the merchant bank account
Use Cases
Patterns agents use Cashfree Payment Gateway API for, with concrete tasks.
★ Indian e-commerce checkout
Indian online stores create a Cashfree order with the cart total in INR, then pass the resulting payment session ID to the Cashfree drop-in checkout. Customers pay using UPI, cards, net banking, or popular wallets, and the merchant polls GET /orders/{order_id} for the final payment status before fulfilling the order.
POST /orders with order_amount=1499.00, order_currency=INR, and customer_details, then POST /orders/sessions to obtain a payment session id and return it to the storefront.
Refund handling for marketplaces
Marketplaces and D2C brands can issue full or partial refunds against an existing Cashfree order using POST /orders/{order_id}/refunds. Combined with GET /orders/{order_id} for the original payment record, this supports a full refund workflow without leaving the API, useful for return centres and CX automations.
POST /orders/{order_id}/refunds with refund_amount=500.00 and refund_note set to the return RMA id.
Payment link collection
For invoice or service-business collection, sales and finance teams can use POST /links to create a payment link with a fixed amount and customer reference, then send it via SMS, email, or WhatsApp. Customers complete payment in their preferred method and the link state can be tracked back to the originating record.
POST /links with link_amount=2500, link_currency=INR, link_purpose='Invoice INV-204', and customer phone, then return the link_url to the user.
Settlement reconciliation
Finance teams pull settlement batches via POST /settlements to reconcile credits hitting the merchant bank account against the orders that funded them. This closes the loop between gross payments captured and net amounts received after Cashfree's deductions.
POST /settlements with a date filter for last week and write each settlement record into the finance ledger keyed by settlement id.
AI agent payments via Jentic
AI checkout or sales agents can search Jentic for 'create a payment order' and Jentic returns the Cashfree create-order operation along with the input schema. The Cashfree client id and client secret stay in the Jentic vault, so the agent triggers a real charge without ever holding the credentials.
Search Jentic for 'create a Cashfree payment order', load POST /orders, and execute it with the user's cart total and contact details.
Key Endpoints
6 endpoints — jentic publishes the only available openapi specification for cashfree payment gateway api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/orders
Create a payment order
GET
/orders/{order_id}
Fetch order status and payment details
POST
/orders/sessions
Create a checkout session for an order
POST
/orders/{order_id}/refunds
Issue a refund against an order
POST
/links
Create a shareable payment link
POST
/settlements
Retrieve settlement records
POST
/orders
Create a payment order
GET
/orders/{order_id}
Fetch order status and payment details
POST
/orders/sessions
Create a checkout session for an order
POST
/orders/{order_id}/refunds
Issue a refund against an order
POST
/links
Create a shareable payment link
POST
/settlements
Retrieve settlement records
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Cashfree x-client-id and x-client-secret are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access at execution time, so the secret pair never appears in prompts, logs, or tool outputs.
Intent-based discovery
Agents search by intent (e.g., 'create a payment order' or 'refund an Indian payment') and Jentic returns the matching Cashfree operation with its input schema, so the agent calls the correct endpoint without browsing Cashfree docs.
Time to first call
Direct Cashfree integration with both header credentials, sandbox/production switching, and webhook verification: 3-5 days. Through Jentic: under 1 hour — search, load, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe API
Stripe is the global alternative when Indian-domestic UPI and INR settlement are not required.
Choose Stripe for international payments and complex subscription billing; use Cashfree when serving Indian customers with UPI.
FAQs
Specific to using Cashfree Payment Gateway API through Jentic.
Why is there no official OpenAPI spec for Cashfree Payment Gateway API?
Cashfree publishes documentation but no machine-readable OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cashfree Payment Gateway API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the Cashfree Payment Gateway API use?
The Cashfree Payment Gateway API uses API key headers. Every request must include x-client-id and x-client-secret obtained from the Cashfree merchant dashboard. Through Jentic these credentials are stored encrypted in the MAXsystem vault and injected at execution time, never appearing in agent prompts.
Can I issue partial refunds with the Cashfree API?
Yes. POST /orders/{order_id}/refunds accepts a refund_amount that can be less than the original order_amount, allowing partial refunds against a captured order. You can call the endpoint multiple times until the cumulative refund equals the order amount.
What are the rate limits for the Cashfree Payment Gateway API?
Cashfree does not publish explicit rate limits in this OpenAPI spec; production limits depend on your merchant tier. Use the sandbox base URL https://sandbox.cashfree.com/pg for testing and contact Cashfree support for production throughput needs.
How do I create a Cashfree order through Jentic?
Run pip install jentic, search Jentic with the query 'create a Cashfree payment order', load the POST /orders schema, and execute it with order_amount, order_currency=INR, and customer_details. Jentic injects x-client-id and x-client-secret from the vault automatically.
Does the Cashfree API support currencies other than INR?
The order endpoints accept an order_currency field, but Cashfree's primary domestic gateway is geared toward INR settlement for Indian merchants. For cross-border collection, Cashfree offers separate products outside the scope of this Payment Gateway API.
GET STARTED