Overview

Learn details about the 2025-01-01 version of our Payment APIs.

Payment Gateway end points

Environment	Base URL
Test	https://sandbox.cashfree.com/pg
Production	https://api.cashfree.com/pg
Latest version	v5, 2025-01-01 The previous versions were 2023-08-01, 2021-05-21, 2022-01-01, and 2022-09-01

Authentication

All the APIs require authentication, except the /orders/sessions API, which does not require any authentication and can be safely done from the browser as well.

Click here for detailed information on API Authentication for Merchants and Partners.

Payment Gateway APIs

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.
Preauthorization	Use this API to capture or void a preauthorized payment.
Get Order	Use this API to view all details of an order.

Authentication

API	Description
Submit or Resend OTP	Use the submit or resend OTP API to send OTP to Cashfree.

Payments

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 of an order for a payment ID.

Settlements

API	Description
Get Settlements by Order ID	Use this API to view all the settlements of a particular order.
Get All Settlements	Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range.

Payment links

API	Description
Create Payment Link	Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url.
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

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

API	Description
Settlement Reconciliation	Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range.
PG Reconciliation	Use this API to get the payment gateway reconciliation details with date range.