> ## Documentation Index
> Fetch the complete documentation index at: https://telr-docs.cashfree.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> This is a beta release of our next API.

## Payment Gateway End Points

| Environment    | Base URL                                                                                            |
| :------------- | :-------------------------------------------------------------------------------------------------- |
| Test           | [https://sandbox.cashfree.com/pg](https://sandbox.cashfree.com/pg)                                  |
| Production     | [https://api.cashfree.com/pg](https://api.cashfree.com/pg)                                          |
| Latest version | v5, 2025-01-01  <br />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](/api-reference/authentication) for detailed information on API Authentication for Merchants and Partners.

## Payment Gateway APIs

### Orders

| API                                                                   | Description                                                                                 |
| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------ |
| [Create Order](/api-reference/payments/latest/orders/create)          | Use this API to create orders with Telr from your backend and get the payment link.         |
| [Order Pay](/api-reference/payments/latest/payments/pay)              | Use this API when you have already created the orders and want Telr to process the payment. |
| [Preauthorization](/api-reference/payments/latest/payments/authorize) | Use this API to capture or void a preauthorized payment.                                    |
| [Get Order](/api-reference/payments/latest/orders/get)                | Use this API to view all details of an order.                                               |

### Authentication

| API                                                                          | Description                                           |
| :--------------------------------------------------------------------------- | :---------------------------------------------------- |
| [Submit or Resend OTP](/api-reference/payments/latest/payments/authenticate) | Use the submit or resend OTP API to send OTP to Telr. |

### Payments

| API                                                                                         | Description                                                        |
| :------------------------------------------------------------------------------------------ | :----------------------------------------------------------------- |
| [Get Payments for an Order](/api-reference/payments/latest/payments/get-payments-for-order) | Use this API to view all payment details for an order.             |
| [Get Payment by ID](/api-reference/payments/latest/payments/get)                            | Use this API to view payment details of an order for a payment ID. |

### Settlements

| API                                                                                                | Description                                                                                               |
| :------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- |
| [Get Settlements by Order ID](/api-reference/payments/latest/operations/get-settlements-for-order) | Use this API to view all the settlements of a particular order.                                           |
| [Get All Settlements](/api-reference/payments/latest/operations/get-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](/api-reference/payments/latest/payment-links/create)                        | 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](/api-reference/payments/latest/payment-links/get)                    | Use this API to view all details and status of a payment link.                                                                                  |
| [Get Orders for a Payment Link](/api-reference/payments/latest/payment-links/get-orders-for-link) | Use this API to view all order details for a payment link.                                                                                      |
| [Cancel Payment Link](/api-reference/payments/latest/payment-links/cancel)                        | 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](/api-reference/payments/latest/token-vault/get-all)                       | Use this API to get all saved instruments for a customer ID.                                                        |
| [Fetch Single Saved Instrument](/api-reference/payments/latest/token-vault/get)                         | Use this API to get specific saved instrument for a customer id and instrument ID.                                  |
| [Delete Saved Instrument](/api-reference/payments/latest/token-vault/delete)                            | Use this API to delete a saved instrument for a customer id and instrument ID.                                      |
| [Fetch Cryptogram for Saved Instrument](/api-reference/payments/latest/token-vault/generate-cryptogram) | 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](/api-reference/payments/latest/operations/settlement-reconciliation) | Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. |
| [PG Reconciliation](/api-reference/payments/latest/operations/reconcile)                         | Use this API to get the payment gateway reconciliation details with date range.                          |
