Jump to Content

Home Product Documentation API Documentation

Create Account 📁 Change Logs Contact Sales

API Documentation

Create Account 📁 Change Logs Contact Sales

Home Product Documentation API Documentation

Cashfree Payment Gateway APIs

End Points
Server SDKs
Release Notes: V4 (2023-08-01)
Orders
Payments
Refunds
Settlements
- Get Settlements by Order IDget
Payment Links
Token Vault
softPOS
Offers
- Create Offerpost
- Get Offer by IDget
Eligibility
Settlement Reconciliation
- Settlement Reconciliationpost
- Get All Settlementspost
PG Reconciliation
- PG Reconciliationpost
Customers
- Create Customer at Cashfreepost
Easy-Split
Disputes
Simulation
- Simulate Paymentpost
- Fetch Simulationget
Subscription
Webhooks
Errors - Structure and List

Easy Split

Easy Split Overview
Easy Split - Postman Collection
End Points
Authorize - Auto Collectpost
Vendors 2.0
Split Orders
Settlements
On Demand Vendor Settlement - Amount Based
On Demand Settlements - Interval Based
Deferred Settlements
- Set Vendor Settlement Eligibility Date for Ordersput
Webhooks
- Vendor Settlement Webhook
- Vendor Status Change Webhook
Reconciliation

Cross Border - Imports

Cross Border - Imports Overview
Payment Verification Details Webhooks
Verification APIs
- Upload Payment Verification Detailspost
- Get Payment Verification Detailsget
Settlement APIs
- Get settlement detailsget
- Get settlement recon detailsget

global collections

Global Collections Overview
End Points
Merchant APIs & Webhook
Partner APIs & Webhook
Purpose Codes

Auto Collect

Auto Collect - Postman Collection
End Points
Auto Collect - Easy Split APIs
Authorizepost
Verify Tokenpost
Create Vendorpost
Edit Vendorput
Get All Vendor Detailsget
Get Vendor Detailsget
Virtual Accounts Version 2.0
Virtual Accounts Version 1.1
Virtual Accounts Version 1
Create QR Codeget
Create Dynamic QR Codeget
Change Virtual Account Statuspost
Recent Paymentsget
Fetch Rejected Payment Detailsget
View Settlement Detailsget
Get Recent Payments for Virtual Account Id/Virtual VPA Idget
Search for a Transaction by UTRget
Fetch Payment by Cashfree Ref Idget
Create Refundpost
Get Refund Detailsget
Webhooks

BBPS

Introduction
APIs to Implement
- Bill Fetchget
- Payment Postingget
Next Steps for Biller
APIs to Integrate
- Check Transaction Statusget
NPCI Onboarding Configurations

Subscription

Subscription - Postman Collection
End Points
Physical Mandates
Create Planpost
Create Subscription with Plan IDpost
Create Subscription with Plan Infopost
Seamless Subscription
Subscription Refund APIs
- Create Refundpost
- Get Refundget
Get Subscription Detailsget
Update Recurring Amountput
Get All Subscription Paymentsget
Get Single Subscription Payment Detailsget
Get Payment Details Using Merchant Txn IDget
Cancel Subscriptionpost
Pause Subscriptionput
Charge Subscriptionpost
Retry Paymentpost
Upload Filepost
Activate Subscriptionpost
Cancel Chargepost
Update Charge Statusput
Redirection Payload after Authorization
Transaction Return Summarypost
Rate Limits
Webhooks
Create Subscriptionpost
Create Seamless Subscriptionpost

LRS

LRS - Postman Collection
End Points
Merchant Webhook
Add Webhook URLSpost
Order
Documents
LRS Entities
Get FxRatepost
Get NetBanking Optionsget

Payouts

Payouts API Overview
Getting Started with Payouts APIs
Authentication
- Authorizepost
- Verifypost
Beneficiary
Account
Cashgram
Payouts APIs V2 - New
- Beneficiary V2
- Transfer V2
Batch Transfers v1.3
- Get Batch Transfer Status V1.3get
Transfers v1.2
Transfers
Payouts Through Phone Number v1.2
Payouts Through Phone Number
Webhooks V1
Webhooks V2
Incidents
- Get Incidentsget

Cashgram

Cashgram - Postman Collection
End Points
Authentication
- Authorizepost
- Verifypost
Create Cashgrampost
Get Cashgram Statusget
Deactivate Cashgrampost
Webhooks

Secure ID

Verification Suite API Overview
Verification Suite: Server-SDKs
End Points and Test Data
Authentication
- Authorizepost
- Verifypost
KYC Links
Bank Account Verification Version 2
UPI Version 2
- UPI Verification V2post
- Get Status of UPI Verification V2get
UPI 360post
Get Multiple VPA from Phone Number.post
PAN
Aadhaar
Account Aggregator
GSTIN
- Verify GSTINpost
- Fetch GSTIN with PANpost
Reverse Penny Drop
E-sign
Digilocker
Mobile 360
- Mobile 360 Litepost
- Mobile 360 Advancedpost
Vehicle RCpost
Driving Licencepost
Voter IDpost
Passportpost
CINpost
Employee Detailspost
IPpost
Reverse Geocodingpost
Liveliness Checkpost
Face Matchpost
Name Matchpost
Retired API Versions
- Bank Account Verification V1
- UPI Version 1
  - UPI Verificationget
Verification Rate Limits

Merchant Onboarding APIs

Merchant Onboarding
Merchant Onboarding Webhooks

PRE-ACTIVATED VPAS API

Create Pre-Activated Vpas for partnerpost
Get Pre-Activated Vpas for partnerget

