Overview

Explore Cashfree Payment Gateway APIs for orders, payments, refunds, and more.

Cashfree’s RESTful Payment Gateway API provides a robust and flexible interface for integrating payment solutions into your applications. The API uses predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and supports standard HTTP response codes and authentication. SDKs in popular programming languages help you integrate faster with pre-built handling for authentication, request or response formatting, and error handling.

We strongly recommend using SDKs to streamline the integration process and ensure optimal performance and security.

Key features

The key features offered by Cashfree’s Payment Gateway APIs are:

• Orders and payments: Create orders, collect payments via multiple methods (cards, UPI, netbanking, wallets), and retrieve order and payment status.
• Payment links and refunds: Generate shareable payment links, process refunds, and manage refund status.
• Token Vault: Save cards and tokenize them in a PCI-compliant manner; generate network tokens for use across acquiring banks.
• Easy-Split: Split payments between vendors, configure static or post-payment splits, and manage settlements.
• Subscriptions: Create plans and mandates, raise and manage recurring payments with support for UPI, card, and E-Mandate.
• Eligibility and offers: Check eligible payment methods, cardless EMI, paylater, and offers for orders; create and manage offers.
• Settlements and disputes: Fetch settlements, reconcile, and handle chargebacks and disputes via APIs.

Orders and payments

Orders

Create Order

Create an order to collect payments from your customers.

Get Order

Get status and details of an order.

Terminate Order

Terminate an order that is no longer needed.

Get Order Extended

Fetch extended data for an order.

Update Order Extended

Update extended data for an order.

Customers

Create Customer

Create a customer for Token Vault and saved instruments.

Payments

Pay

Initiate a payment for an order using the chosen payment method.

Authenticate

Submit or resend OTP in the native OTP flow for card payments.

Authorise

Capture or void a pre-authorised transaction.

Get Payment

Get status and details of a single payment.

Get Payments for Order

Get status and details of all payments for an order.

Links and refunds

Payment links

Create Payment Link

Create a shareable payment link for collecting payments.

Get Payment Link

Get details of a payment link.

Cancel Payment Link

Cancel an active payment link.

Get Orders for Link

Fetch orders associated with a payment link.

Refunds

Create Refund

Create a refund for a payment (full or partial).

Get Refund

Get status and details of a refund.

Get Refunds for Order

Get all refunds for an order.

Update Refund

Update refund details or speed.

Vault and offers

Token Vault

Generate Cryptogram

Generate a cryptogram for a saved card to process a payment.

Get All Saved Cards

Fetch all saved card instruments for a customer.

Get Saved Card

Get details of a single saved card instrument.

Delete Saved Card

Delete a saved card instrument for a customer.

Eligibility and offers

Get Eligible Payment Methods

Fetch payment methods eligible for an order and account.

Get Eligible Cardless EMI

Get eligible cardless EMI options for a customer and order.

Get Eligible Paylater

Get eligible paylater options for a customer and order.

Get Eligible Offers

Get offers applicable to an order (e.g. no-cost EMI).

Create Offer

Create a new offer (card, netbanking, EMI, etc.).

Get Offer

Get details of an offer.

Split and settlements

Easy-Split

Easy-Split Overview

Overview of split payments and vendor settlements.

Easy-Split Endpoints

API reference for split and vendor operations.

Create Vendor

Create a vendor for receiving split payments.

Static Split

Configure static split rules for orders.

Split After Payment

Create split for an order after payment is received.

On-Demand Transfer

Transfer vendor share on demand.

Settlements and more

Get Settlements

Fetch settlement details and history.

Mark Order for Settlement

Mark an order for instant settlement.

Get Disputes by Order

Fetch disputes associated with an order.

Subscription Overview

Recurring payments: plans, mandates, and payment flows.

Create Subscription

Create a subscription with mandate (UPI, card, E-Mandate).

softPOS: Create Terminal

Create a softPOS terminal for in-person card acceptance.

The videos below walk through testing Payment Gateway APIs in Postman and using this API reference.

Testing APIs in Postman

Documentation Walkthrough

Getting started

Use the following resources to begin implementing Payment Gateway APIs:

Payment SDK

Integrate the Payment Gateway with web, mobile, and server SDKs for orders, checkout, and tokenisation

API rate limits

View default limits per minute, monitor usage on the dashboard, and request higher limits when needed