Documentation Index
Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Payment Gateway endpoints
Use the following base URLs depending on whether you are testing or processing live payments.
| Environment | Base URL |
|---|
| Test | https://sandbox.cashfree.com/pg |
| Production | https://api.cashfree.com/pg |
Authentication
All APIs require authentication except POST /orders/sessions, which does not require credentials and can be called directly from the browser.
For authentication details for merchants and partners, see API authentication.
Payment gateway APIs
The following sections list all available APIs grouped by function.
Use these APIs to create and manage payment orders.
| API | Description |
|---|
| Create Order | Use this API to create orders with Cashfree from your backend and get the payment link. |
| Order Pay | Use this API when you have already created the orders and want Cashfree Payments to process the payment. |
| Preauthorisation | Use this API to capture or void a preauthorised payment. |
| Get Order | Use this API to view all details of an order. |
Authentication
Use this API to submit or resend an OTP during a payment flow.
| API | Description |
|---|
| Submit or Resend OTP | Use this API to submit or resend an OTP to Cashfree during payment authentication. |
Payments
Use these APIs to retrieve payment details for an order.
| API | Description |
|---|
| Get Payments for an Order | Use this API to view all payment details for an order. |
| Get Payment by ID | Use this API to view payment details by payment ID. |
Settlements
Use these APIs to fetch settlement details for individual orders or across a date range.
| API | Description |
|---|
| Get Settlements by Order ID | Use this API to view all settlements for an order. |
| Get All Settlements | Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range. |
Payment links
Use these APIs to create, retrieve, and manage payment links.
| API | Description |
|---|
| Create Payment Link | Use this API to create a new payment link. The URL is returned in the link_url parameter of the response. |
| Fetch Payment Link Details | Use this API to view all details and status of a payment link. |
| Get Orders for a Payment Link | Use this API to view all order details for a payment link. |
| Cancel Payment Link | Use this API to cancel a payment link. No further payments can be done against a cancelled link. Only a link in ACTIVE status can be cancelled. |
Token vault
Use these APIs to manage saved payment instruments for a customer.
| API | Description |
|---|
| Fetch All Saved Instruments | Use this API to get all saved instruments for a customer ID. |
| Fetch Single Saved Instrument | Use this API to get a specific saved instrument for a customer ID and instrument ID. |
| Delete Saved Instrument | Use this API to delete a saved instrument for a customer ID and instrument ID. |
| Fetch Cryptogram for Saved Instrument | Use this API to get the card network token, token expiry and cryptogram for a saved instrument using instrument ID. |
Reconciliation
Use these APIs to fetch reconciliation reports for settlements and payment gateway transactions.
| API | Description |
|---|
| Settlement Reconciliation | Use this API to get settlement reconciliation details using a settlement ID, settlement UTR, or date range. |
| PG Reconciliation | Use this API to get the payment gateway reconciliation details with date range. |
