Cashfree Payment Links API

Name: Cashfree Payment Links API API
Brand: Cashfree Payment Links API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey4 EndpointsREST

For Agents

Create, fetch, cancel, and list orders for Cashfree hosted payment links so agents can collect Indian payments by sharing a URL with the customer.

Connect the Cashfree Payment Links API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cashfree Payment Links 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.

Install Jentic One Beta (Self-Hosted)

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 | sh

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 instance

Jentic 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 Links API API.

Create a hosted payment link with amount, currency, and customer email and phone

Fetch the current status of a payment link including paid, partially paid, expired, or cancelled

Cancel an outstanding payment link before the customer pays it

List all orders associated with a payment link to reconcile partial payments

GET STARTED

Start building with Cashfree Payment Links API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Cashfree Payment Links API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Cashfree Payment Links API, keeping it validated and agent-ready. The Cashfree Payment Links API lets Indian merchants generate hosted payment links that customers can pay via UPI, cards, netbanking, and wallets without integrating a full checkout flow. You create a link with an amount, currency, and customer details, share the returned URL by email or SMS, and Cashfree handles the payment page, retries, and settlement. The same API exposes endpoints to fetch a link's status, cancel it, and list the underlying orders that customers complete against it.

Use Cases

Patterns agents use Cashfree Payment Links API API for, with concrete tasks.

★ Invoice Collection by SMS or Email

Generate a Cashfree payment link for each open invoice and send it to the customer over SMS, WhatsApp, or email. The agent calls POST /links with the invoice amount, customer details, and a callback URL, then forwards the returned link_url to a messaging tool. Customers pay via UPI, card, or netbanking on the hosted page and you reconcile by polling GET /links/{link_id} or by webhook.

Call POST /links with link_amount=4999, link_currency='INR', and customer_details for the invoice's payer, then text the link_url to the customer.

Hosted Checkout Without Frontend Build

Use Cashfree Payment Links as a quick checkout for stores that do not yet have a custom payment page. The agent creates a link per order via POST /links and redirects the buyer to the Cashfree hosted page. This skips PCI scope and lets merchants accept UPI within a day instead of integrating a full SDK.

Call POST /links for each cart, set link_notify={'send_sms': true, 'send_email': true}, and redirect the buyer to link_url.

Reconciliation of Partial Payments

When a payment link allows partial payments, multiple orders settle against the same link. The agent calls GET /links/{link_id}/orders to enumerate every successful order, sums their amounts, and updates the customer's balance in the accounting system. This avoids missing partial settlements that GET /links/{link_id} alone would not break down.

Call GET /links/{link_id}/orders, sum the order_amount values for orders with order_status='PAID', and post the total to the ledger.

Agent-Driven Payment Collection via Jentic

Connect Cashfree to an AI agent through Jentic so an operator can say 'send Priya a payment link for 2,500 rupees' in chat. The agent searches Jentic for the right Cashfree operation, loads the schema, and calls POST /links with the API client ID and secret kept in the Jentic vault. The secret never enters the agent's prompt or response.

Use the Jentic Python SDK to search for 'create cashfree payment link', load the POST /links operation, and execute it with link_amount and customer_details from a chat message.

Key Endpoints

4 endpoints — jentic publishes the only available openapi specification for cashfree payment links api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/links

Create a hosted payment link

GET

/links/{link_id}

Fetch a payment link's status

POST

/links/{link_id}/cancel

Cancel a payment link

GET

/links/{link_id}/orders

List orders against a payment link

POST

/links

Create a hosted payment link

GET

/links/{link_id}

Fetch a payment link's status

POST

/links/{link_id}/cancel

Cancel a payment link

GET

/links/{link_id}/orders

List orders against a payment link

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Cashfree x-client-id and x-client-secret headers are stored encrypted in the Jentic vault and injected at execution time. Agents receive scoped tokens, so the client secret never appears in prompts, model context, or logs.

Intent-based discovery

Agents search Jentic by intent (e.g. 'create payment link' or 'cancel payment link') and Jentic returns the matching Cashfree operation with its input schema, so the agent can call the right endpoint without reading docs.cashfree.com.

Time to first call

Direct Cashfree integration: half a day to wire dual-header auth, link state polling, and webhook signature verification. Through Jentic: under 30 minutes — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Stripe

Global payment platform with Payment Links and full Checkout for international card and wallet payments.

Choose Stripe when the agent needs to accept payments outside India or wants a unified API for cards, subscriptions, and Connect.

Alternative

PayPal Invoicing

PayPal-hosted invoice and payment link flow with global PayPal balance and card support.

Choose PayPal Invoicing when the customer is paying internationally with PayPal balance or international cards.

Alternative

Square

US/UK payment platform with checkout links, in-person POS, and a unified merchant dashboard.

Choose Square when the agent needs combined online and in-person payments outside India.

FAQs

Specific to using Cashfree Payment Links API API through Jentic.

Why is there no official OpenAPI spec for Cashfree Payment Links API?

Cashfree publishes HTML reference docs at docs.cashfree.com but does not export a downloadable OpenAPI specification for the Payment Links API. Jentic generates and maintains this spec so that AI agents and developers can call Cashfree Payment Links 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 Links API use?

The API uses two API key headers, x-client-id and x-client-secret, issued from the Cashfree dashboard. Both are required on every request. Through Jentic, both values are stored encrypted in the vault, and only scoped tokens reach the agent's context.

Can I cancel a Cashfree payment link before it is paid?

Yes. Call POST /links/{link_id}/cancel with the link ID. The link's status becomes CANCELLED and any subsequent customer attempt to pay is rejected. Already-completed payments under the link are unaffected and can still be retrieved via GET /links/{link_id}/orders.

What are the rate limits for the Cashfree Payment Links API?

Cashfree applies per-account rate limits that vary by plan; production accounts typically get a few hundred requests per second. Check the X-RateLimit headers on each response when running through Jentic and back off when limits are hit.

How do I create a payment link through Jentic?

Search Jentic for 'create payment link' and the POST /links Cashfree operation is returned with its input schema for link_amount, link_currency, and customer_details. Load the operation, then execute it with the invoice values. The standard quickstart is pip install jentic, search, load, execute.

Is the Cashfree Payment Links API free?

Cashfree does not charge for API access; you pay per successful transaction at rates set in your Cashfree contract (typically 1.95%-2.5% for cards and a flat fee for UPI). There is no flat monthly fee for the Payment Links endpoints themselves.