Cashfree Payment Gateway APIs

End Points
Server SDKs
Release Notes: V4 (2023-08-01)
Orders
Payments
Refunds
Settlements
- Get Settlements by Order IDget
Payment Links
Token Vault
softPOS
Offers
- Create Offerpost
- Get Offer by IDget
Eligibility
Settlement Reconciliation
- Settlement Reconciliationpost
- Get All Settlementspost
PG Reconciliation
- PG Reconciliationpost
Customers
- Create Customer at Cashfreepost
Easy-Split
Disputes
Simulation
- Simulate Paymentpost
- Fetch Simulationget
Subscription
Webhooks
Errors - Structure and List

Easy Split

Easy Split Overview
Easy Split - Postman Collection
End Points
Authorize - Auto Collectpost
Vendors 2.0
Split Orders
Settlements
On Demand Vendor Settlement - Amount Based
On Demand Settlements - Interval Based
Deferred Settlements
- Set Vendor Settlement Eligibility Date for Ordersput
Webhooks
- Vendor Settlement Webhook
- Vendor Status Change Webhook
Reconciliation

Cross Border - Imports

Cross Border - Imports Overview
Payment Verification Details Webhooks
Verification APIs
- Upload Payment Verification Detailspost
- Get Payment Verification Detailsget
Settlement APIs
- Get settlement detailsget
- Get settlement recon detailsget

global collections

Global Collections Overview
End Points
Merchant APIs & Webhook
Partner APIs & Webhook
Purpose Codes

Auto Collect

Auto Collect - Postman Collection
End Points
Auto Collect - Easy Split APIs
Authorizepost
Verify Tokenpost
Create Vendorpost
Edit Vendorput
Get All Vendor Detailsget
Get Vendor Detailsget
Virtual Accounts Version 2.0
Virtual Accounts Version 1.1
Virtual Accounts Version 1
Create QR Codeget
Create Dynamic QR Codeget
Change Virtual Account Statuspost
Recent Paymentsget
Fetch Rejected Payment Detailsget
View Settlement Detailsget
Get Recent Payments for Virtual Account Id/Virtual VPA Idget
Search for a Transaction by UTRget
Fetch Payment by Cashfree Ref Idget
Create Refundpost
Get Refund Detailsget
Webhooks

BBPS

Introduction
APIs to Implement
- Bill Fetchget
- Payment Postingget
Next Steps for Biller
APIs to Integrate
- Check Transaction Statusget
NPCI Onboarding Configurations

Subscription

Subscription - Postman Collection
End Points
Physical Mandates
Create Planpost
Create Subscription with Plan IDpost
Create Subscription with Plan Infopost
Seamless Subscription
Subscription Refund APIs
- Create Refundpost
- Get Refundget
Get Subscription Detailsget
Update Recurring Amountput
Get All Subscription Paymentsget
Get Single Subscription Payment Detailsget
Get Payment Details Using Merchant Txn IDget
Cancel Subscriptionpost
Pause Subscriptionput
Charge Subscriptionpost
Retry Paymentpost
Upload Filepost
Activate Subscriptionpost
Cancel Chargepost
Update Charge Statusput
Redirection Payload after Authorization
Transaction Return Summarypost
Rate Limits
Webhooks
Create Subscriptionpost
Create Seamless Subscriptionpost

LRS

LRS - Postman Collection
End Points
Merchant Webhook
Add Webhook URLSpost
Order
Documents
LRS Entities
Get FxRatepost
Get NetBanking Optionsget

Payouts

Payouts API Overview
Getting Started with Payouts APIs
Authentication
- Authorizepost
- Verifypost
Beneficiary
Account
Cashgram
Payouts APIs V2 - New
- Beneficiary V2
- Transfer V2
Batch Transfers v1.3
- Get Batch Transfer Status V1.3get
Transfers v1.2
Transfers
Payouts Through Phone Number v1.2
Payouts Through Phone Number
Webhooks V1
Webhooks V2
Incidents
- Get Incidentsget

Cashgram

Cashgram - Postman Collection
End Points
Authentication
- Authorizepost
- Verifypost
Create Cashgrampost
Get Cashgram Statusget
Deactivate Cashgrampost
Webhooks

Secure ID

Verification Suite API Overview
Verification Suite: Server-SDKs
End Points and Test Data
Authentication
- Authorizepost
- Verifypost
KYC Links
Bank Account Verification Version 2
UPI Version 2
- UPI Verification V2post
- Get Status of UPI Verification V2get
UPI 360post
Get Multiple VPA from Phone Number.post
PAN
Aadhaar
Account Aggregator
GSTIN
- Verify GSTINpost
- Fetch GSTIN with PANpost
Reverse Penny Drop
E-sign
Digilocker
Mobile 360
- Mobile 360 Litepost
- Mobile 360 Advancedpost
Vehicle RCpost
Driving Licencepost
Voter IDpost
Passportpost
CINpost
Employee Detailspost
IPpost
Reverse Geocodingpost
Liveliness Checkpost
Face Matchpost
Name Matchpost
Retired API Versions
- Bank Account Verification V1
- UPI Version 1
  - UPI Verificationget
Verification Rate Limits

Merchant Onboarding APIs

Merchant Onboarding
Merchant Onboarding Webhooks

PRE-ACTIVATED VPAS API

Create Pre-Activated Vpas for partnerpost
Get Pre-Activated Vpas for partnerget

Settlement APIs

This page is the parent folder for all the APIs required for obtaining settlement details related to transactions that have been remitted.