Get started quickly with Cashfree's Auto Collect APIs by downloading the collection and importing it in Postman.
Download Cashfree Auto Collect Postman Collection
Auto Collect APIs
The table below provides the list of Auto Collect APIs along with their description:
Vendors
| API Name | Descriptiom |
|---|---|
| Create Vendor | Use this API to create a vendor. |
| Edit Vendor | Use this API to edit vendor details. |
| Get All Vendor Details | Use this API to view the details of all the vendors you have added. |
| Get Vendor Details | Use this API to view details of a specific vendor by providing the vendorId. |
Virtual Account V1.1
| API Name | Description |
|---|---|
| Create Virtual Account/VPA | Use this API to create a virtual account or a virtual UPI address. |
| Edit Virtual Account | Use this API to edit virtual account details. |
| Get Virtual Account or Virtual VPA Details | Use this API to fetch details of a virtual bank account or virtual VPA. |
| List All Virtual Accounts | Use this API to get a list of all the virtual accounts associated with your Auto Collect account. |
Virtual Account V1
| API Name | Description |
|---|---|
| Create Virtual Account/VPA | Use this API to create a virtual account or a virtual UPI address. |
| Edit Virtual Account | Use this API to edit virtual account details. |
| Get Virtual Account or Virtual VPA Details | Use this API to fetch details of a virtual bank account or virtual VPA. |
| List All Virtual Accounts | Use this API to get a list of all the virtual accounts associated with your Auto Collect account. |
| Change Virtual Account Status | Use this API to change virtual account status from ACTIVE to INACTIVE and vice-versa. |
QR Code
| API Name | Description |
|---|---|
| Create QR code | Use this API to create a QR code for your existing Cashfree Virtual VPA. |
| Create Dynamic QR Code | Use this API to create a QR code for your existing Cashfree Virtual VPA fixed with an amount. This amount cannot be changed after creation. This will force the user to pay a predefined amount defined through the API. |
Payments and Refunds
| API Name | Description |
|---|---|
| Get Recent Payments | Use this API to get all the recent payments on all of your virtual accounts. |
| Get Rejected Payment Details | Use this API to get details regarding a rejected payment using rejectId. |
| Get Recent Payments for Virtual Account Id/Virtual VPA ID | Use this API to get all the recent payments on your virtual account by sending the corresponding virtual account ID (vAccountId) or virtual VPA ID (virtualVpaId). |
| Search for a Transaction by UTR | Use this API to search for transaction details using UTR number. |
| Fetch Payment by Cashfree Ref ID | Use this API to get the payment details using the Cashfree reference ID. |
| Create Refund | Use this API to initiate refunds. |
| Get Refund Details | Use this API to fetch refund details. |