- DISPUTE
- RETRIEVAL
- CHARGEBACK
- PRE\_ARBITRATION
- ARBITRATION | Chargeback | String | | reason\_code | Condition for which the customer is filing the case. Click [here]() to know more about dispute reason codes. | 13.6 | String | | reason\_description | Description of the reason code. Codes for Chargeback cases are specified by Card networks/NPCI. | Credit not processed | String | | dispute\_amount | The amount for which the dispute has been created. | 4500 | BigDecimal | | created\_at | Time on which the dispute was registered on Cashfree’s system. | 2023-06-15T21:16:03+05:30 | LocalDateTime | | updated\_at | Time on which the dispute was updated. | 2023-06-15T21:16:51+05:30 | LocalDateTime | | respond\_by | Time by which the merchant is expected to respond to the dispute. | 2023-06-18T00:00:00+05:30 | LocalDateTime | | dispute\_status | Status of Dispute. All possible values are listed in the table below. | CHARGEBACK\_CREATED | String | | cf\_dispute\_remarks | Any remarks specified by Cashfree on the dispute. | Please submit documents. | String | | dispute\_update | Specifies what has been updated on the dispute. Possible Values:
- STATUS\_UPDATE
- TYPE\_UPDATE
- COMMENT\_UPDATE | TYPE\_UPDATE | String | | dispute\_action\_on | Specifies whether the action is on Cashfree or Merchant at a time. Possible Values:
- MERCHANT
- CASHFREE | MERCHANT | String | | resolved\_at | Time on which the dispute was resolved/closed. | 2023-06-15T21:16:51.682836678+05:30 | LocalDateTime | | event\_time | Time at which dispute webhook was initiated. | 2023-06-15T21:16:51+05:30 | LocalDateTime | | type | Type of webhook. Possible Values:
- DISPUTE\_CREATED
- DISPUTE\_UPDATED
- DISPUTE\_CLOSED | DISPUTE\_CREATED | String | | List of Dispute Status | | :--------------------------------------- | | DISPUTE\_CREATED | | DISPUTE\_DOCS\_RECEIVED | | DISPUTE\_UNDER\_REVIEW | | DISPUTE\_MERCHANT\_WON | | DISPUTE\_MERCHANT\_LOST | | DISPUTE\_MERCHANT\_ACCEPTED | | DISPUTE\_INSUFFICIENT\_EVIDENCE | | RETRIEVAL\_CREATED | | RETRIEVAL\_DOCS\_RECEIVED | | RETRIEVAL\_UNDER\_REVIEW | | RETRIEVAL\_MERCHANT\_WON | | RETRIEVAL\_MERCHANT\_LOST | | RETRIEVAL\_MERCHANT\_ACCEPTED | | RETRIEVAL\_INSUFFICIENT\_EVIDENCE | | CHARGEBACK\_CREATED | | CHARGEBACK\_DOCS\_RECEIVED | | CHARGEBACK\_UNDER\_REVIEW | | CHARGEBACK\_MERCHANT\_WON | | CHARGEBACK\_MERCHANT\_LOST | | CHARGEBACK\_MERCHANT\_ACCEPTED | | CHARGEBACK\_INSUFFICIENT\_EVIDENCE | | PRE\_ARBITRATION\_CREATED | | PRE\_ARBITRATION\_DOCS\_RECEIVED | | PRE\_ARBITRATION\_UNDER\_REVIEW | | PRE\_ARBITRATION\_MERCHANT\_WON | | PRE\_ARBITRATION\_MERCHANT\_LOST | | PRE\_ARBITRATION\_MERCHANT\_ACCEPTED | | PRE\_ARBITRATION\_INSUFFICIENT\_EVIDENCE | | ARBITRATION\_CREATED | | ARBITRATION\_DOCS\_RECEIVED | | ARBITRATION\_UNDER\_REVIEW | | ARBITRATION\_MERCHANT\_WON | | ARBITRATION\_MERCHANT\_LOST | | ARBITRATION\_MERCHANT\_ACCEPTED | | ARBITRATION\_INSUFFICIENT\_EVIDENCE | ## Compute signature and verify The signature must be used to verify if the request has not been tampered with. To verify the signature at your end, you will need your Cashfree PG secret key along with the payload. Timestamp is present in the header x-webhook-timestamp ````bash theme={"dark"} timestamp := 1617695238078; signedPayload := $timestamp.$payload; expectedSignature := Base64Encode(HMACSHA256($signedPayload, $merchantSecretKey));``` ```` ## Sample code ### Verify Signature using SDK
```json Json theme={"dark"} { "data": { "adjustment_amount_inr": -347641.22, "collection_amount_inr": 604854.0, "initiated_on": null, "payment_from": "2024-09-26T15:43:55", "payment_till": "2024-09-26T16:43:13", "service_charge_inr": null, "service_tax_inr": 2068.59, "settled_on": null, "settlement_amount_inr": 243651.95, "settlement_charges_inr": 0.0, "settlement_foreign_currency_details": { "settlement_amount_fcy": null, "settlement_currency": "USD", "settlement_forex_rate": null }, "cf_ica_settlement_id": 12, "settlement_tax_inr": 0.0, "settlement_utr": null, "status": "NOT_INITIATED" }, "event_time": "2024-10-03T13:27:36+05:30", "type": "ICA_SETTLEMENT_UPDATE" } ```
Landing page to add the webhook URL and subscribe the events
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 Cashfree 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 Cashfree Payments 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 Cashfree. | ### 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. | # Cancel Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/cancel openapi/payments/v2025-01-01.yaml post /links/{link_id}/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. { const el = e.currentTarget; el.style.backgroundColor = 'rgba(255, 248, 240, 0.8)'; el.style.transform = 'translateY(-1px)'; }} onMouseLeave={(e) => { const el = e.currentTarget; el.style.backgroundColor = 'rgba(255, 248, 240, 0.4)'; el.style.transform = 'none'; }} > Run in Postman: You can also try this API in our Postman Collection. # Create Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/create openapi/payments/v2025-01-01.yaml post /links Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url. { const el = e.currentTarget; el.style.backgroundColor = 'rgba(255, 248, 240, 0.8)'; el.style.transform = 'translateY(-1px)'; }} onMouseLeave={(e) => { const el = e.currentTarget; el.style.backgroundColor = 'rgba(255, 248, 240, 0.4)'; el.style.transform = 'none'; }} > Run in Postman: You can also try this API in our Postman Collection. # Fetch Payment Link Details Source: https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/get openapi/payments/v2025-01-01.yaml get /links/{link_id} Use this API to view all details and status of a payment link. { const el = e.currentTarget; el.style.backgroundColor = 'rgba(255, 248, 240, 0.8)'; el.style.transform = 'translateY(-1px)'; }} onMouseLeave={(e) => { const el = e.currentTarget; el.style.backgroundColor = 'rgba(255, 248, 240, 0.4)'; el.style.transform = 'none'; }} > Run in Postman: You can also try this API in our Postman Collection. # Get Orders for a Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/get-orders-for-link openapi/payments/v2025-01-01.yaml get /links/{link_id}/orders Use this API to view all order details for a payment link. # Payment Link Webhooks Source: https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/webhooks Learn about webhooks triggered when payments made through Payment Links. ## Webhook Schema Payment Link webhook will be triggered when your customer makes a complete or partial payment using the payment link you shared. You will also be notified via the same webhook when the payment link gets cancelled or expired. ```json theme={"dark"} { "data": { "cf_link_id": 1576977, "link_id": "payment_ps11", "link_status": "PARTIALLY_PAID", "link_currency": "INR", "link_amount": "200.12", "link_amount_paid": "55.00", "link_partial_payments": true, "link_minimum_partial_amount": "11.00", "link_purpose": "Payment for order 10", "link_created_at": "2021-08-18T07:13:41", "customer_details": { "customer_phone": "9000000000", "customer_email": "john@gmail.com", "customer_name": "John " }, "link_meta": { "notify_url": "https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net" }, "link_url": "https://payments-test.cashfree.com/links//U1mgll3c0e9g", "link_expiry_time": "2021-11-28T21:46:20", "link_notes": { "note_key_1": "note_value_1" }, "link_auto_reminders": true, "link_notify": { "send_sms": true, "send_email": true }, "order": { "order_amount": "22.00", "order_id": "CFPay_U1mgll3c0e9g_ehdcjjbtckf", "order_expiry_time": "2021-08-18T07:34:50", "order_hash": "Gb2gC7z0tILhGbZUIeds", "transaction_id": 1021206, "transaction_status": "SUCCESS" } }, "type": "PAYMENT_LINK_EVENT", "version": 1, "event_time": "2021-08-18T12:55:06+05:30" } ``` *** ## Payload | Field | Description | Example | | :---------------------------- | :------------------------------------------------------------------------------------------------ | :----------------------------------------------------------- | | `cf_link_id` | Unique Identifier (generated by Cashfree) for this Link. | 1543566 | | `link_id` | Unique Identifier (provided by merchant) for the Link. Only for merchant reference. | payment\_1psw | | `link_status` | Current status of the payment link. Possible values: PAID, PARTIALLY\_PAID, EXPIRED, CANCELLED. | PARTIALLY\_PAID | | `link_currency` | Default is INR. International currencies are supported. | INR | | `link_amount` | The amount which merchant wants to collect for the order. | 500.00 | | `link_amount_paid` | The amount paid by the customer. | 250.00 | | `link_partial_payments` | Indicates if partial payments are allowed or not. Default value is false. | true | | `link_minimum_partial_amount` | The minimum amount which must be paid by customer as the first payment. | 200.00 | | `link_purpose` | A brief description for which payment must be collected. This is shown to the customer. | Payment for order 10 | | `link_created_at` | Time at which the link was created. | 2021-08-18T07:13:41 | | `customer_details` | Customer object, it contains customer details. | | | `customer_name` | Name of the customer | John | | `customer_phone` | Phone number of the customer | 9000000000 | | `customer_email` | Email ID of the customer | [john@gmail.com](mailto:john@gmail.com) | | `notify_url` | Payment notification URL | [https://payment1notify.net](https://payment1notify.net) | | `link_url` | Payment link URL | [https://website.com/payments](https://website.com/payments) | | `link_expiry_time` | The date till which the link will be valid, and then it will be expired. Default is 30 days. | 2021-11-28T21:46:20 | | `link_notes` | Link notes object where you can provide any key-value pairs for your internal reference. | | | `note_key_1` | | note\_value\_1 | | `link_auto_reminders` | Default is false. Reminders will be sent to customers based on defined settings. | true | | `link_notify` | Link notify object, used to notify customers via SMS or an email. | | | `send_sms` | Default is true. If true, Cashfree will send the link to customer via SMS. | true | | `send_email` | Default is true. If true and `customer_email` is provided, Cashfree will send the link via Email. | true | | `order` | Order object, contains the order details. Will be null for cancelled and expired link statuses. | | | `order_amount` | Order amount that the customer must pay. | 700 | | `order_id` | The order ID generated. | order\_10 | | `order_expiry_time` | The date till which the order will be valid. Default is 30 days. | 2021-08-18T07:34:50 | | `transaction_id` | Transaction ID | id45466ye | | `transaction_status` | Status of the transaction. Possible values: SUCCESS. | SUCCESS | | `type` | Type of the webhook. `PAYMENT_LINK_EVENT` | PAYMENT\_LINK\_EVENT | | `version` | The version of webhook. Build parsing logic with respect to this version. | 1 | | `event_time` | Time when this webhook was created. | 2021-08-18T12:55:06+05:30 | *** ## Signature generation The signature must be used to verify if the request has not been tampered with. To verify the signature at your end, you will need your Cashfree Payment Gateway secret key along with the payload. ```javascript theme={"dark"} // The payload here refers to the raw request sent by // Cashfree to your endpoint. No modifications need to be made to this payload. { "data": { "cf_link_id": 1576977, "link_id": "payment_ps11", "link_status": "PARTIALLY_PAID", "link_currency": "INR", "link_amount": "200.12", "link_amount_paid": "55.00", "link_partial_payments": true, "link_minimum_partial_amount": "11.00", "link_purpose": "Hello my friend how are you", "link_created_at": "2021-08-18T07:13:41", "customer_details": { "customer_phone": "9905736722", "customer_email": "supal.dubey@cashfree.com", "customer_name": "Supal " }, "link_meta": { ... } } } ```
**Correct format: payment\_amount: 170.00** ✅
**Incorrect format: payment\_amount: 170** ❌
**You can perform the following tasks using Easy Split:**
* Add and manage all your vendors efficiently
* Split payments and settle them into multiple vendor accounts using the available schedule options cycles
* Check on-demand vendor balance and settle the money into the vendor accounts instantly
* Vendor reconciliation
The table below provides the list of Easy Split APIs along with their description:
**Vendor APIs**
| API Name | Description |
| :---------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ |
| [Create Vendor](/api-reference/payments/latest/split/vendors/create) | Create Vendor API creates a new vendor in your Easy Split account. |
| [Update Vendor Details](/api-reference/payments/latest/split/vendors/update) | Update Vendor Details API updates the existing vendor details. |
| [Get Specific Vendor Details](/api-reference/payments/latest/split/vendors/download-documents) | Get Specific Vendor Details API gets the details of a specific vendor. |
| [Get All Vendor Details](/api-reference/payments/latest/split/vendors/get) | Get All Vendor Details API gets the details of all the vendors associated with that Easy Split account. |
| [Transfer Vendor Balance](/api-reference/payments/latest/split/configuration/create-adjustment) | Transfer Vendor Balance API adjusts the vendor balances. |
| [Create Refund](/api-reference/payments/latest/refunds/create) | Create Refund API creates a new refund. |
**Split Order APIs**
| API Name | Description |
| :------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
| [Split at Order Level](/api-reference/payments/latest/split/configuration/create-adjustment#create-adjustment) | Use this API to create a split at order level. |
| [Split After Payment](/api-reference/payments/latest/split/configuration/split-after-payment) | Split After Payment API created a split after the payment is completed. |
| [Get Split and Settlement Details by OrderId](/api-reference/payments/latest/split/settlements/split-details) | Get Split and Settlement Details by OrderId API gets details of the split, settled and unsettled transactions of each vendor using the OrderID. |
**Settlement APIs**
| API Name | Description |
| :------------------------------------------------- | :------------------------------------------------------------------------------------------------------------ |
| [Get Settlement Cycle Details]() | Get Settlement Cycle Details API gets the schedule option details. |
| [Get All Vendor Settlement Details]() | Get All Vendor Settlement Details API gets all the vendor settlement details. |
| [Get Vendor Settlement Details by Settlement ID]() | Get Vendor Settlement Details by Settlement ID API gets the Vendor Settlement of each vendor by SettlementID. |
**On Demand Settlement APIs**
| API Name | Description |
| :---------------------------------- | :----------------------------------------------------------------------------------------- |
| [Get On Demand Vendor Balance]() | Get On Demand Vendor Balance API gets the on-demand vendor balance. |
| [Settle On Demand Vendor Balance]() | Settle On Demand Vendor Balance API settles the balance to a vendor on-demand immediately. |
| [Get On Demand Settlement Status]() | Get On Demand Settlement Status API gets the on-demand settlement status. |
**Deferred Settlement APIs**
| API Name | Description |
| :---------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- |
| [Set Vendor Settlement Eligibility Date for Orders]() | Set Vendor Settlement Eligibility Date for Orders API assigns a settlement eligibility date for an order and vendor combination. |
**Reconciliation APIs**
| API Name | Description |
| :----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
| [View Split Order Details Using Settlement ID]() | View Split Order Details Using Settlement ID API gets the details of the split order processed in a settlement using Settlement ID. |
| [Vendor Recon for a Time Period]() | Vendor Recon for a Time Period API gets the on demand settlement status by providing the on-demand request ID. |
| [Vendor Recon Using Vendor ID & Time Interval]() | Vendor Recon Using Vendor ID & Time Interval API gets the details of all events for a specific vendor within an interval. |
# Easy Split - Postman Collection
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/easy-split-postman-collection
Get started quickly with Cashfree's Easy Split APIs by downloading the collection and importing it in Postman.
Download Cashfree Easy Split Postman Collection
Watch the video below to learn how to setup API
# End Points
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/end-points
Cashfree uses API keys to allow access to the API. Once you have signed up at our merchant site, you can see your AppId and SecretKey.
Cashfree expects the API key to be included in all API requests to the server. Use the endpoint /api/v1/credentials/verify to verify your credentials.
| Environment | Base URL |
| :---------- | :----------------------------------------------------------------- |
| Production | [https://api.cashfree.com/pg](https://api.cashfree.com/pg) |
| Test | [https://sandbox.cashfree.com/pg](https://sandbox.cashfree.com/pg) |
# Create On Demand Transfer
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/settlements/on-demand-transfer
openapi/payments/v2025-01-01.yaml post /easy-split/vendors/{vendor_id}/transfer
The Create On Demand Transfer API will create a new on-demand request either from to the merchant or from to the vendor.
# Get Split and Settlement Details by OrderID v2.0
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/settlements/split-details
openapi/payments/v2025-01-01.yaml post /split/order/vendor/recon
Use this API to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date.
# Upload Vendor Docs
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/add-document
openapi/payments/v2025-01-01.yaml post /easy-split/vendor-docs/{vendor_id}
Use this API to upload KYC documents of a specific vendor.
# Create vendor
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/create
openapi/payments/v2025-01-01.yaml post /easy-split/vendors
Use this API to create a new vendor to your EasySplit account along with the KYC details. Provide KYC details such as account_type, business_type, gst, cin, pan, passport number and so on.
# Download Vendor Documents
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/download-documents
openapi/payments/v2025-01-01.yaml get /easy-split/vendor-docs/{vendor_id}/download/{doc_type}
Use this API to download the uploaded KYC documents of that particular vendor. Provide the document type. Click the link from the sample request to download the KYC document.
# Get Vendor All Details
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/get
openapi/payments/v2025-01-01.yaml get /easy-split/vendors/{vendor_id}
Use this API to get the details of a specific vendor associated with your Easy Split account.
# Get Vendor All Documents Status
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/get-document
openapi/payments/v2025-01-01.yaml get /easy-split/vendor-docs/{vendor_id}
Use this API to fetch the details of all the KYC details of a particular vendor.
# Get On Demand Balance
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/get-on-demand-balance
openapi/payments/v2025-01-01.yaml get /easy-split/vendors/{vendor_id}/balances
This API fetches the available amount with the merchant, vendor, and the unsettled amount for the merchant as well as the vendor.
# Update vendor Details
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/update
openapi/payments/v2025-01-01.yaml patch /easy-split/vendors/{vendor_id}
Use this API to edit the existing vendor details added to your EasySplit account. You can edit vendor details such as name, email, phone number, upi details, and any of the KYC details.
# Overview
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/webhooks/overview
This section consists of the Easy Split Webhooks.
Webhooks are server callbacks to your server from Cashfree Payments. Webhooks are event-based and are sent when specific events happen.
The table below lists the various webhook events:
| Webhook Name | Description |
| :---------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Vendor Settlement Webhook](/api-reference/payments/latest/split/webhooks/vendor-settlement-webhooks) | Configure vendor settlement webhooks to receive automated notifications when vendor settlements are initiated, successfully processed, failed, or reversed. |
| [Vendor Status Change Webhook](/api-reference/payments/latest/split/webhooks/vendor-status-change-webhooks) | Configure vendor status change webhooks to receive automated notifications when vendor status is changed. |
# Vendor Settlement Webhook
Source: https://www.cashfree.com/docs/api-reference/payments/latest/split/webhooks/vendor-settlement-webhooks
This chapter explains the vendor settlement webhooks.
Configure vendor settlement webhooks to receive automated notifications when vendor settlements are initiated, successfully processed, failed, or reversed.
The webhook notifications are sent on all the URLs added and enabled in the settlement webhook. You can add new URLs and enable or disable existing URLs for settlement webhook at any time and it will reflect instantaneously.
The table below lists the webhook events available for settlements.
| Webhook Event | Description |
| :---------------------------- | :------------------------------------------------------------------------- |
| VENDOR\_SETTLEMENT\_INITIATED | This webhook will be triggered when a vendor settlement is initiated. |
| VENDOR\_SETTLEMENT\_SUCCESS | This webhook will be triggered when a vendor settlement is successful. |
| VENDOR\_SETTLEMENT\_FAILED | This webhook will be triggered when a vendor settlement has failed. |
| VENDOR\_SETTLEMENT\_REVERSED | This webhook will be triggered when a vendor settlement has been reversed. |
## Vendor settlement initiated
SETTLEMENT\_INITIATED webhook is triggered when a settlement has been initiated by Cashfree Payments.
```
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "CREATED",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settlement_type": null,
"settled_on": "null",
"reason": null,
"adjustment": 100.00,
"settlement_amount": 600.00,
"service_charge": 0.50,
"service_tax": 0.09,
"amount_settled": null,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"vendor_id": "esSettlementsAutomationVendor",
"vendor_transaction_amount": 500.00,
"account_mode": "BANK",
"settled_orders_count": 1,
"account_number": "XXXXXXX1234",
"ifsc": "HDFC0000001",
"vpa": null
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_CREATED"
}
```
## Vendor settlement success
```
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "SUCCESS",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settlement_type": null,
"settled_on": "2023-06-08T15:10:37+05:30",
"reason": null,
"adjustment": 100.00,
"settlement_amount": 600.00,
"service_charge": 0.50,
"service_tax": 0.09,
"amount_settled": 600.00,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"vendor_id": "esSettlementsAutomationVendor",
"vendor_transaction_amount": 500.00,
"account_mode": "UPI",
"settled_orders_count": 1,
"account_number": null,
"ifsc": null,
"vpa": "9898989898@ybl"
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_SUCCESS"
}
```
***
## Vendor settlement failed
```
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "FAILED",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settlement_type": null,
"settled_on": "null",
"reason": null,
"adjustment": 100.00,
"settlement_amount": 600.00,
"service_charge": 0.50,
"service_tax": 0.09,
"amount_settled": null,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"vendor_id": "esSettlementsAutomationVendor",
"vendor_transaction_amount": 500.00,
"account_mode": "BANK",
"settled_orders_count": 1,
"account_number": "XXXXXXX1234",
"ifsc": "HDFC0000001",
"vpa": null
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_FAILED"
}
```
***
## Vendor settlement reversed
```
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "REVERSED",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settlement_type": null,
"settled_on": "null",
"reason": Failed from bank end,
"adjustment": 100.00,
"settlement_amount": 600.00,
"service_charge": 0.50,
"service_tax": 0.09,
"amount_settled": null,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"vendor_id": "esSettlementsAutomationVendor",
"vendor_transaction_amount": 500.00,
"account_mode": "BANK",
"settled_orders_count": 1,
"account_number": "XXXXXXX1234",
"ifsc": "HDFC0000001",
"vpa": null
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_REVERSED"
}
```
***
## Payload field description
| Field | Description | Example |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- |
| adjustment | The sum of refunds, disputes, and chargeback part of this settlement is displayed here. | 0 |
| amount\_settled | The total amount that is settled in this schedule option. | 50 |
| payment\_amount | Total transaction amount considered for settlement. | 100 |
| payment\_from | Start date from which the payments are considered for settlement. | 2022-03-15 |
| payment\_till | End date till which the payments are considered for settlement. | 2022-03-23 |
| reason | Reason for failed and reversed settlements. | Transfer mode is not valid for beneficiary. |
| service\_charge | Service charges are applicable for the payments that are included in this settlement. | 2 |
| service\_tax | Service tax is applicable for the payments that are included in this settlement. | 0.50 |
| settled\_on | Date and time at which the settlement was processed. | 2022-03-17T14:21:18+05:30 |
| settlement\_amount | The sum of net settlement amount for the payments part of this settlement. | 13 |
| settlement\_id | Cashfree settlement ID | 1155353 |
| settlement\_initiated\_on | The date on which settlement was initiated. | 2022-03-17T14:29:21+05:30 |
| status | Status of the settlement (either INITIATED, SUCCESS, FAILED, or REVERSED) | SUCCESS |
| utr | The unique transaction reference number is given by the bank for the settlement. | N076221079016329 |
| vendor\_id | Reference ID as shared by you when onboarding the vendor. | IS\_1hour\_Upi |
| vendor\_transaction\_amount | Transaction amount split of vendor | 50 |
| event\_time | Time at which settlement webhook was initiated. | 2022-03-17T14:29:23+05:30 |
| type | Type of webhook - VENDOR\_SETTLEMENT\_INITIATED, VENDOR\_SETTLEMENT\_SUCCESS, VENDOR\_SETTLEMENT\_FAILED, or VENDOR\_SETTLEMENT\_REVERSED. | VENDOR\_SETTLEMENT\_SUCCESS |
## Reasons for failed and reversed settlements
| Reason | Category | Description |
| :----------------------------------- | :------- | :--------------------------------------------------- |
| BANK\_GATEWAY\_ERROR | Bank | Technical error at the bank |
| BENE\_BANK\_DECLINED | Bank | Rejected by Beneficiary bank due to business reasons |
| FAILED | Bank | No explicit failure reason from the bank |
| INVALID\_IFSC\_FAIL | Customer | Invalid ifsc code provided for bank account |
| INVALID\_ACCOUNT\_FAIL | Customer | Bank account is invalid |
| RETURNED\_FROM\_BENEFICIARY | Bank | Immediate reversal from the beneficiary bank |
| INSUFFICIENT\_BALANCE | Vendor | Your balance is exhausted, need to add funds |
| IMPS\_MODE\_FAIL | Bank | IMPS mode not supported for the beneficiary |
| RTGS\_MODE\_FAIL | Bank | RTGS mode not supported (only for RTGS) |
| REINITIALIZE\_TRANSFER\_LATER | Bank | Technical error at the bank, retry later |
| NRE\_ACCOUNT\_FAIL | Customer | Customer bank account is an NRE account |
| ACCOUNT\_BLOCKED | Customer | Customer bank account is blocked |
| DEST\_LIMIT\_REACHED | Bank | Transfer limit to beneficiary exceeded |
| INVALID\_MODE\_FAIL | Bank | Transfer mode not valid for beneficiary |
| NPCI\_UNAVAILABLE | Bank | NPCI in unavailable |
| BENEFICIARY\_BANK\_OFFLINE | Bank | Beneficiary bank is offline |
| INVALID\_AMOUNT\_FAIL | Vendor | Amount is invalid for the given transfer mode |
| SUSPECTED\_TRANSFER | Customer | Suspicious transfer identified |
| BENE\_NAME\_DIFFERS | Customer | Beneficiary name not matching with bank records |
| DISABLED\_MODE | Vendor | Transfer mode not enabled for the account |
| AMAZON\_AMOUNT\_EXCEED | Vendor | Amount should be less than 10000 for Amazon Pay mode |
| BENEFICIARY\_BLACKLISTED | Vendor | Beneficiary is blacklisted |
| PAYOUT\_INACTIVE | Vendor | Payout account is not active |
| INVALID\_TRANSFER\_AMOUNT | Vendor | Transfer amount is invalid |
| BENEFICIARY\_NOT\_EXIST | Vendor | Beneficiary does not exist |
| BENEFICIARY\_INVALID\_MODE | Vendor | Mode Not valid for Beneficiary |
| INVALID\_BENE\_ACCOUNT\_OR\_IFSC | Vendor | Invalid bank account number or ifsc provided |
| BENEFICIARY\_NAME\_DIFFERS | Customer | Beneficiary name not matching with bank records |
| ANY\_OTHER\_REASON | Bank | No reason provided for the failure/reversal |
| INVALID\_OR\_NO\_SUCH\_ACCOUNT\_TYPE | Customer | Invalid account |
***
## Signature verification
The signature must be used to verify if the request has not been tampered with. To verify the signature at your end, you will need your Cashfree PG secret key along with the payload.
timestamp is present in the header x-webhook-timestamp\
Actual signature is present in the header x-webhook-signature
```
"headers": {
"host": "gamma.cashfree.com",
"x-request-id": "ad4dc1e65f8901302455b247237a667a",
"x-real-ip": "172.0.57.13",
"x-forwarded-for": "172.0.57.13",
"x-forwarded-host": "gamma.cashfree.com",
"x-forwarded-port": "80",
"x-forwarded-proto": "http",
"x-forwarded-scheme": "http",
"x-scheme": "http",
"x-original-forwarded-for": "52.66.25.127",
"content-length": "592",
"accept": "_/_",
"content-type": "application/json",
"user-agent": "ReactorNetty/1.0.30",
"x-datadog-parent-id": "4281924148563621550",
"x-datadog-sampling-priority": "1",
"x-datadog-trace-id": "228569355002181270",
"x-webhook-signature": "Xm0YzEJCRsh0XvIEK12D4FqpmC60cReKoqPBn424kV0=",
"x-webhook-timestamp": "1686217237543",
"x-webhook-version": "2022-09-01"
}
```
Watch this video to learn more on Vendor Webhooks:
Previous versions: 2023-08-01, 2021-05-21, 2022-01-01, 2022-09-01 | # Error Codes and Reasons Source: https://www.cashfree.com/docs/api-reference/payments/latest/subscription/error-codes Learn more about subscription error codes, failure reasons, and their resolutions ## Error codes The following are the common error codes returned by the Subscription APIs: | Error Code | Description | Resolution | | ----------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `subscription_id_missing` | Subscription ID is required but missing in the request | Ensure the subscription ID is included in your API request | | `plan_id_missing` | Plan ID is missing, invalid, or not found | Verify the plan ID exists and is correctly specified | | `payment_id_missing` | Payment ID is missing or not found | Include a valid payment ID in your request | | `subscription_id_missing_request_failed_failed` | Subscription ID missing; request failed | Add the required subscription ID parameter | | `invalid_payment_type` | Invalid payment type specified | Use supported payment types: 'E\_MANDATE', 'UPI', or 'CARD' | | `subscription_does_not_exist` | Subscription doesn't exist for the provided reference ID | Verify the subscription reference ID is correct | | `authorization_payment_info_mismatch` | Authorization payment info doesn't match subscription creation info | Ensure payment details match between subscription creation and authorization | | `tpv_not_supported` | TPV currently not allowed for Intent and QR auth flow | Use alternative auth flows when TPV is enabled | ## Transaction failure reasons The following are the detailed failure reasons categorised by their nature: * [Account issues](#account-issues) * [Balance and limit issues](#balance-and-limit-issues) * [Mandate issues](#mandate-issues) * [Fraud and security](#fraud-and-security) * [Technical issues](#technical-issues) * [Customer action required](#customer-action-required) * [Invalid data and validation](#invalid-data-and-validation) * [Know your customer and documentation](#know-your-customer-and-documentation) * [System and processing status](#system-and-processing-status) * [Notification issues](#notification-issues) ### Account issues The following are the account-related error codes: | Error | Description | Resolution | | ------------------------------------------------------------------ | ------------------------------------------------------------------------ | -------------------------------------------------------------- | | `ACCOUNT CLOSED` | The account has been closed and all associated mandates were deactivated | Create a new mandate with a different account for the customer | | `Account Blocked or frozen` | Account is temporarily blocked (for example, KYC not updated) | Customer needs to contact their bank to unblock the account | | `DEBIT HAS BEEN FAILED \| ACCOUNT DOES NOT EXIST (REMITTER)` | Account verification failed due to incorrect account details | Verify and update correct account information | | `Not a CBS act no.or old act no.representwithCBS no` | Account given for debit is old/non CBS/wrong/invalid | Use a valid CBS-enabled account number | | `DEBIT HAS BEEN FAILED \| REMITTER CBS OFFLINE` | Core Banking System is offline | Wait for CBS to come online and retry | | `U30\|DEBIT HAS BEEN FAILED\|YE\|REMITTING ACCOUNT BLOCKED/FROZEN` | Remitting account is blocked or frozen | Customer should contact their bank to resolve account issues | ### Balance and limit issues The following are the balance and limit-related error codes: | Error | Description | Resolution | | ----------------------------------------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------- | | `Balance Insufficient` | Insufficient funds in customer account | Customer should add funds or retry when balance is available | | `DEBIT HAS BEEN FAILED \| INSUFFICIENT FUNDS IN CUSTOMER (REMITTER) ACCOUNT` | Insufficient balance in customer account | Recommend customer to maintain sufficient balance before retry | | `U30\|DEBIT HAS BEEN FAILED\|Z9\|INSUFFICIENT FUNDS IN CUSTOMER (REMITTER) ACCOUNT` | Insufficient funds in remitter account | Customer needs to ensure adequate balance | | `Amount Exceeds E-mandate Limit` | Transaction amount exceeds the e-mandate limit | Reduce amount or increase mandate limit if supported | | `DEBIT HAS BEEN FAILED \| PER TRANSACTION LIMIT EXCEEDED AS SET BY REMITTING MEMBER` | Per transaction limit exceeded | Use amount within the set transaction limits | | `U29\|ADDRESS RESOLUTION IS FAILED\|QL\|MANDATE DEBIT IS BEYOND PSP SPECIFIED AMOUNT CAP` | Amount limit is breached | Ensure amount is within PSP specified limits | | `DEBIT HAS BEEN FAILED \| MANDATE REQUEST LIMIT HAS BREACHED` | Mandate request limit has been breached | Wait for limit reset or contact support | | `U30\|DEBIT HAS BEEN FAILED\|QK\|MANDATE REQUEST LIMIT HAS BREACHED` | Mandate request limit exceeded | Review and adjust mandate limits | | `Not Arranged For` | Bank account isn't set up to facilitate debit transaction | Customer should contact bank to set up debit facility | ### Mandate issues The following are the mandate-related error codes: | Error | Description | Resolution | | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ------------------------------------------------------------------- | | `Invalid UMRN or Inactive Mandate` | Mandate has been deactivated by NPCI or cancelled by customer/merchant | Create a new mandate for the customer | | `Mandate Cancelled` | Mandate has been cancelled by customer or merchant | Create a new mandate to continue debits | | `Record Level Error: Invalid Mandate Info` | Mandate cancelled by customer from bank | Create a new mandate with updated information | | `DEBIT HAS BEEN FAILED \| MANDATE HAS BEEN REVOKED` | Mandate has been revoked | Create a new mandate for the customer | | `DEBIT HAS BEEN FAILED \| MANDATE SIGNATURE IS TAMPERED OR CORRUPT (REMITTER)` | Mandate signature is corrupted | Customer should contact issuing bank | | `DUPLICATE MANDATE REQUEST FOR SAME ITEM` | Duplicate mandate request submitted | Avoid duplicate requests or check existing mandates | | `Mandate Qr tampered` | Mandate QR code has been tampered with | Generate a new mandate with fresh QR code | | `U29\|ADDRESS RESOLUTION IS FAILED\|QB\|MANDATE IS ALREADY HONOURED` | Duplicate transaction attempt | Ensure transaction isn't a duplicate of a previously successful one | | `Invalid frequency` | Invalid frequency specified for LOAN category | Use appropriate frequency as per NPCI guidelines | ### Fraud and security The following are the fraud and security-related error codes: | Error | Description | Resolution | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | -------------------------------------------------------- | | `DEBIT HAS BEEN FAILED \| SUSPECTED FRAUD` | Transaction flagged as suspected fraud | Customer should contact their bank for clearance | | `U30\|DEBIT HAS BEEN FAILED\|K1\|SUSPECTED FRAUD, DECLINE / TRANSACTIONS DECLINED BASED ON RISK SCORE BY REMITTER` | Risk-based decline by remitter bank | Customer may retry or contact bank | | `ADDRESS RESOLUTION IS FAILED \| TRANSACTION CANNOT BE COMPLETED. COMPLIANCE VIOLATION (REMITTER)` | Compliance violation detected | Ensure transaction complies with regulatory requirements | | `DEBIT HAS BEEN FAILED \| DO NOT HONOUR (REMITTER)` | Debit transaction rejected by issuing bank | Customer should contact their bank | ### Technical issues The following are the technical error codes: | Error | Description | Resolution | | --------------------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------- | | `REMITTER BANK NOT AVAILABLE` | Remitter bank system is unavailable | Retry the transaction after some time | | `DEBIT TIMEOUT \| REMITTER/ISSUER UNAVAILABLE (TIMEOUT)` | Bank system timeout occurred | Retry the transaction when bank systems are stable | | `U67\|DEBIT TIMEOUT\|UT\|REMITTER/ISSUER UNAVAILABLE (TIMEOUT)` | Timeout from remitter or issuer | Retry during stable network conditions | | `REMITTER BANK DEEMED HIGH RESPONSE TIME CHECK DECLINE` | Bank system experiencing high traffic or technical issues | Retry during off-peak hours | | `U90\|REMITTER BANK DEEMED HIGH RESPONSE TIME CHECK DECLINE` | High response time from remitter bank | Retry when bank systems are more responsive | | `U91\|BENEFICIARY BANK DEEMED HIGH RESPONSE TIME CHECK DECLINE` | Beneficiary bank system issues | Retry when bank systems are stable | | `No response received from bank within the prescribed API time limit` | Bank API timeout | Retry the transaction | | `ADD_RESLN_DISPATCH_FAILED` | Address resolution dispatch failure | Contact support for technical assistance | ### Customer action required The following are the error codes that require customer action: | Error | Description | Resolution | | ------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------- | | `No action performed by customer` | Customer didn't complete the authorization process | Customer needs to complete the payment flow | | `COLLECT EXPIRED` | Customer didn't complete auth after entering VPA | Customer should complete the transaction within time limit | | `RESPMANDATE TIMEOUT AT REMITTER END` | Customer didn't honor the mandate within time | Customer should respond to mandate requests | | `RESPMANDATE DECLINED BY REMITTER BANK` | Remitter bank declined the mandate | Customer should contact their bank | | `RESPAUTHMANDATE EXPIRED` | No action performed on collect request and it expired | Customer should complete authorization within time limit | | `RESPAUTHMANDATE DECLINED BY PSP` | PSP declined the authorization mandate | Contact support for assistance | | `Transaction Open Status` | Customer closed transaction page before completion or retried failed transaction | Complete the transaction without closing the page | | `No Details available for Requested MandateReqID` | Customer cancelled mandate before reaching NPCI page | Reinitiate the mandate creation process | ### Invalid data and validation The following are the data validation error codes: | Error | Description | Resolution | | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------- | | `U29\|ADDRESS RESOLUTION IS FAILED\|ZH\|INVALID VIRTUAL ADDRESS` | Invalid VPA used in transaction | Use a valid and verified VPA | | `ADDRESS RESOLUTION IS FAILED \| INVALID VIRTUAL ADDRESS` | Invalid Virtual Address during VPA validation | Verify and use correct VPA | | `DEBIT HAS BEEN FAILED \| INVALID TRANSACTION OR IF MEMBER IS NOT ABLE TO FIND ANY APPROPRIATE RESPONSE CODE (REMITTER)` | Invalid transaction or unrecognized response | Retry with valid transaction details | | `U30\|DEBIT HAS BEEN FAILED\|XB\|INVALID TRANSACTION OR IF MEMBER IS NOT ABLE TO FIND ANY APPROPRIATE RESPONSE CODE (REMITTER)` | Invalid transaction from remitter | Verify transaction details and retry | | `DEBIT HAS BEEN FAILED \| INVALID RESPONSE CODE` | Invalid response received from bank | Retry the transaction | | `U30\|DEBIT HAS BEEN FAILED\|XD\|INVALID AMOUNT (REMITTER)` | Invalid amount specified | Use valid amount format and value | | `DEBIT HAS BEEN FAILED \| RegIdDetails must be present` | Required registration details missing | Ensure all required details are provided | | `U30\|DEBIT HAS BEEN FAILED\|V1\|RegIdDetails must be present` | Registration details missing | Include all required registration information | | `DEBIT HAS BEEN FAILED \| Id name must be present` | Required ID name field missing | Include the ID name field in the request | ### Know your customer and documentation The following are the KYC and documentation-related error codes: | Error | Description | Resolution | | ------------------------------------------------------------------ | ------------------------------------- | --------------------------------------------------- | | `Aadhaar number does not have mobile number registered with uidai` | Mobile number not linked with Aadhaar | Customer should link mobile number with Aadhaar | | `Payer Account Validation Failure` | TPV verification failed | Ensure correct account details for TPV verification | ### System and processing status The following are the system and processing status error codes: | Error | Description | Resolution | | -------------------------------- | --------------------------------------------------------- | ----------------------------------------------------- | | `Internal Payment Failed` | Internal system error during payment processing | Retry the transaction or contact support | | `Charge couldn't happen on time` | Previous charge was in progress, preventing next charge | Wait for previous charge to complete | | `Previous request in progress` | Previous request for same action is still being processed | Wait for previous request to complete before retrying | | `debit has been failed` | Bank didn't send any failure reason | Check with bank for specific failure details | ### Notification issues The following are the notification-related error codes: | Error | Description | Resolution | | -------------------------------------------------------- | -------------------------------------- | ------------------------------------------- | | `Notification couldn't be sent to the customer` | Pre-debit notification failed to send | Ensure customer contact details are correct | | `DEBIT HAS BEEN FAILED \| Unable to Notify the Customer` | Pre-debit notification delivery failed | Update customer contact information | ## Error response structure Subscription API errors follow this structure: ```json theme={"dark"} { "status": "ERROR", "subCode": "400", "message": "Error description", "reason": "Detailed error reason" } ``` ## Best practices for error handling The following are the recommended practices for handling subscription errors: **Implement retry logic**: * For timeout and temporary errors, implement exponential backoff retry logic. * Start with a 1-second delay, double the delay for each subsequent retry. * Use a maximum of 3-5 retry attempts. * Apply different retry strategies for different error types. **Customer communication**: * Provide clear, actionable error messages to customers. * Include specific steps they need to take for resolution. * Avoid technical jargon in customer-facing messages. **Mandate management**: * Monitor mandate status. * Proactively create new mandates when existing ones are cancelled or expired. * Implement mandate renewal work flows before expiration. **Balance monitoring**: * Advise customers to maintain sufficient balance before scheduled debits. * Send pre-debit notifications to remind customers. * Implement balance check APIs where available. **Error logging and monitoring**: * Log all errors with timestamps and request details. * Set up alerts for critical error patterns. * Analyse error trends to identify systemic issues. **Graceful degradation**: * Provide alternative payment methods when subscription payment fails. * Implement fallback mechanisms for critical payment flows. * Maintain service availability despite individual payment failures. **Security considerations**: * Handle fraud-related errors with additional verification steps. * Implement risk scoring for suspicious transaction patterns. * Maintain compliance with regulatory requirements.
Start here
Create Order
Generate a order to collect payments from your customers.
Get Order
Get status and details of an order created.
Get Payments
Get status and details of payments customer has done for an order.
Popular
What's New
Stay updated with the latest features and enhancements in Cashfree Payments API.
Best Practices for APIs
Learn about best practices to follow while integrating with Cashfree Payments API.
cf\_amount1cf\_eventSUBSCRIPTION\_NEW\_PAYMENTcf\_eventTime2022-01-10 10:51:02cf\_paymentId1cf\_referenceId2cf\_retryAttempts0cf\_subReferenceId3tT9pXZkT2LuDzXacYDUaur7EX3dJgNKcITHQng44tns=The previous versions were 2021-05-21,2022-01-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/previous/v2022-09-01/orders/create-order) | Use this API to create orders with Cashfree from your backend and get the payment link. | | [Order Pay](/api-reference/payments/previous/v2022-09-01/payments/order-pay) | Use this API when you have already created the orders and want Cashfree Payments to process the payment. | | [Preauthorization](/api-reference/payments/previous/v2022-09-01/payments/preauthorization) | Use this API to capture or void a preauthorized payment. | | [Get Order](/api-reference/payments/previous/v2022-09-01/orders/get-order) | Use this API to view all details of an order. | ### Authentication | API | Description | | :------------------------------------------------------------------------------------------------- | :-------------------------------------------------------- | | [Submit or Resend OTP](/api-reference/payments/previous/v2022-09-01/payments/submit-or-resend-otp) | Use the submit or resend OTP API to send OTP to Cashfree. | ### Payments | API | Description | | :----------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- | | [Get Payments for an Order](/api-reference/payments/previous/v2022-09-01/payments/get-payments-for-an-order) | Use this API to view all payment details for an order. | | [Get Payment by ID](/api-reference/payments/previous/v2022-09-01/payments/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](/api-reference/payments/previous/v2022-09-01/settlements/get-settlements-by-order-id) | Use this API to view all the settlements of a particular order. | | [Get All Settlements](/api-reference/payments/previous/v2022-09-01/settlement-reconciliation/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](/api-reference/payments/previous/v2022-09-01/payment-links/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](/api-reference/payments/previous/v2022-09-01/payment-links/fetch-payment-link-details) | Use this API to view all details and status of a payment link. | | [Get Orders for a Payment Link](/api-reference/payments/previous/v2022-09-01/payment-links/get-orders-for-a-payment-link) | Use this API to view all order details for a payment link. | | [Cancel Payment Link](/api-reference/payments/previous/v2022-09-01/payment-links/get-orders-for-a-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](/api-reference/payments/previous/v2022-09-01/token-vault/fetch-all-saved-card-instrument) | Use this API to get all saved instruments for a customer ID. | | [Fetch Single Saved Instrument](/api-reference/payments/previous/v2022-09-01/token-vault/fetch-specific-saved-card-instrument) | Use this API to get specific saved instrument for a customer id and instrument ID. | | [Delete Saved Instrument](/api-reference/payments/previous/v2022-09-01/token-vault/delete-saved-card-instrument) | Use this API to delete a saved instrument for a customer id and instrument ID. | | [Fetch Cryptogram for Saved Instrument](/api-reference/payments/previous/v2022-09-01/token-vault/fetch-cryptogram-for-a-saved-card-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](/api-reference/payments/previous/v2022-09-01/settlement-reconciliation/settlement-reconciliation) | Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. | | [PG Reconciliation](/api-reference/payments/previous/v2022-09-01/pg-reconciliation/pg-reconciliation) | Use this API to get the payment gateway reconciliation details with date range. | # Cancel Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payment-links/cancel-payment-link openapi/payments/v2022-09-01.yaml post /links/{link_id}/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. # Create Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payment-links/create-payment-link openapi/payments/v2022-09-01.yaml post /links 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 Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payment-links/fetch-payment-link-details openapi/payments/v2022-09-01.yaml get /links/{link_id} Use this API to view all details and status of a payment link. # Get Orders for a Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payment-links/get-orders-for-a-payment-link openapi/payments/v2022-09-01.yaml get /links/{link_id}/orders Use this API to view all order details for a payment link. # Get Payment by ID Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/get-payment-by-id openapi/payments/v2022-09-01.yaml get /orders/{order_id}/payments/{cf_payment_id} Use this API to view payment details of an order for a payment ID. # Get Payments for an Order Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/get-payments-for-an-order openapi/payments/v2022-09-01.yaml get /orders/{order_id}/payments Use this API to view all payment details for an order. # Order Pay Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/order-pay openapi/payments/v2022-09-01.yaml post /orders/sessions Use this API when you have already created the orders and want Cashfree to process the payment. To use this API S2S flag needs to be enabled from the backend. In case you want to use the cards payment option the PCI DSS flag is required, for more information reach out to us by filling out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1). # Preauthorization Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/preauthorization openapi/payments/v2022-09-01.yaml post /orders/{order_id}/authorization Use this API to capture or void a preauthorized payment # Submit or Resend OTP Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/submit-or-resend-otp openapi/payments/v2022-09-01.yaml post /orders/pay/authenticate/{cf_payment_id} If you accept OTP on your own page, you can use the below API to send OTP to Cashfree. # PG Reconciliation Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/pg-reconciliation/pg-reconciliation openapi/payments/v2022-09-01.yaml post /recon - Use this API to get the payment gateway reconciliation details with date range. - It will have events for your payment account # Create Refund Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/refunds/create-refund openapi/payments/v2022-09-01.yaml post /orders/{order_id}/refunds Use this API to initiate refunds. # Get All Refunds for an Order Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/refunds/get-all-refunds-for-an-order openapi/payments/v2022-09-01.yaml get /orders/{order_id}/refunds Use this API to fetch all refunds processed against an order. # Get Refund Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/refunds/get-refund openapi/payments/v2022-09-01.yaml get /orders/{order_id}/refunds/{refund_id} Use this API to fetch a specific refund processed on your Cashfree Account. # Get All Settlements Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/settlement-reconciliation/get-all-settlements openapi/payments/v2022-09-01.yaml post /settlements Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range. # Settlement Reconciliation Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/settlement-reconciliation/settlement-reconciliation openapi/payments/v2022-09-01.yaml post /settlement/recon - Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. - This API will return events for the settlement IDs you want # Get Settlements by Order ID Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/settlements/get-settlements-by-order-id openapi/payments/v2022-09-01.yaml get /orders/{order_id}/settlements Use this API to view all the settlements of a particular order. # Create Terminal Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/create-terminal openapi/payments/v2022-09-01.yaml post /terminal Use this API to create new terminals to use softPOS. # Create Terminal Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/create-terminal-1 openapi/payments/v2022-09-01.yaml post /terminal/transactions Use this API to create a new terminal transaction. To use this API you should first create an order using the Create Order API. Also, you need to enter the terminal details while creating the order and pass the same terminal information while creating a transaction using the below mentioned API. # Fetch Terminal QR Codes Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/fetch-terminal-qr-codes openapi/payments/v2022-09-01.yaml get /terminal/qrcodes You can fetch all the StaticQRs corresponding to given terminal id or phone number. Provide either the terminal_phone_no or terminal_id in the request. # Get terminal status using phone number Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/get-terminal-status-using-phone-number openapi/payments/v2022-09-01.yaml get /terminal/{terminal_phone_no} Use this API to view all details of a terminal. # softPOS Webhooks Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks Learn in detail about softPOS webhooks. Webhooks are server callbacks to your server from Cashfree Payments. Webhooks are event-based and are sent when specific events related to the transaction happen. Cashfree Payments sends the following webhooks for softPOS: * [Payment Success](/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks#payment-success-webhook-version-2022-09-01) * [Payment Failed](/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks#payment-failed-webhook-version-2022-09-01) * [User Dropped](/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks#user-dropped-webhook-version-2022-09-01) * [Refunds](/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks#refund-webhook-version-2022-09-01) * [Auto Refund](/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks#auto-refund-webhook-version-2022-09-01) * [Disputes](/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks#dispute-webhooks-version-2022-09-01) ## Payment Success Webhook Version: (2022-09-01) The new payment success webhook notifies you about the payment, and gives you comprehensive information about successful payments. A notification is sent to your backend from Cashfree Payments when payments are successful. These notifications are useful in cases when the internet connection is unstable or slow while the payment is being processed. This will allow you to reconcile all the successful orders at your end. Notifications will be sent to **notifyUrl** which is a part of the request parameter specified while creating an order request as well as endpoints configured on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). #### Sample payload ```{ theme={"dark"} "data": { "order": { "order_id": "order_OFR_2", "order_amount": 2, "order_currency": "INR", "order_tags": null }, "payment": { "cf_payment_id": 1453002795, "payment_status": "SUCCESS", "payment_amount": 1, "payment_currency": "INR", "payment_message": "00::Transaction success", "payment_time": "2022-12-15T12:20:29+05:30", "bank_reference": "234928698581", "auth_id": null, "payment_method": { "upi": { "channel": null, "upi_id": "9611199227@paytm" } }, "payment_group": "upi" }, "customer_details": { "customer_name": null, "customer_id": "7112AAA812234", "customer_email": "[miglaniyogesh7@gmail.com]()", "customer_phone": "9908734801" }, "payment_gateway_details": { "gateway_name": "CASHFREE", "gateway_order_id": "1580762800", "gateway_payment_id": "1453002795", "gateway_status_code": null }, "payment_offers": [ { "offer_id": "0f05e1d0-fbf8-4c9c-a1f0-814c7b2abdba", "offer_type": "DISCOUNT", "offer_meta": { "offer_title": "50% off on UPI", "offer_description": "50% off for testing", "offer_code": "UPI50", "offer_start_time": "2022-11-09T06:23:25.972Z", "offer_end_time": "2023-02-27T18:30:00Z" }, "offer_redemption": { "redemption_status": "SUCCESS", "discount_amount": 1, "cashback_amount": 0 } } ], "terminal_details": { "cf_terminal_id": 989876, "terminal_phone": "9773769999" } }, "event_time": "2023-01-03T11:16:10+05:30", "type": "PAYMENT_SUCCESS_WEBHOOK" } ``` ## Payment Failed Webhook Version: (2022-09-01) The payment failed webhook notifies you when transactions fail and we receive a failed response from the bank. ```{ theme={"dark"} "data": { "order": { "order_id": "CFPay_g47u3888d0k0_tblfm766qc", "order_amount": 1.8, "order_currency": "INR", "order_tags": { "cf_link_id": "13746255" } }, "payment": { "cf_payment_id": 1504280029, "payment_status": "FAILED", "payment_amount": 1.8, "payment_currency": "INR", "payment_message": "AMOUNT SHOULD BE WITHIN RANGE BETWEEN 20.00 TO 500000.00.", "payment_time": "2023-01-06T20:00:11+05:30", "bank_reference": "NA", "auth_id": "null", "payment_method": { "netbanking": { "channel": null, "netbanking_bank_code": "3054", "netbanking_bank_name": "UCO Bank" } }, "payment_group": "net_banking" }, "customer_details": { "customer_name": null, "customer_id": null, "customer_email": null, "customer_phone": "9611199227" }, "error_details": { "error_code": "GATEWAY_ERROR", "error_description": "AMOUNT SHOULD BE WITHIN RANGE BETWEEN 20.00 TO 500000.00. for this bank", "error_reason": "invalid_amount", "error_source": "cashfree" }, "payment_gateway_details": { "gateway_name": "CASHFREE", "gateway_order_id": "1634766330", "gateway_payment_id": "1504280029", "gateway_status_code": null }, "payment_offers": null, "terminal_details": { "cf_terminal_id": 989876, "terminal_phone": "9773769999" } }, "event_time": "2023-01-06T20:00:12+05:30", "type": "PAYMENT_FAILED_WEBHOOK" } ``` ## User Dropped Webhook Version: (2022-09-01) The User Dropped Webhook notifies you when customers drop out of the payment flow without completing the transaction. It will help you understand if customers attempted to pay or not. Some common scenarios where the transaction will be marked as USER\_DROPPED are: * Android UPI Intent Payments - when a user clicks on the back button in the UPI app without making any payment attempt. * Card Payments - when a user drops out of the payment flow by closing the OTP verification page. * UPI Collect Transactions - when a user does not enter the UPI PIN and closes the transaction screen ```{ theme={"dark"} "data": { "order": { "order_id": "testspos83", "order_amount": 1.00, "order_currency": "INR", "order_tags": null }, "payment": { "cf_payment_id": 2150264295, "payment_status": "USER_DROPPED", "payment_amount": 1.00, "payment_currency": "INR", "payment_message": null, "payment_time": "2023-11-03T12:37:32+05:30", "bank_reference": null, "auth_id": null, "payment_method": { "upi": { "channel": null, "upi_id": "testsuccess@gocash" } }, "payment_group": "upi" }, "customer_details": { "customer_name": "johndoe", "customer_id": "9112", "customer_email": "[johndoe@cashfree.com]()", "customer_phone": "9876543210" }, "payment_gateway_details": { "gateway_name": null, "gateway_order_id": null, "gateway_payment_id": null, "gateway_status_code": null, "gateway_settlement": null }, "payment_offers": null, "terminal_details": { "cf_terminal_id": 20532321, "terminal_phone": "9876543210" } }, "event_time": "2023-11-03T12:37:44+05:30", "type": "PAYMENT_USER_DROPPED_WEBHOOK" } ``` ## Refund Webhook Version: (2022-09-01) Refund webhooks can be configured to receive automated notifications for refunds when either they are successfully processed or are cancelled. Merchants can build their own downstream systems like auto-updating their refund status, and sending a communication to customers by consuming refund webhooks. The webhook notification will be sent on all the URLs added and enabled under the refund webhook. Merchants can add new URLs and enable or disable existing URLs for refund webhook at any point in time and it will be reflected instantaneously. #### Sample payload ``` { "data": { "refund": { "cf_refund_id": 11325632, "cf_payment_id": 789727431, "refund_id": "refund_sampleorder0413", "order_id": "sampleorder0413", "refund_amount": 2.00, "refund_currency": "INR", "entity": "Refund", "refund_type": "MERCHANT_INITIATED", "refund_arn": "205907014017", "refund_status": "SUCCESS", "status_description": "Refund processed successfully", "created_at": "2022-02-28T12:54:25+05:30", "processed_at": "2022-02-28T13:04:27+05:30", "refund_charge": 0, "refund_note": "Test", "refund_splits": [ { "merchantVendorId": "sampleID12345", "amount": 1, "percentage": null }, { "merchantVendorId": "otherVendor", "amount": 1, "percentage": null } ], "metadata": null, "refund_mode": "STANDARD", "terminal_details": { "cf_terminal_id": 911876, "terminal_phone": "9876543210" } } }, "event_time": "2022-02-28T13:04:28+05:30", "type": "REFUND_STATUS_WEBHOOK" } ``` #### Payload field description | Field | Description | Example | | :------------------ | :-------------------------------------------------------------------------- | :---------------------------- | | cf\_refund\_id | Cashfree Payments ID for a refund. | 11325632 | | cf\_payment\_id | Cashfree Payments ID of the payment for which refund is initiated. | 789727431 | | cf\_terminal\_id | Cashfree Payments Terminal ID of the payment for which refund is initiated. | 21345 | | terminal\_phone | The phone number of the corresponding terminal. | 9876543212 | | refund\_id | Merchant’s refund ID of the refund | refund\_sampleorder0413 | | order\_id | Merchant’s order Id of the order for which refund is initiated. | sampleorder0413 | | refund\_amount | Amount that was refunded | 2.00 | | refund\_currency | Currency of the refund amount. | INR | | entity | Type of object (refund always) | Refund | | refund\_type | Type of refund (for webhook it will always be MERCHANT\_INITIATED) | MERCHANT\_INITIATED | | refund\_arn | The bank reference number for refund | 205907014017 | | refund\_status | Status of the refund (either SUCCESS or CANCELLED in refund webhook) | SUCCESS | | status\_description | Description of refund status | Refund processed successfully | | created\_at | Time of refund creation | 2022-02-28T12:54:25+05:30 | | processed\_at | Time when refund was processed successfully | 2022-02-28T13:04:27+05:30 | | refund\_charge | Charges in INR for processing refund | 0 | | refund\_note | Note added by merchant for the refund | Cancelled Order | | refund\_splits | Refund split details | \[] | | metadata | Additional refund metadata | null | | refund\_mode | Method or speed of processing refund (INSTANT or STANDARD) | STANDARD | | event\_time | Time at which refund webhook was initiated. | 2022-02-28T13:04:28+05:30 | | type | Type of webhook. REFUND\_STATUS\_WEBHOOK always | REFUND\_STATUS\_WEBHOOK | ## Auto Refund Webhook Version: (2022-09-01) Auto-refund webhooks can be configured to receive automated notifications when auto-refunds are initiated, processed and delayed. Auto-refunds are refunds triggered automatically for unsuccessful payments, disputes, duplicate payments; or instances where payments are received directly to your VPA, regardless of whether an order has been generated. Webhook notifications are sent to every URL added and enabled under **Auto-refund Webhooks**. Merchants can add new URLs and enable or disable existing ones for auto-refund webhooks at any point in time. The changes are reflected instantaneously. #### Sample payload ```Text Auto-Refund Webhook Sample Payload theme={"dark"} { "data": { "auto_refund": { "event": "AUTO-REFUND", "cf_refund_id": 1243460973, "cf_payment_id": "2148333968", "bank_reference": "234928698581", "order_id": "order_1944392Tpba8y2fHcHVx0SwREojp51Jgr", "refund_amount": 39, "refund_currency": "INR", "refund_type": "PAYMENT_AUTO_REFUND", "refund_arn": "205907014017", "refund_status": "SUCCESS", "status_description": "Auto-Refund processed successfully", "refund_reason": "Multiple payments were performed against same order.", "created_at": "2023-08-11T14:08:28+05:30", "processed_at": null, "refund_charge": 0, "refund_splits": null, "metadata": null }, "terminal_details": { "cf_terminal_id": 989876, "terminal_phone": "9773769999" } }, "event_time": "2023-08-11T14:10:21+05:30", "type": "AUTO_REFUND_STATUS_WEBHOOK" } ``` Find the description for each field of the payload below: | Field | Description | Example | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | | cf\_refund\_id | It represents the ID created by Cashfree Payments to identify the refund. | 1243460973 | | cf\_payment\_id | It represents the ID created by Cashfree Payments to identify the payment for the initiated refund. | 2148333968 | | cf\_terminal\_id | Cashfree Payments Terminal ID of the payment for which refund is initiated. | 21345 | | terminal\_phone | The phone number of the corresponding terminal. | 9876543212 | | order\_id | It represents the ID created by you to identify the order for which the refund is initiated. | sampleorder0413 | | bank\_reference | It represents the bank reference number for the transaction. | 234928698581 | | refund\_currency | It represents the currency of the refund amount. | INR | | refund\_amount | It represents the refunded amount. | 2 | | refund\_type | It represents the refund type. The value will always be PAYMENT\_AUTO\_REFUND. | PAYMENT\_AUTO\_REFUND | | refund\_arn | It represents the bank reference number for the refund. | 205907014017 | | refund\_status | It represents the status of the refund (either SUCCESS or INITIATED). | SUCCESS | | status\_description | It represents the description of the refund status.
(Two possible values:
Auto-Refund initiated successfully or
Auto-Refund processed successfully). | Auto-Refund initiated successfully | | created\_at | It represents the time of auto-refund creation. | 2022-02-28T12:54:25+05:30 | | processed\_at | It represents when the auto-refund was processed successfully. | 2022-02-28T13:04:27+05:30 | | refund\_reason | It represents the reason of initiation of Auto-refund.
(Possible values:
Credit was received for an incomplete payment.
Refunded to customer for Dispute.
Payment made directly to your VPA without order creation.
Multiple payments were performed against same order.
Payment details (amount, bank, etc.) do not match with created order or the payment was made after TTL.) | Multiple payments were performed against same order | | refund\_charge | It represents the charges for processing refund in INR. | 0 | | refund\_splits | It represents the refund split details. | \[] | | metadata | It represents the additional metadata. | null | | event\_time | It represents when the refund webhook was initiated. | 2022-02-28T13:04:28+05:30 | | type | It represents the webhook type. The value will always be AUTO\_REFUND\_STATUS\_WEBHOOK. | AUTO\_REFUND\_STATUS\_WEBHOOK | ## Dispute Webhooks Version: (2022-09-01) Dispute webhooks can be configured to receive automated notifications when disputes are created, updated and closed. The webhook notification will be sent on all the URLs added and enabled under the dispute webhook. Merchants can add new URLs and enable or disable existing URLs for refund webhook at any point in time and it will be reflected instantaneously. | Webhook | Description | | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DISPUTE\_CREATED | Dispute\_created webhook will be triggered when a new dispute is created. | | DISPUTE\_UPDATED | Dispute\_updated webhook will be triggered when a dispute is updated, for example when a comment is added by the Cashfree team, when the dispute moves into further stages like Pre-arbitration, Arbitration, or when the status of the dispute changes. | | DISPUTE\_CLOSED | This webhook will be triggered when a dispute is closed. | #### Dispute created **Sample Payload** ```{ theme={"dark"} "data": { "dispute": { "dispute_id": "433475258", "dispute_type": "DISPUTE", "reason_code": "1402", "reason_description": "Duplicate Processing", "dispute_amount": 3, "created_at": "2023-06-15T21:49:48+05:30", "updated_at": "2023-06-15T21:49:48+05:30", "respond_by": "2023-06-18T23:59:59+05:30", "dispute_status": "DISPUTE_CREATED", "cf_dispute_remarks": "Dispute is created, please take action", "dispute_action_on": "MERCHANT" }, "order_details": { "order_id": "order_1944392DR1kMTFYdIf8bI2awAcC3i9FTa", "order_amount": 3, "order_currency": "INR", "cf_payment_id": 885473311, "payment_amount": 3, "payment_currency": "INR" }, "customer_details": { "customer_name": "Dileep Kumar s", "customer_phone": "8000000000", "customer_email": "dileep@gmail.com" }, "terminal_details": { "cf_terminal_id": 989876, "terminal_phone": "9876543212" } }, "event_time": "2023-06-15T21: 50: 04+05: 30", "type": "DISPUTE_CREATED" } ``` #### Dispute updated **Sample Payload** ```{ theme={"dark"} "data": { "dispute": { "dispute_id": "433475257", "dispute_type": "PRE_ARBITRATION", "reason_code": "13.1", "reason_description": "Merchandise / Services Not Received", "dispute_amount": 40000, "created_at": "2023-06-15T21:16:03+05:30", "updated_at": "2023-06-15T21:19:15+05:30", "respond_by": "2023-06-19T23:59:59+05:30", "dispute_status": "PRE_ARBITRATION_CREATED", "cf_dispute_remarks": "Pre Arbitration request has been raised for this case.\\nTarget Date :: 2023-06-18T00:00 -> 2023-06-19T23:59:59.", "dispute_update": "TYPE_UPDATE", "dispute_action_on": "MERCHANT" }, "order_details": { "order_id": "order_1944392D4jHtCeVPPdTXkaUwg5cfnujQe", "order_amount": 40000, "order_currency": "INR", "cf_payment_id": 885457437, "payment_amount": 40000, "payment_currency": "INR" }, "customer_details": { "customer_name": "Dileep Kumar s", "customer_phone": "8000000000", "customer_email": "dileep@gmail.com" }, "terminal_details": { "cf_terminal_id": 989876, "terminal_phone": "9876543212" } }, "event_time": "2023-06-15T21:20:24+05:30", "type": "DISPUTE_UPDATED" } ``` #### Dispute closed **Sample Payload** ```{ theme={"dark"} "data": { "dispute": { "dispute_id": "433475257", "dispute_type": "CHARGEBACK", "reason_code": "4855", "reason_description": "Goods or Services Not Provided", "dispute_amount": 4500, "created_at": "2023-06-15T21:16:03+05:30", "updated_at": "2023-06-15T21:16:51+05:30", "respond_by": "2023-06-18T00:00:00+05:30", "resolved_at": "2023-06-15T21:16:51.682836678+05:30", "dispute_status": "CHARGEBACK_MERCHANT_WON", "cf_dispute_remarks": "Chargeback won by merchant" }, "order_details": { "order_id": "order_1944392D4jHtCeVPPdTXkaUwg5cfnujQe", "order_amount": 4500, "order_currency": "INR", "cf_payment_id": 885457437, "payment_amount": 4500, "payment_currency": "INR" }, "customer_details": { "customer_name": "Dileep Kumar s", "customer_phone": "8000000000", "customer_email": "dileep@gmail.com" }, "terminal_details": { "cf_terminal_id": 989876, "terminal_phone": "9876543212" } }, "event_time": "2023-06-15T21:17:14+05:30", "type": "DISPUTE_CLOSED" } ``` #### Payload field description | Field | Description | Example | Type | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | ------------- | | dispute\_id | Cashfree’s unique ID to identify a dispute. | 433475257 | Long | | dispute\_type | Type of dispute created. Possible values:
- DISPUTE
- RETRIEVAL
- CHARGEBACK
- PRE\_ARBITRATION
- ARBITRATION | Chargeback | String | | cf\_terminal\_id | Cashfree Payments Terminal ID of the payment for which refund is initiated. | 989876 | Long | | terminal\_phone | The phone number of the corresponding terminal. | 9876543212 | String | | reason\_code | Condition for which the customer is filing the case. Click [here](doc:dispute-reason-codes) to know more about dispute reason codes. | 13.6 | String | | reason\_description | Description of the reason code. Codes for Chargeback cases are specified by Card networks/NPCI. | Credit not processed | String | | dispute\_amount | The amount for which the dispute has been created. | 4500 | BigDecimal | | created\_at | Time on which the dispute was registered on Cashfree’s system. | 2023-06-15T21:16:03+05:30 | LocalDateTime | | updated\_at | Time on which the dispute was updated. | 2023-06-15T21:16:51+05:30 | LocalDateTime | | respond\_by | Time by which the merchant is expected to respond to the dispute. | 2023-06-18T00:00:00+05:30 | LocalDateTime | | dispute\_status | Status of Dispute. All possible values are listed in the table below. | CHARGEBACK\_CREATED | String | | cf\_dispute\_remarks | Any remarks specified by Cashfree on the dispute. | Please submit documents. | String | | dispute\_update | Specifies what has been updated on the dispute. Possible Values:
- STATUS\_UPDATE
- TYPE\_UPDATE
- COMMENT\_UPDATE | TYPE\_UPDATE | String | | dispute\_action\_on | Specifies whether the action is on Cashfree or Merchant at a time.
Possible Values:
- MERCHANT
- CASHFREE | MERCHANT | String | | resolved\_at | Time on which the dispute was resolved/closed. | 2023-06-15T21:16:51.682836678+05:30 | LocalDateTime | | event\_time | Time at which dispute webhook was initiated. | 2023-06-15T21:16:51+05:30 | LocalDateTime | | type | Type of webhook. Possible Values:
- DISPUTE\_CREATED
- DISPUTE\_UPDATED
- DISPUTE\_CLOSED | DISPUTE\_CREATED | String | # Delete Saved Card Instrument Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/delete-saved-card-instrument openapi/payments/v2022-09-01.yaml delete /customers/{customer_id}/instruments/{instrument_id} Use this API to delete a saved card instrument for a customer_id and instrument_id # Fetch All Saved Card Instrument Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/fetch-all-saved-card-instrument openapi/payments/v2022-09-01.yaml get /customers/{customer_id}/instruments Use this API to fetch saved cards for a customer_id # Fetch cryptogram for a saved card instrument Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/fetch-cryptogram-for-a-saved-card-instrument openapi/payments/v2022-09-01.yaml get /customers/{customer_id}/instruments/{instrument_id}/cryptogram Use this API To get the card network token, token expiry and cryptogram for a saved card instrument using instrument id # Fetch Specific Saved Card Instrument Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/fetch-specific-saved-card-instrument openapi/payments/v2022-09-01.yaml get /customers/{customer_id}/instruments/{instrument_id} Use this API to fetch a single specific saved card for a customer_id by it's instrument_id # Create Customer Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/customers/create openapi/payments/v2023-08-01.yaml post /customers Create Customer at Cashfree # Accept Dispute by Dispute ID Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/dispute-accept openapi/payments/v2023-08-01.yaml put /disputes/{dispute_id}/accept Use this API to get accept the Dispute by specifying the Dispute ID. # Submit Evidence to contest the Dispute by Dispute ID Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/dispute-submission openapi/payments/v2023-08-01.yaml post /disputes/{dispute_id}/documents Use this API to Submit the Evidences to contest the Dispute by specifying the Dispute ID. # Dispute Webhooks Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/dispute-webhooks Learn in detail about dispute webhooks. Dispute webhooks can be configured to receive automated notifications when disputes are created, updated and closed. The webhook notification will be sent on all the URLs added and enabled under the dispute webhook. Merchants can add new URLs and enable or disable existing URLs for refund webhook at any point in time and it will be reflected instantaneously. | Webhook | Description | | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DISPUTE\_CREATED | Dispute\_created webhook will be triggered when a new dispute is created. | | DISPUTE\_UPDATED | Dispute\_updated webhook will be triggered when a dispute is updated, for example when a comment is added by the Cashfree team, when the dispute moves into further stages like Pre-arbitration, Arbitration, or when the status of the dispute changes. | | DISPUTE\_CLOSED | This webhook will be triggered when a dispute is closed. | Click [here](/payments/online/webhooks/overview) to know how to configure webhooks. ## Dispute created **Sample Payload** ```json theme={"dark"} "{ "data": { "dispute": { "dispute_id": "433475258", "dispute_type": "DISPUTE", "reason_code": "1402", "reason_description": "Duplicate Processing", "dispute_amount": 3, "created_at": "2023-06-15T21:49:48+05:30", "updated_at": "2023-06-15T21:49:48+05:30", "respond_by": "2023-06-18T23:59:59+05:30", "dispute_status": ""DISPUTE_CREATED"", "cf_dispute_remarks": "Dispute is created, please take action", "dispute_action_on": "MERCHANT" }, "order_details": { "order_id": "order_1944392DR1kMTFYdIf8bI2awAcC3i9FTa", "order_amount": 3, "order_currency": "INR", "cf_payment_id": 885473311, "payment_amount": 3, "payment_currency": "INR" }, "customer_details": { "customer_name": "Dileep Kumar s", "customer_phone": "8000000000", "customer_email": "dileep@gmail.com" } }, "event_time": ""2023-06-15T21:50:04+05:30", "type": "DISPUTE_CREATED" }" ``` ## Dispute updated **Sample Payload** ```json theme={"dark"} "{ "data": { "dispute": { "dispute_id": "433475257", "dispute_type": "PRE_ARBITRATION", "reason_code": "13.1", "reason_description": "Merchandise / Services Not Received", "dispute_amount": 40000, "created_at": "2023-06-15T21:16:03+05:30", "updated_at": "2023-06-15T21:19:15+05:30", "respond_by": "2023-06-19T23:59:59+05:30", "dispute_status": "PRE_ARBITRATION_CREATED", "cf_dispute_remarks": "Pre Arbitration request has been raised for this case.\nTarget Date :: 2023-06-18T00:00 -> 2023-06-19T23:59:59.", "dispute_update": "TYPE_UPDATE", "dispute_action_on": "MERCHANT" }, "order_details": { "order_id": "order_1944392D4jHtCeVPPdTXkaUwg5cfnujQe", "order_amount": 40000, "order_currency": "INR", "cf_payment_id": 885457437, "payment_amount": 40000, "payment_currency": "INR" }, "customer_details": { "customer_name": "Dileep Kumar s", "customer_phone": "8000000000", "customer_email": "dileep@gmail.com" } }, "event_time": "2023-06-15T21:20:24+05:30", "type": "DISPUTE_UPDATED" }" ``` ## Dispute closed **Sample Payload** ```json theme={"dark"} "{ "data": { "dispute": { "dispute_id": "433475257", "dispute_type": "CHARGEBACK", "reason_code": "4855", "reason_description": "Goods or Services Not Provided", "dispute_amount": 4500, "created_at": "2023-06-15T21:16:03+05:30", "updated_at": "2023-06-15T21:16:51+05:30", "respond_by": "2023-06-18T00:00:00+05:30", "resolved_at": "2023-06-15T21:16:51.682836678+05:30", "dispute_status": "CHARGEBACK_MERCHANT_WON", "cf_dispute_remarks": "Chargeback won by merchant" }, "order_details": { "order_id": "order_1944392D4jHtCeVPPdTXkaUwg5cfnujQe", "order_amount": 4500, "order_currency": "INR", "cf_payment_id": 885457437, "payment_amount": 4500, "payment_currency": "INR" }, "customer_details": { "customer_name": "Dileep Kumar s", "customer_phone": "8000000000", "customer_email": "dileep@gmail.com" } }, "event_time": "2023-06-15T21:17:14+05:30", "type": "DISPUTE_CLOSED" }" ``` ## Payload field description | Field | Description | Example | Type | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------- | | dispute\_id | Cashfree’s unique ID to identify a dispute. | 433475257 | Long | | dispute\_type | Type of dispute created. Possible values:
- DISPUTE
- RETRIEVAL
- CHARGEBACK
- PRE\_ARBITRATION
- ARBITRATION | Chargeback | String | | reason\_code | Condition for which the customer is filing the case. Click [here]() to know more about dispute reason codes. | 13.6 | String | | reason\_description | Description of the reason code. Codes for Chargeback cases are specified by Card networks/NPCI. | Credit not processed | String | | dispute\_amount | The amount for which the dispute has been created. | 4500 | BigDecimal | | created\_at | Time on which the dispute was registered on Cashfree’s system. | 2023-06-15T21:16:03+05:30 | LocalDateTime | | updated\_at | Time on which the dispute was updated. | 2023-06-15T21:16:51+05:30 | LocalDateTime | | respond\_by | Time by which the merchant is expected to respond to the dispute. | 2023-06-18T00:00:00+05:30 | LocalDateTime | | dispute\_status | Status of Dispute. All possible values are listed in the table below. | CHARGEBACK\_CREATED | String | | cf\_dispute\_remarks | Any remarks specified by Cashfree on the dispute. | Please submit documents. | String | | dispute\_update | Specifies what has been updated on the dispute. Possible Values:
- STATUS\_UPDATE
- TYPE\_UPDATE
- COMMENT\_UPDATE | TYPE\_UPDATE | String | | dispute\_action\_on | Specifies whether the action is on Cashfree or Merchant at a time. Possible Values:
- MERCHANT
- CASHFREE | MERCHANT | String | | resolved\_at | Time on which the dispute was resolved/closed. | 2023-06-15T21:16:51.682836678+05:30 | LocalDateTime | | event\_time | Time at which dispute webhook was initiated. | 2023-06-15T21:16:51+05:30 | LocalDateTime | | type | Type of webhook. Possible Values:
- DISPUTE\_CREATED
- DISPUTE\_UPDATED
- DISPUTE\_CLOSED | DISPUTE\_CREATED | String | | List of Dispute Status | | :--------------------------------------- | | DISPUTE\_CREATED | | DISPUTE\_DOCS\_RECEIVED | | DISPUTE\_UNDER\_REVIEW | | DISPUTE\_MERCHANT\_WON | | DISPUTE\_MERCHANT\_LOST | | DISPUTE\_MERCHANT\_ACCEPTED | | DISPUTE\_INSUFFICIENT\_EVIDENCE | | RETRIEVAL\_CREATED | | RETRIEVAL\_DOCS\_RECEIVED | | RETRIEVAL\_UNDER\_REVIEW | | RETRIEVAL\_MERCHANT\_WON | | RETRIEVAL\_MERCHANT\_LOST | | RETRIEVAL\_MERCHANT\_ACCEPTED | | RETRIEVAL\_INSUFFICIENT\_EVIDENCE | | CHARGEBACK\_CREATED | | CHARGEBACK\_DOCS\_RECEIVED | | CHARGEBACK\_UNDER\_REVIEW | | CHARGEBACK\_MERCHANT\_WON | | CHARGEBACK\_MERCHANT\_LOST | | CHARGEBACK\_MERCHANT\_ACCEPTED | | CHARGEBACK\_INSUFFICIENT\_EVIDENCE | | PRE\_ARBITRATION\_CREATED | | PRE\_ARBITRATION\_DOCS\_RECEIVED | | PRE\_ARBITRATION\_UNDER\_REVIEW | | PRE\_ARBITRATION\_MERCHANT\_WON | | PRE\_ARBITRATION\_MERCHANT\_LOST | | PRE\_ARBITRATION\_MERCHANT\_ACCEPTED | | PRE\_ARBITRATION\_INSUFFICIENT\_EVIDENCE | | ARBITRATION\_CREATED | | ARBITRATION\_DOCS\_RECEIVED | | ARBITRATION\_UNDER\_REVIEW | | ARBITRATION\_MERCHANT\_WON | | ARBITRATION\_MERCHANT\_LOST | | ARBITRATION\_MERCHANT\_ACCEPTED | | ARBITRATION\_INSUFFICIENT\_EVIDENCE | ## Compute Signature and Verify The signature must be used to verify if the request has not been tampered with. To verify the signature at your end, you will need your Cashfree PG secret key along with the payload. Timestamp is present in the header x-webhook-timestamp ````bash theme={"dark"} timestamp := 1617695238078; signedPayload := $timestamp.$payload; expectedSignature := Base64Encode(HMACSHA256($signedPayload, $merchantSecretKey));``` ```` ## Sample code ### Verify Signature using SDK
* [Upload Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/upload-payment-verification-details) - Use this to submit verification details * [Get Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/get-payment-verification-details) - Use this to fetch payment verification details # Webhooks Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/import-webhooks This product helps Merchants/Payment Aggregators/Market Places who are based outside India to collect payments from customers based out of India Webhooks are server callbacks to your server from Cashfree Payments. Webhooks are event-based and are sent when specific events related to the transaction happen. Click [here](/payments/online/webhooks/configure) to know how to configure webhooks.
```json Json theme={"dark"} { "data": { "adjustment_amount_inr": -347641.22, "collection_amount_inr": 604854.0, "initiated_on": null, "payment_from": "2024-09-26T15:43:55", "payment_till": "2024-09-26T16:43:13", "service_charge_inr": null, "service_tax_inr": 2068.59, "settled_on": null, "settlement_amount_inr": 243651.95, "settlement_charges_inr": 0.0, "settlement_foreign_currency_details": { "settlement_amount_fcy": null, "settlement_currency": "USD", "settlement_forex_rate": null }, "settlement_id": 12, "settlement_tax_inr": 0.0, "settlement_utr": null, "status": "NOT_INITIATED" }, "event_time": "2024-10-03T13:27:36+05:30", "type": "ICA_SETTLEMENT_UPDATE" } ```
Landing page to add the webhook URL and subscribe the events
The previous versions were 2021-05-21, 2022-01-01, 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/previous/v2023-08-01/orders/create) | Use this API to create orders with Cashfree from your backend and get the payment link. | | [Order Pay](/api-reference/payments/previous/v2023-08-01/payments/pay) | Use this API when you have already created the orders and want Cashfree Payments to process the payment. | | [Preauthorization](/api-reference/payments/previous/v2023-08-01/payments/authorize) | Use this API to capture or void a preauthorized payment. | | [Get Order](/api-reference/payments/previous/v2023-08-01/orders/get) | Use this API to view all details of an order. | *** ### Authentication | API | Description | | :----------------------------------------------------------------------------------------- | :-------------------------------------------------------- | | [Submit or Resend OTP](/api-reference/payments/previous/v2023-08-01/payments/authenticate) | Use the submit or resend OTP API to send OTP to Cashfree. | *** ### Payments | API | Description | | :-------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- | | [Get Payments for an Order](/api-reference/payments/previous/v2023-08-01/payments/get-payments-for-order) | Use this API to view all payment details for an order. | | [Get Payment by ID](/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/operations/settlements-for-order) | Use this API to view all the settlements of a particular order. | | [Get All Settlements](/api-reference/payments/previous/v2023-08-01/operations/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/previous/v2023-08-01/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/previous/v2023-08-01/payment-links/get-orders-for-link) | Use this API to view all details and status of a payment link. | | [Get Orders for a Payment Link](/api-reference/payments/previous/v2023-08-01/payment-links/get) | Use this API to view all order details for a payment link. | | [Cancel Payment Link](/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/token-vault/get-all) | Use this API to get all saved instruments for a customer ID. | | [Fetch Single Saved Instrument](/api-reference/payments/previous/v2023-08-01/token-vault/get) | Use this API to get specific saved instrument for a customer id and instrument ID. | | [Delete Saved Instrument](/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/operations/settlement-reconciliation) | Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. | | [PG Reconciliation](/api-reference/payments/previous/v2023-08-01/operations/reconcile) | Use this API to get the payment gateway reconciliation details with date range. | # Create Pre-Activated Vpas for partner Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/partners/create-pre-activated-vpas-for-partner openapi/payments/v2023-08-01.yaml post /partners/merchant/qrcodes Use this API to create a pre-activated vpa for partner. # Get Pre-Activated Vpas for partner Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/partners/get-pre-activated-vpas-for-partner openapi/payments/v2023-08-01.yaml get /partners/merchant/qrcodes Use this API to get a pre-activated vpa for partner. # Cancel Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/cancel openapi/payments/v2023-08-01.yaml post /links/{link_id}/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. # Create Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/create openapi/payments/v2023-08-01.yaml post /links Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url. # Get Orders for a Payment Link Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/get openapi/payments/v2023-08-01.yaml get /links/{link_id}/orders Use this API to view all order details for a payment link. # Fetch Payment Link Details Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/get-orders-for-link openapi/payments/v2023-08-01.yaml get /links/{link_id} Use this API to view all details and status of a payment link. # Payment Link Webhooks Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/webhooks Learn about webhooks triggered when payments made through Payment Links. ## Webhook Schema Payment Link webhook will be triggered when your customer makes a complete or partial payment using the payment link you shared. You will also be notified via the same webhook when the payment link gets cancelled or expired. ```json theme={"dark"} { "data": { "cf_link_id": 1576977, "link_id": "payment_ps11", "link_status": "PARTIALLY_PAID", "link_currency": "INR", "link_amount": "200.12", "link_amount_paid": "55.00", "link_partial_payments": true, "link_minimum_partial_amount": "11.00", "link_purpose": "Payment for order 10", "link_created_at": "2021-08-18T07:13:41", "customer_details": { "customer_phone": "9000000000", "customer_email": "john@gmail.com", "customer_name": "John " }, "link_meta": { "notify_url": "https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net" }, "link_url": "https://payments-test.cashfree.com/links//U1mgll3c0e9g", "link_expiry_time": "2021-11-28T21:46:20", "link_notes": { "note_key_1": "note_value_1" }, "link_auto_reminders": true, "link_notify": { "send_sms": true, "send_email": true }, "order": { "order_amount": "22.00", "order_id": "CFPay_U1mgll3c0e9g_ehdcjjbtckf", "order_expiry_time": "2021-08-18T07:34:50", "order_hash": "Gb2gC7z0tILhGbZUIeds", "transaction_id": 1021206, "transaction_status": "SUCCESS" } }, "type": "PAYMENT_LINK_EVENT", "version": 1, "event_time": "2021-08-18T12:55:06+05:30" } ``` *** ## Payload | Field | Description | Example | | :---------------------------- | :------------------------------------------------------------------------------------------------ | :----------------------------------------------------------- | | `cf_link_id` | Unique Identifier (generated by Cashfree) for this Link. | 1543566 | | `link_id` | Unique Identifier (provided by merchant) for the Link. Only for merchant reference. | payment\_1psw | | `link_status` | Current status of the payment link. Possible values: PAID, PARTIALLY\_PAID, EXPIRED, CANCELLED. | PARTIALLY\_PAID | | `link_currency` | Default is INR. International currencies are supported. | INR | | `link_amount` | The amount which merchant wants to collect for the order. | 500.00 | | `link_amount_paid` | The amount paid by the customer. | 250.00 | | `link_partial_payments` | Indicates if partial payments are allowed or not. Default value is false. | true | | `link_minimum_partial_amount` | The minimum amount which must be paid by customer as the first payment. | 200.00 | | `link_purpose` | A brief description for which payment must be collected. This is shown to the customer. | Payment for order 10 | | `link_created_at` | Time at which the link was created. | 2021-08-18T07:13:41 | | `customer_details` | Customer object, it contains customer details. | | | `customer_name` | Name of the customer | John | | `customer_phone` | Phone number of the customer | 9000000000 | | `customer_email` | Email ID of the customer | [john@gmail.com](mailto:john@gmail.com) | | `notify_url` | Payment notification URL | [https://payment1notify.net](https://payment1notify.net) | | `link_url` | Payment link URL | [https://website.com/payments](https://website.com/payments) | | `link_expiry_time` | The date till which the link will be valid, and then it will be expired. Default is 30 days. | 2021-11-28T21:46:20 | | `link_notes` | Link notes object where you can provide any key-value pairs for your internal reference. | | | `note_key_1` | | note\_value\_1 | | `link_auto_reminders` | Default is false. Reminders will be sent to customers based on defined settings. | true | | `link_notify` | Link notify object, used to notify customers via SMS or an email. | | | `send_sms` | Default is true. If true, Cashfree will send the link to customer via SMS. | true | | `send_email` | Default is true. If true and `customer_email` is provided, Cashfree will send the link via Email. | true | | `order` | Order object, contains the order details. Will be null for cancelled and expired link statuses. | | | `order_amount` | Order amount that the customer must pay. | 700 | | `order_id` | The order ID generated. | order\_10 | | `order_expiry_time` | The date till which the order will be valid. Default is 30 days. | 2021-08-18T07:34:50 | | `transaction_id` | Transaction ID | id45466ye | | `transaction_status` | Status of the transaction. Possible values: SUCCESS. | SUCCESS | | `type` | Type of the webhook. `PAYMENT_LINK_EVENT` | PAYMENT\_LINK\_EVENT | | `version` | The version of webhook. Build parsing logic with respect to this version. | 1 | | `event_time` | Time when this webhook was created. | 2021-08-18T12:55:06+05:30 | *** ## Signature generation The signature must be used to verify if the request has not been tampered with. To verify the signature at your end, you will need your Cashfree Payment Gateway secret key along with the payload. ```javascript theme={"dark"} // The payload here refers to the raw request sent by // Cashfree to your endpoint. No modifications need to be made to this payload. { "data": { "cf_link_id": 1576977, "link_id": "payment_ps11", "link_status": "PARTIALLY_PAID", "link_currency": "INR", "link_amount": "200.12", "link_amount_paid": "55.00", "link_partial_payments": true, "link_minimum_partial_amount": "11.00", "link_purpose": "Hello my friend how are you", "link_created_at": "2021-08-18T07:13:41", "customer_details": { "customer_phone": "9905736722", "customer_email": "supal.dubey@cashfree.com", "customer_name": "Supal " }, "link_meta": { ... } } } ```
**You can perform the following tasks using Easy Split:**
* Add and manage all your vendors efficiently
* Split payments and settle them into multiple vendor accounts using the available schedule options cycles
* Check on-demand vendor balance and settle the money into the vendor accounts instantly
* Vendor reconciliation
The table below provides the list of Easy Split APIs along with their description:
**Vendor APIs**
| API Name | Description |
| :------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------ |
| [Create Vendor](/api-reference/payments/previous/v2023-08-01/split/vendors/create) | Create Vendor API creates a new vendor in your Easy Split account. |
| [Update Vendor Details](/api-reference/payments/previous/v2023-08-01/split/vendors/update) | Update Vendor Details API updates the existing vendor details. |
| [Get Specific Vendor Details](/api-reference/payments/previous/v2023-08-01/split/vendors/download-documents) | Get Specific Vendor Details API gets the details of a specific vendor. |
| [Get All Vendor Details](/api-reference/payments/previous/v2023-08-01/split/vendors/get) | Get All Vendor Details API gets the details of all the vendors associated with that Easy Split account. |
| [Transfer Vendor Balance](/api-reference/payments/previous/v2023-08-01/split/configuration/create-adjustment) | Transfer Vendor Balance API adjusts the vendor balances. |
| [Create Refund](/api-reference/payments/previous/v2023-08-01/refunds/create) | Create Refund API creates a new refund. |
**Split Order APIs**
| API Name | Description |
| :-------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
| [Split at Order Level](/api-reference/payments/previous/v2023-08-01/split/configuration/create-adjustment) | Use this API to create a split at order level. |
| [Split After Payment](/api-reference/payments/previous/v2023-08-01/split/configuration/split-after-payment) | Split After Payment API created a split after the payment is completed. |
| [Get Split and Settlement Details by OrderId](/api-reference/payments/previous/v2023-08-01/split/settlements/split-details) | Get Split and Settlement Details by OrderId API gets details of the split, settled and unsettled transactions of each vendor using the OrderID. |
**Settlement APIs**
| API Name | Description |
| :------------------------------------------------- | :------------------------------------------------------------------------------------------------------------ |
| [Get Settlement Cycle Details]() | Get Settlement Cycle Details API gets the schedule option details. |
| [Get All Vendor Settlement Details]() | Get All Vendor Settlement Details API gets all the vendor settlement details. |
| [Get Vendor Settlement Details by Settlement ID]() | Get Vendor Settlement Details by Settlement ID API gets the Vendor Settlement of each vendor by SettlementID. |
**On Demand Settlement APIs**
| API Name | Description |
| :---------------------------------- | :----------------------------------------------------------------------------------------- |
| [Get On Demand Vendor Balance]() | Get On Demand Vendor Balance API gets the on-demand vendor balance. |
| [Settle On Demand Vendor Balance]() | Settle On Demand Vendor Balance API settles the balance to a vendor on-demand immediately. |
| [Get On Demand Settlement Status]() | Get On Demand Settlement Status API gets the on-demand settlement status. |
**Deferred Settlement APIs**
| API Name | Description |
| :---------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- |
| [Set Vendor Settlement Eligibility Date for Orders]() | Set Vendor Settlement Eligibility Date for Orders API assigns a settlement eligibility date for an order and vendor combination. |
**Reconciliation APIs**
| API Name | Description |
| :----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
| [View Split Order Details Using Settlement ID]() | View Split Order Details Using Settlement ID API gets the details of the split order processed in a settlement using Settlement ID. |
| [Vendor Recon for a Time Period]() | Vendor Recon for a Time Period API gets the on demand settlement status by providing the on-demand request ID. |
| [Vendor Recon Using Vendor ID & Time Interval]() | Vendor Recon Using Vendor ID & Time Interval API gets the details of all events for a specific vendor within an interval. |
# Easy Split - Postman Collection
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/easy-split-postman-collection
Get started quickly with Cashfree's Easy Split APIs by downloading the collection and importing it in Postman.
Download Cashfree Easy Split Postman Collection
Watch the video below to learn how to setup API
# End Points
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/end-points
Cashfree uses API keys to allow access to the API. Once you have signed up at our merchant site, you can see your AppId and SecretKey.
Cashfree expects the API key to be included in all API requests to the server. Use the endpoint /api/v1/credentials/verify to verify your credentials.
| Environment | Base URL |
| :---------- | :------------------------------------------------------- |
| Production | [https://api.cashfree.com/](https://api.cashfree.com/) |
| Test | [https://test.cashfree.com/](https://test.cashfree.com/) |
**Auto Collect End Points**
For Auto Collect pass the Authorization token. Use the [Authorize API](/api-reference/payouts/v1/authorize#authorize) to generate the token for Auto Collect APIs.
| Environment | Base URL |
| :---------- | :------------------------------------------------------------- |
| Production | [https://api.cashfree.com/](https://api.cashfree.com/) |
| Test | [https://sandbox.cashfree.com/](https://sandbox.cashfree.com/) |
# Vendor Reconciliation API
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/reconciliation/vendor-recon
openapi/payments/v2023-08-01.yaml post /recon/vendor
This API allows users to fetch vendor reconciliation details using different filters. Use the appropriate filters based on your requirements.
- **View Split Order Details Using Settlement ID**: Retrieve details of split orders within a settlement by Settlement ID.
- **Vendor Recon for a Time Period**: Fetch reconciliation details for all vendors within a specific time interval.
- **Vendor Recon Using Vendor ID & Time Interval**: Get reconciliation details for a specific vendor within a given time interval.
# Get Split and Settlement Details by OrderID v2.0
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/settlements/get-split-and-settlement-details
openapi/payments/v2023-08-01.yaml post /split/order/vendor/recon
Use this API to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date.
# Create On Demand Balance Transfer
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/settlements/on-demand-transfer
openapi/payments/v2023-08-01.yaml post /easy-split/vendors/{vendor_id}/transfer
The Create On Demand Transfer API will create a new on-demand request either from the merchant ledger or from the vendor ledger to the vendor bank account.
# Settlements Overview
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/settlements/overview
This section comprises of the settlement APIs.
Once you have created an order and your customer pays for the order, the amount is received by Cashfree Payments and processes the settlement into your bank account.
With the settlement APIs, you can fetch the settlement details by providing the Order ID.
Apart from this, you can settle the payments instantly using the On-demand settlements option. This option allows you to receive the unsettled amount to your bank account instantly 24x7 including holidays.
#### Settlement APIs
| API Name | Description |
| :-------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------- |
| [Create On Demand Balance Transfer](/api-reference/payments/previous/v2023-08-01/split/settlements/on-demand-transfer) | Create a new on-demand request either from the merchant ledger or from the vendor ledger to the vendor bank account. |
| [Get Split and Settlement Details by OrderID](/api-reference/payments/previous/v2023-08-01/split/settlements/split-details) | Get all the split details, settled and unsettled transactions details of each vendor. |
| [Get Split and Settlement Details by OrderID v2.0](/api-reference/payments/previous/v2023-08-01/split/settlements/get-split-and-settlement-details) | Get all the split details, settled and unsettled transactions details of each vendor. |
# Get Split and Settlement Details by OrderID
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/settlements/split-details
openapi/payments/v2023-08-01.yaml get /easy-split/orders/{order_id}
Use this API to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date.
# Upload Vendor Docs
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/add-document
openapi/payments/v2023-08-01.yaml post /easy-split/vendor-docs/{vendor_id}
Use this API to upload KYC documents of a specific vendor.
# Create vendor
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/create
openapi/payments/v2023-08-01.yaml post /easy-split/vendors
Use this API to create a new vendor to your EasySplit account along with the KYC details. Provide KYC details such as account_type, business_type, gst, cin, pan, passport number and so on.
# Download Vendor Documents
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/download-documents
openapi/payments/v2023-08-01.yaml get /easy-split/vendor-docs/{vendor_id}/download/{doc_type}
Use this API to download the uploaded KYC documents of that particular vendor. Provide the document type. Click the link from the sample request to download the KYC document.
# Get Vendor All Details
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/get
openapi/payments/v2023-08-01.yaml get /easy-split/vendors/{vendor_id}
Use this API to get the details of a specific vendor associated with your Easy Split account.
# Get Vendor All Documents Status
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/get-document
openapi/payments/v2023-08-01.yaml get /easy-split/vendor-docs/{vendor_id}
Use this API to fetch the details of all the KYC details of a particular vendor.
# Get On Demand Balance
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/get-on-demand-balance
openapi/payments/v2023-08-01.yaml get /easy-split/vendors/{vendor_id}/balances
This API fetches the available amount with the merchant, vendor, and the unsettled amount for the merchant as well as the vendor.
# Overview
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/overview
This section consists of the new set of Vendor KYC APIs. Use these APIs to perform actions such as creating a vendor, updating vendor details, get vendor details, upload vendor KYC documents, get all vendor documents and so on.
**Vendors 2.0 APIs**
| API Name | Description |
| :-------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- |
| [Create Vendor v2.0](/api-reference/payments/latest/split/vendors/create) | This API creates a new vendor in Cashfree Payments system. |
| [Update Vendor Details v2.0](/api-reference/payments/latest/split/vendors/update) | This API updates the existing vendor details such as name, email, phone number, UPI details, and any of the KYC details. |
| [Get Vendor All Details](/api-reference/payments/latest/split/vendors/get) | This API fetches all the details of a specific vendor by sharing the vendor ID. |
| [Upload Vendor Docs](/api-reference/payments/latest/split/vendors/add-document) | This API uploads the vendor KYC docs. |
| [Get Vendor All Document Status](/api-reference/payments/latest/split/vendors/get-document) | This API fetches the submitted vendor KYC document status. |
| [Get Vendor Document Download URL](/api-reference/payments/latest/split/vendors/download-documents) | This API downloads the uploaded KYC documents. Provide the vendor ID and the document type. |
# Update vendor Details
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/update
openapi/payments/v2023-08-01.yaml patch /easy-split/vendors/{vendor_id}
Use this API to edit the existing vendor details added to your EasySplit account. You can edit vendor details such as name, email, phone number, upi details, and any of the KYC details.
# Overview
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/webhooks/overview
This section consists of the Easy Split Webhooks.
Webhooks are server callbacks to your server from Cashfree Payments. Webhooks are event-based and are sent when specific events happen.
The table below lists the various webhook events:
| Webhook Name | Description |
| :------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Vendor Settlement Webhook](/api-reference/payments/previous/v2023-08-01/split/webhooks/vendor-settlement-webhooks) | Configure vendor settlement webhooks to receive automated notifications when vendor settlements are initiated, successfully processed, failed, or reversed. |
| [Vendor Status Change Webhook](/api-reference/payments/previous/v2023-08-01/split/webhooks/vendor-status-change-webhooks) | Configure vendor status change webhooks to receive automated notifications when vendor status is changed. |
# Vendor Settlement Webhook
Source: https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/webhooks/vendor-settlement-webhooks
This chapter explains the vendor settlement webhooks.
Configure vendor settlement webhooks to receive automated notifications when vendor settlements are initiated, successfully processed, failed, or reversed.
The webhook notifications are sent on all the URLs added and enabled in the settlement webhook. You can add new URLs and enable or disable existing URLs for settlement webhook at any time and it will reflect instantaneously.
The table below lists the webhook events available for settlements.
| Webhook Event | Description |
| :---------------------------- | :------------------------------------------------------------------------- |
| VENDOR\_SETTLEMENT\_INITIATED | This webhook will be triggered when a vendor settlement is initiated. |
| VENDOR\_SETTLEMENT\_SUCCESS | This webhook will be triggered when a vendor settlement is successful. |
| VENDOR\_SETTLEMENT\_FAILED | This webhook will be triggered when a vendor settlement has failed. |
| VENDOR\_SETTLEMENT\_REVERSED | This webhook will be triggered when a vendor settlement has been reversed. |
***
### Vendor settlement initiated
SETTLEMENT\_INITIATED webhook is triggered when a settlement has been initiated by Cashfree Payments.
```json theme={"dark"}
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "CREATED",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settled_on": "null",
"reason": null,
"adjustment": 100.0,
"settlement_amount": 600.0,
"service_charge": 0.5,
"service_tax": 0.09,
"amount_settled": null,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"settlement_type": null,
"remarks": null,
"settlement_charge": null,
"settlement_tax": null
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_INITIATED"
}
```
### Vendor settlement success
```json theme={"dark"}
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "SUCCESS",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settled_on": "2023-06-08T15:10:37+05:30",
"reason": null,
"adjustment": 100.0,
"settlement_amount": 600.0,
"service_charge": 0.5,
"service_tax": 0.09,
"amount_settled": 600.0,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"settlement_type": null,
"remarks": null,
"settlement_charge": null,
"settlement_tax": null
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_SUCCESS"
}
```
***
### Vendor settlement failed
```json theme={"dark"}
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "FAILED",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settled_on": "null",
"reason": null,
"adjustment": 100.0,
"settlement_amount": 600.0,
"service_charge": 0.5,
"service_tax": 0.09,
"amount_settled": null,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"settlement_type": null,
"remarks": null,
"settlement_charge": null,
"settlement_tax": null
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_FAILED"
}
```
***
### Vendor settlement reversed
```json theme={"dark"}
{
"data": {
"settlement": {
"settlement_id": 49703,
"status": "REVERSED",
"utr": "1686217237243457",
"payment_amount": null,
"settlement_initiated_on": "2023-06-08T15:10:35+05:30",
"settled_on": "null",
"reason": Failed from bank end,
"adjustment": 100.00,
"settlement_amount": 600.00,
"service_charge": 0.50,
"service_tax": 0.09,
"amount_settled": null,
"payment_from": "2023-06-08",
"payment_till": "2023-06-08",
"settlement_type": null,
"remarks": null,
"settlement_charge": null,
"settlement_tax": null
}
},
"event_time": "2023-06-08T15:10:37+05:30",
"type": "VENDOR_SETTLEMENT_REVERSED"
}
```
***
### Payload field description
| Field | Description | Example |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- |
| adjustment | The sum of refunds, disputes, and chargeback part of this settlement is displayed here. | 0 |
| amount\_settled | The total amount that is settled in this schedule option. | 50 |
| payment\_amount | Total transaction amount considered for settlement. | 100 |
| payment\_from | Start date from which the payments are considered for settlement. | 2022-03-15 |
| payment\_till | End date till which the payments are considered for settlement. | 2022-03-23 |
| reason | Reason for failed and reversed settlements. Click [here](/payments/split/webhooks#settlement-webhook) to know more. | Transfer mode is not valid for beneficiary. |
| service\_charge | Service charges are applicable for the payments that are included in this settlement. | 2 |
| service\_tax | Service tax is applicable for the payments that are included in this settlement. | 0.50 |
| settled\_on | Date and time at which the settlement was processed. | 2022-03-17T14:21:18+05:30 |
| settlement\_amount | The sum of net settlement amount for the payments part of this settlement. | 13 |
| settlement\_id | Cashfree settlement ID | 1155353 |
| settlement\_initiated\_on | The date on which settlement was initiated. | 2022-03-17T14:29:21+05:30 |
| status | Status of the settlement (either INITIATED, SUCCESS, FAILED, or REVERSED) | SUCCESS |
| utr | The unique transaction reference number is given by the bank for the settlement. | N076221079016329 |
| vendor\_id | Reference ID as shared by you when onboarding the vendor. | IS\_1hour\_Upi |
| vendor\_transaction\_amount | Transaction amount split of vendor | 50 |
| event\_time | Time at which settlement webhook was initiated. | 2022-03-17T14:29:23+05:30 |
| type | Type of webhook - VENDOR\_SETTLEMENT\_INITIATED, VENDOR\_SETTLEMENT\_SUCCESS, VENDOR\_SETTLEMENT\_FAILED, or VENDOR\_SETTLEMENT\_REVERSED. | VENDOR\_SETTLEMENT\_SUCCESS |
### Reasons for failed and reversed settlements
| Reason | Category | Description |
| :----------------------------------- | :------- | :--------------------------------------------------- |
| BANK\_GATEWAY\_ERROR | Bank | Technical error at the bank |
| BENE\_BANK\_DECLINED | Bank | Rejected by Beneficiary bank due to business reasons |
| FAILED | Bank | No explicit failure reason from the bank |
| INVALID\_IFSC\_FAIL | Customer | Invalid ifsc code provided for bank account |
| INVALID\_ACCOUNT\_FAIL | Customer | Bank account is invalid |
| RETURNED\_FROM\_BENEFICIARY | Bank | Immediate reversal from the beneficiary bank |
| INSUFFICIENT\_BALANCE | Vendor | Your balance is exhausted, need to add funds |
| IMPS\_MODE\_FAIL | Bank | IMPS mode not supported for the beneficiary |
| RTGS\_MODE\_FAIL | Bank | RTGS mode not supported (only for RTGS) |
| REINITIALIZE\_TRANSFER\_LATER | Bank | Technical error at the bank, retry later |
| NRE\_ACCOUNT\_FAIL | Customer | Customer bank account is an NRE account |
| ACCOUNT\_BLOCKED | Customer | Customer bank account is blocked |
| DEST\_LIMIT\_REACHED | Bank | Transfer limit to beneficiary exceeded |
| INVALID\_MODE\_FAIL | Bank | Transfer mode not valid for beneficiary |
| NPCI\_UNAVAILABLE | Bank | NPCI in unavailable |
| BENEFICIARY\_BANK\_OFFLINE | Bank | Beneficiary bank is offline |
| INVALID\_AMOUNT\_FAIL | Vendor | Amount is invalid for the given transfer mode |
| SUSPECTED\_TRANSFER | Customer | Suspicious transfer identified |
| BENE\_NAME\_DIFFERS | Customer | Beneficiary name not matching with bank records |
| DISABLED\_MODE | Vendor | Transfer mode not enabled for the account |
| AMAZON\_AMOUNT\_EXCEED | Vendor | Amount should be less than 10000 for Amazon Pay mode |
| BENEFICIARY\_BLACKLISTED | Vendor | Beneficiary is blacklisted |
| PAYOUT\_INACTIVE | Vendor | Payout account is not active |
| INVALID\_TRANSFER\_AMOUNT | Vendor | Transfer amount is invalid |
| BENEFICIARY\_NOT\_EXIST | Vendor | Beneficiary does not exist |
| BENEFICIARY\_INVALID\_MODE | Vendor | Mode Not valid for Beneficiary |
| INVALID\_BENE\_ACCOUNT\_OR\_IFSC | Vendor | Invalid bank account number or ifsc provided |
| BENEFICIARY\_NAME\_DIFFERS | Customer | Beneficiary name not matching with bank records |
| ANY\_OTHER\_REASON | Bank | No reason provided for the failure/reversal |
| INVALID\_OR\_NO\_SUCH\_ACCOUNT\_TYPE | Customer | Invalid account |
***
### Signature verification
The signature must be used to verify if the request has not been tampered with. To verify the signature at your end, you will need your Cashfree PG secret key along with the payload.
timestamp is present in the header x-webhook-timestamp\
Actual signature is present in the header x-webhook-signature
```json theme={"dark"}
"headers": {
"host": "gamma.cashfree.com",
"x-request-id": "ad4dc1e65f8901302455b247237a667a",
"x-real-ip": "172.0.57.13",
"x-forwarded-for": "172.0.57.13",
"x-forwarded-host": "gamma.cashfree.com",
"x-forwarded-port": "80",
"x-forwarded-proto": "http",
"x-forwarded-scheme": "http",
"x-scheme": "http",
"x-original-forwarded-for": "52.66.25.127",
"content-length": "592",
"accept": "_/_",
"content-type": "application/json",
"user-agent": "ReactorNetty/1.0.30",
"x-datadog-parent-id": "4281924148563621550",
"x-datadog-sampling-priority": "1",
"x-datadog-trace-id": "228569355002181270",
"x-webhook-signature": "Xm0YzEJCRsh0XvIEK12D4FqpmC60cReKoqPBn424kV0=",
"x-webhook-timestamp": "1686217237543",
"x-webhook-version": "2022-09-01"
}
```
*Rate Limits page showing all APIs with current limits*
3. Select **Request new limit** for the API you want to change the limit for.
*Request form for increasing rate or burst limits*
4. Enter the new rate or burst limit you require. For burst limit, enter the time duration.
### Generate signature
To generate a signature, you need to generate the public key. You then use the generated public key to generate the signature.
#### Generating a public key
1. From the *Payouts* dashboard, click **Developers** > **Two-Factor Authentication**.
2. Select **Public Key** from the *Select 2FA Method* drop-down.
3. Click **Generate Public Key**.
4. The public key is downloaded to your computer. Use your registered email ID to access the key.
#### Generating a signature
Below are the steps to generate your signature:
1. Retrieve your clientId (one which you are passing through the header X-Client-Id )
2. Append this with CURRENT UNIX timestamp separated by a period (.)
3. Encrypt this data using RSA encrypt with Public key you received – this is the signature.
4. Pass this signature through the header X-Cf-Signature.
In the case of using our library, go through the libraries section. During the initialization process, you need to pass the key as a parameter.
Fund transfer operations
Standard Transfer V2Initiate single fund transfers to bank accounts, UPI, or cards with instant status updates.
Batch Transfer V2Automate large-scale disbursals using a single API request for multiple beneficiaries.
Get Transfer Status V2Track and retrieve detailed status, failure reasons, and reconciliation data for transfers.
Beneficiary management
Create Beneficiary V2Add and verify new beneficiaries securely before you initiate payouts.
Get Beneficiary V2Retrieve beneficiary details and transaction history for reconciliation.
Remove Beneficiary V2Securely delete beneficiary records when they are no longer needed.
Alternative payout methods
CashgramGenerate one-time payout links to allow users to claim funds through their preferred mode such as UPI or bank transfer.
Card PayoutsSend money directly to debit and credit cards for instant fund access.
Business solutions
One EscrowManage escrow accounts and automate settlements across buyers, sellers, and partners.
Real-time updates
Webhooks V2Receive real-time notifications on payout success, failure, or reversal events.
* Production/Live: [https://payout-api.cashfree.com/payout/v1/authorize](https://payout-api.cashfree.com/payout/v1/authorize) * Sandbox/Test: [https://payout-gamma.cashfree.com/payout/v1/authorize](https://payout-gamma.cashfree.com/payout/v1/authorize)
Below are the steps to generate your signature:
1. Retrieve your clientId (one which you are passing through the header X-Client-Id )
2. Append this with CURRENT UNIX timestamp separated by a period (.)
3. Encrypt this data using RSA encrypt with Public key you received - this is the signature.
4. Pass this signature through the header X-Cf-Signature.
In the case of using our library, go through the libraries section. During the initialization process, you need to pass the key as a parameter.
Learn how each API functions using the following table and use the best-suited API for your transactions.
| | [Transfer Sync](/api-reference/payouts/v1/standard-transfer-sync-v12) | [Transfer Async](/api-reference/payouts/v1/standard-transfer-async-v12) | [Direct Transfer](/api-reference/payouts/v1/direct-transfer-v12) | [Batch Transfer](/api-reference/payouts/v1/batch-transfer-v12) |
| ------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| **Functionality** | Initiate an amount transfer request | Initiate an amount transfer request | Initiate an amount transfer request directly to the beneficiary not added in your Payouts account (add beneficiary details in the API request) | Initiate amount transfer request to multiple beneficiaries |
| **Sync / Async** | Sync | Async | Async | Async |
| **UTR / Cashfree Reference ID** | Both UTR and Cashfree Reference ID | Cashfree Reference ID | Cashfree Reference ID | Cashfree Reference ID |
| **Required Body Params** | beneId \namount \ntransferId | beneId \namount \ntransferId | amount \ntransferId \ntransferMode \nbeneDetails | batchTransferId \nbatchFormat |
| **Default Transfer Mode** | Bank Transfer | Bank Transfer | Not Applicable | Not Applicable |
| **Available Transfer Modes** | Bank, UPI, Paytm, Amazon Pay | Bank, UPI, Paytm, Amazon Pay, Card | Bank, UPI, Paytm, Amazon Pay, Card, IMPS, NEFT | Bank, UPI, Paytm, Amazon Pay |
| **Response Time** | 9.77 s | 25.0 ms | 9.04 s | 182 ms |
| **Transactions Volume** | Low | High: up to 1000 transactions per minute | High: up to 1000 transactions per minute | High: up to 1000 transactions per minute |
**Transfers APIs**
The version 1.2 APIs include **paymentInstrumentId** as one of the body parameters. Find the list of transfer APIs below:
| API Version 1.2 | API Version 1 | Response Time |
| :---------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------- | :------------ |
| [Standard Transfer Sync V1.2](/api-reference/payouts/v1/standard-transfer-sync-v12) | [Standard Transfer Sync](/api-reference/payouts/v1/standard-transfer-sync) | 9.77 s |
| [Standard Transfer Async V1.2](/api-reference/payouts/v1/standard-transfer-async-v12) | [Standard Transfer Async](/api-reference/payouts/v1/standard-transfer-async) | 25.0 ms |
| [Direct Transfer V1.2](/api-reference/payouts/v1/direct-transfer-v12) | [Direct Transfer](/api-reference/payouts/v1/direct-transfer) | 9.04 s |
| [Get Transfer Status V1.2](/api-reference/payouts/v1/get-transfer-status-v12) | [Get Transfer Status](/api-reference/payouts/v1/get-transfer-status) | 244 ms |
| [Batch Transfer V1.2](/api-reference/payouts/v1/batch-transfer-v12) | [Batch Transfer](/api-reference/payouts/v1/batch-transfer) | 182 ms |
| [Get Batch Transfer Status V1.2](/api-reference/payouts/v1/get-batch-transfer-status-v12) | [Get Batch Transfer Status](/api-reference/payouts/v1/get-batch-transfer-status) | 6.19 ms |
***
## What does the response parameter 'acknowledged' mean?
The acknowledged parameter value conveys if the beneficiary received the funds by checking its value. Ack = 1 or 0 . 1 denotes the beneficiary received funds, and 0 denotes the beneficiary had not received funds.
The cash flow happens as explained below:
1. `Debit`: The debit of the transfers happens on the remitter account. After a successful debit, the beneficiary bank does further processing. When only the debit is successful, Ack = 0.
2. Credit: The beneficiary bank credits the fund to the account. The transfer is sent from the remitter bank to the beneficiary bank after a successful debit. When the credit to the end beneficiary is successful, Ack = 1.
To confirm the status of a payout, you need to check the acknowledged parameter value. If the value is 1, you can mark the transfer as successful. However, if the value is 0, you must either wait for the TRANSFER\_ACKNOWLEDGED webhook event or use the [Get Transfer Status](/api-reference/payouts/v1/get-transfer-status-v12) API and confirm the acknowledged value.
***
# Overview
Source: https://www.cashfree.com/docs/api-reference/payouts/v1/transfer-v12
Transfer funds to your beneficiaries through bank transfers, Paytm, Amazon Pay, UPI, IMPS, and NEFT. The version 1.2 transfer APIs include paymentInstrumentId as one of the body parameters.
Learn how each API functions using the following table and use the best-suited API for your transactions.
| | [Transfer Sync](/api-reference/payouts/v1/standard-transfer-sync-v12) | [Transfer Async](/api-reference/payouts/v1/standard-transfer-async-v12) | [Direct Transfer](/api-reference/payouts/v1/direct-transfer-v12) | [Batch Transfer](/api-reference/payouts/v1/batch-transfer-v12) |
| ------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| **Functionality** | Initiate an amount transfer request | Initiate an amount transfer request | Initiate an amount transfer request directly to the beneficiary not added in your Payouts account (add beneficiary details in the API request) | Initiate amount transfer request to multiple beneficiaries |
| **Sync / Async** | Sync | Async | Async | Async |
| **UTR / Cashfree Reference ID** | Both UTR and Cashfree Reference ID | Cashfree Reference ID | Cashfree Reference ID | Cashfree Reference ID |
| **Required Body Params** | beneId \namount \ntransferId | beneId \namount \ntransferId | amount \ntransferId \ntransferMode \nbeneDetails | batchTransferId \nbatchFormat |
| **Default Transfer Mode** | Bank Transfer | Bank Transfer | Not Applicable | Not Applicable |
| **Available Transfer Modes** | Bank, UPI, Paytm, Amazon Pay, | Bank, UPI, Paytm, Amazon Pay, Card | Bank, UPI, Paytm, Amazon Pay, Card, IMPS, NEFT | Bank, UPI, Paytm, Amazon Pay |
| **Response Time** | 9.77 s | 25.0 ms | 9.04 s | 182 ms |
| **Transactions Volume** | Low | High: up to 1000 transactions per minute | High: up to 1000 transactions per minute | High: up to 1000 transactions per minute |
**Transfers APIs**
The version 1.2 APIs include **paymentInstrumentId** as one of the body parameters. Find the list of transfer APIs below:
| API Version 1.2 | API Version 1 | Response Time |
| :---------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------- | :------------ |
| [Standard Transfer Sync V1.2](/api-reference/payouts/v1/standard-transfer-sync-v12) | [Standard Transfer Sync](/api-reference/payouts/v1/standard-transfer-sync) | 9.77 s |
| [Standard Transfer Async V1.2](/api-reference/payouts/v1/standard-transfer-async-v12) | [Standard Transfer Async](/api-reference/payouts/v1/standard-transfer-async) | 25.0 ms |
| [Direct Transfer V1.2](/api-reference/payouts/v1/direct-transfer-v12) | [Direct Transfer](/api-reference/payouts/v1/direct-transfer) | 9.04 s |
| [Get Transfer Status V1.2](/api-reference/payouts/v1/get-transfer-status-v12) | [Get Transfer Status](/api-reference/payouts/v1/get-transfer-status) | 244 ms |
| [Batch Transfer V1.2](/api-reference/payouts/v1/batch-transfer-v12) | [Batch Transfer](/api-reference/payouts/v1/batch-transfer) | 182 ms |
| [Get Batch Transfer Status V1.2](/api-reference/payouts/v1/get-batch-transfer-status-v12) | [Get Batch Transfer Status](/api-reference/payouts/v1/get-batch-transfer-status) | 6.19 ms |
***
## What does the response parameter 'acknowledged' mean?
The acknowledged parameter value conveys if the beneficiary received the funds by checking its value. Ack = 1 or 0 . 1 denotes the beneficiary received funds, and 0 denotes the beneficiary had not received funds.
The cash flow happens as explained below:
1. Debit: The debit of the transfers happens on the remitter account. After a successful debit, the beneficiary bank does further processing. When only the debit is successful, Ack = 0.
2. Credit: The beneficiary bank credits the fund to the account. The transfer is sent from the remitter bank to the beneficiary bank after a successful debit. When the credit to the end beneficiary is successful, Ack = 1.
To confirm the status of a payout, you need to check the acknowledged parameter value. If the value is 1, you can mark the transfer as successful. However, if the value is 0, you must either wait for the TRANSFER\_ACKNOWLEDGED webhook event or use the [Get Transfer Status](/api-reference/payouts/v1/get-transfer-status-v12) API and confirm the acknowledged value.
# Verify
Source: https://www.cashfree.com/docs/api-reference/payouts/v1/verify
post /payout/v1/verifyToke
Use this API to verify the bearer token generated. If the token does not exist/invalid/expired, the response "Token is not valid" is returned. Regenerate token in case of token expiry to make API calls (use /payout/v1/authorize for this).
# Verify
Source: https://www.cashfree.com/docs/api-reference/payouts/v1/verify-1
post /payout/v1/verifyToken
Verify the bearer token generated. If the token does not exist, is invalid, or has expired, the response "Token is not valid" is returned. Regenerate token in case of token expiry for making API calls ( use /payout/v1/authorize for this).
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
# Webhooks
Source: https://www.cashfree.com/docs/api-reference/payouts/v1/webhooks
Webhooks are events that notify you about the payment status. All Cashgram integrations should establish a webhook to listen for cashgram events, like status changes on payments. Webhooks are HTTP callbacks that receive notification messages for events.
Webhooks help you receive automatic updates and are significant for completing the integration with Cashfree. Webhooks are triggered with a request from your side, for example, when a transfer fails or when a daily report is available. Requests get processed both synchronously and asynchronously. In rare scenarios, for some payment methods, the outcome may take a longer duration to confirm. Cashfree notifies you once we get updates from the bank about the payment status.
Do not go live without signature verification if you are using webhooks.
## Webhook Events
Cashfree Cashgram API enables you to receive updates about all event-driven activities originating from your account. Below is the list of Cashgram webhooks:
**CASHGRAM\_REDEEMED**: Cashgram redeemed by the customer\
**CASHGRAM\_TRANSFER\_REVERSAL**: Cashgram transfer reversed by the bank\
**CASHGRAM\_EXPIRED**: Cashgram is inactive
Cashfree gets a response from the bank with the status of the transfer. At times the notifications may get delayed due to various reasons, and the transaction status will be marked as Pending, till Cashfree gets a response.
Cashfree polls the transaction status from the bank for the next 72 hours. In case we do not receive the status of a transaction after 72 hours, the transaction will be marked as Failed.
## CASHGRAM\_REDEEMED
Sent whenever a Cashgram is redeemed.
| Parameter | Description |
| :---------- | :--------------------------------------------------------------------------------------------- |
| event | It contains the name of the event which just occurred. Value = CASHGRAM\_REDEEMED |
| cashgramid | Id of the cashgram passed by the merchant |
| referenceId | Id of the transfer generated by Cashfree |
| eventTime | Transfer initiation time |
| utr | Unique transaction reference number provided by the bank |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree. |
## CASHGRAM\_TRANSFER\_REVERSAL
Sent whenever the bank reverses a Cashgram.
| Parameter | Description |
| :---------- | :--------------------------------------------------------------------------------------------- |
| event | It contains the name of the event which just occurred. Value = CASHGRAM\_TRANSFER\_REVERSAL |
| cashgramid | Id of the cashgram passed by the merchant |
| referenceId | Id of the transfer generated by Cashfree |
| eventTime | Transfer initiation time |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree. |
## CASHGRAM\_EXPIRED
Cashgram can become inactive for various reasons. An inactive Cashgram cannot be re-activated. You need to create a new Cashgram to send to your customer. A Cashgram gets reversed if one of the following events occurs:
1. **Redeeming post Expiry time**: If the customer does not redeem the Cashgram before the expiration time (set by the Merchant while creating the Cashgram), the Cashgram gets deactivated.
2. **Reaching the maximum number of retries**: A maximum of three attempts is allowed to redeem the Cashgram. If the customer enters incorrect details more than three times, the Cashgram gets deactivated.
3. **OTP verification attempts exceeded**: A maximum of three attempts is allowed to verify the OTP. If the customer fails to verify the OTP successfully, the Cashgram gets deactivated.
| Parameter | Description |
| :--------- | :--------------------------------------------------------------------------------------------- |
| event | It contains the name of the event which just occurred. Value = CASHGRAM\_EXPIRED |
| cashgramid | Id of the cashgram passed by the merchant |
| reason | Reason for reversal |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree. |
## Signature Verification
Cashfree sends a signature alongside every webhook, verifying this signature ( passed along with the POST parameters ) is mandatory before processing any response. It helps authenticate that the webhook is from Cashfree.
We strongly recommend whitelisting Cashfree's production IP to help make your communication with Cashfree more secure.
Following are the steps to verify Cashfree's signature:
1. Get all the POST parameters except ‘signature’ and assign it to an array as key-value pair
2. Sort the array based on keys
3. Concatenate all the values in this array and the resultant is the post data (say, postData)
4. **postData** needs to be encrypted using SHA-256, and then base64 encoded
5. Now verify if both the signature calculated and the signature received match
6. Proceed further if it matches, else discards the request
Cashfree's libraries also support signature verification. To verify the signature returned by Cashfree call the following methods from the library.
Below code snippets can help you verify Cashfree Signature:
| HTTP Status Code | Status | Status Code | Status Description | Next Action | Try again via Cashfree - Yes or No | | :--------------- | :----------------- | :------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- | | 200 | APPROVAL\_PENDING | VELOCITY\_CHECK\_FAILED | The transfer requires an approval as the count of transfers to a particular beneficiary etc have breached the limit. You can approve or reject the transfer request from the Cashfree [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - | | 200 | APPROVAL\_PENDING | TRANSFER\_LIMIT\_BREACH | The transfer requires an approval as the transfer amount etc have breached the limit. You can approve or reject the transfer request from the Cashfree [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - | | 200 | APPROVAL\_PENDING | APPROVAL\_PENDING | The transfer requires approval. You can approve or reject the transfer request from the Cashfree [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - | | 200 | FAILED | WAIT\_TIME\_EXCEEDED | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | BENE\_BANK\_DECLINED | The transfer has failed because the beneficiary bank has declined the transfer. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | - | Yes | | 200 | FAILED | IMPS\_MODE\_FAIL | The transfer has failed because the beneficiary account doesnot support IMPS transfers. This rejection is done by the partner bank for the specific beneficiary account. You can try NEFT or other channels to do the disbursals | You can try NEFT or other channels to do the disbursals. | Yes, via a different mode | | 200 | FAILED | SOURCE\_BANK\_DECLINED | The transfer has failed because our partner bank has declined the transfer because of their internal checks, technical declines etc. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with other partner bank(s). | Yes | | 200 | FAILED | CONNECTION\_TIMEOUT | The transfer has failed because there was a connection timeout between the bank and Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | Yes | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | Yes | | 200 | FAILED | NPCI\_UNAVAILABLE | The transfer has failed because NPCI was unavailable to complete the transfer request. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree. The success of the request is contingent on NPCI services being up. | - | Yes, after some time | | 200 | FAILED | DEST\_LIMIT\_REACHED | The transfer has failed because the beneficiary account has breached the limit of receiving funds. This rejection is done by the beneficiary bank for the specific beneficiary account. You can reinitiate the transfer after a while via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). The success of the request is contingent on beneficiary's limit being available to receive incoming funds. | - | Yes, after some time | | 200 | FAILED | RETURNED\_FROM\_BENEFICIARY | The transfer has failed because the beneficiary bank has returned the transfer and has not need able to credit funds to the end beneficiary. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | - | - | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | INVALID\_BENE\_ACCOUNT\_OR\_IFSC | The transfer has failed because the beneficiary account or IFSC is invalid. After correcting the beneficiary account or IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | FAILED | The transfer has failed because there was an intermittent issue at the partner bank's end. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | INSUFFICIENT\_BALANCE | The transfer has failed because of low balance in your Cashfree Wallet/ Bank Account. After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after recharging | | 200 | FAILED | INVALID\_BENE\_VPA | The transfer has failed because the beneficiary VPA is invalid. After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the VPA handle | | 200 | FAILED | INVALID\_IFSC\_FAIL | The transfer has failed because the IFSC is invalid. After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the IFSC | | 200 | FAILED | BAD\_GATEWAY | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | INVALID\_AMOUNT\_FAIL | The transfer has failed because the amount entered is invalid. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the amount | | 200 | FAILED | INVALID\_ACCOUNT\_FAIL | The transfer has failed because the Account Number of the beneficiary is invalid, as per our partner bank. After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account number | | 200 | FAILED | INVALID\_REQUEST | The transfer has failed because the transfer request is invalid, as per our partner bank, because of exceeding the character limit of certain parameter, wrong input etc. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | ACCOUNT\_BLOCKED | The transfer has failed because the account is blocked, as per our partner bank. After getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after unblocking the account number | | 200 | FAILED | DEBIT\_FAILURE | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | BENEFICIARY\_BANK\_OFFLINE | The transfer has failed because the respective beneficiary bank is offline. After some time, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After some time, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | AUTHENTICATION\_FAILURE | The transfer has failed because there was an authentication failure at the partner bank's end. After checking with the partner bank, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | This is a scenario when the API access is not working at the partner bank's end. After checking with the partner bank, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | NRE\_ACCOUT\_FAIL | The transfer has failed because the beneficiary account is an NRE Account and transfers to NRE Accounts are not supported, as per our partner bank. | Get a new account(non-NRE account) from the beneficiary; you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | No | | 200 | FAILED | SOURCE\_LIMIT\_REACHED | The transfer has been failed by the partner bank as the source bank account has reached a limit of transferring funds. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | If you are on Cashfree Wallet, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). If you are on Connected Bank, you need to recharge your bank account and then reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time | | 200 | FAILED | BANK\_GATEWAY\_ERROR | The transfer has failed because there was an intermittent issue at the partner bank's end. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | BAD\_REQUEST | The transfer has failed because the details of the transfer request is invalid, as per our partner bank. After correcting the details in the transfer request, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the details in the transfer request, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | REINITIALIZE\_TRANSFER\_LATER | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | MANUALLY\_REJECTED | MANUALLY\_REJECTED | The transfer has failed because it has been manually rejected by the merchant or any team member user who has the permissions to do the same on merchant dashboard. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | If the merchant wants to reinitiate the transfer, they can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | Yes, if you want to reinitiate the transfer | | 200 | PENDING | SENT\_TO\_BANK | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. This has been sent to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | BANK\_GATEWAY\_ERROR | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | NO\_SUCH\_REQUEST | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank is not able to find the request at their end as of now, and it has been sent to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | IN\_PROCESS | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | ERROR\_FETCHING\_STATUS | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The response received from the partner bank has a new code. This has been raised with the bank to understand the new code. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | TRANSACTION\_PROCESSED | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | REQUEST\_TIMEDOUT | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank is not able to find the request at their end as of now as the request between the partner bank has probably timed out, and it has been highlighted to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | DUPLICATE | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank claims of receiving a duplicate request at their end as of now. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | PENDING | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | | | | 200 | PENDING | SCHEDULED\_FOR\_NEXT\_WORKINGDAY | The transfer is currently in a Pending state, as the bank has scheduled the transfer for the next working day. This typically happens for NEFT/RTGS transfers if they are initiated beyond the cut-off hours or during bank holidays. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - | | 200 | PENDING | SUSPECT | The transfer is currently in a Pending state, as the bank has scheduled the transfer for the next working day. This typically happens for NEFT/RTGS transfers if they are initiated beyond the cut-off hours or during bank holidays. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - | | 200 | PENDING | IMPLEMENTATION\_ERROR | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - | | 200 | PENDING | UNKNOWN\_ERROR\_CODE | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The response received from the partner bank has a new code. This has been raised with the bank to understand the new code. Please do check statuses or await webhooks to know the terminal state of the transfer request. | - | - | | 200 | QUEUED | QUEUED | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | RECEIVED | RECEIVED | The transfer has been received by Cashfree successfully for further processing. You should use Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | REJECTED | BENE\_NOT\_EXIST | The transfer has been rejected because the beneficiary, added in the transfer request, does not exist. After adding the right beneficiary, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After adding the right beneficiary, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after adding the right beneficiary | | 200 | REJECTED | INSUFFICIENT\_BALANCE | The transfer has been rejected because of low balance in your Cashfree Wallet. After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after recharging | | 200 | REJECTED | INSIDE\_BLACKOUT\_WINDOW | The transfer has been rejected because the transfer falls under the blackout window defined by you in Payout Protect. You can reinitiate the transfer via Cashfree, after the blackout window or after modifying the blackout window from the [Merchant Dashboard](https://merchant.cashfree.com/merchants), so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree, after the blackout window or after modifying the blackout window from the [Merchant Dashboard](https://merchant.cashfree.com/merchants), so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | INVALID\_MODE\_FOR\_PYID | The transfer has been rejected because the payment instrument does not support this mode of transfer. You should get this mode activated on the payment instrument ID by contacting Cashfree, and then initiate a new transfer request. | You should get this mode activated on the payment instrument ID by contacting Cashfree, and then initiate a new transfer request. | Yes, after activating the mode. | | 200 | REJECTED | BENE\_BLACKLISTED | The transfer has been rejected because the beneficiary's bank account and/or VPA handles have been blacklisted by Risk team. You should get a different bank account and/or VPA to send the transfer, or you can connect with Cashfree Team to understand more about this. | You should get a different bank account and/or VPA to send the transfer, or you can connect with Cashfree Team to understand more about this. | Yes, after correcting the beneficiary details | | 200 | REJECTED | TRANSFER\_NOT\_ATTEMPTED | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | INVALID\_TRANSFER\_AMOUNT | The transfer has been rejected because the amount entered is invalid. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s) | Yes, after correcting the amount | | 200 | REJECTED | TRANSFER\_LIMIT\_BREACH | The transfer has been rejected because the amount entered breaches the limits set for your payout account. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | Yes, after adhering to the transfer limits | | 200 | REJECTED | INVALID\_PAYMENT\_INSTRUMENT | The transfer has been rejected because the payment instrument (fundsource\_id parameter in the API request) used for attempting the transfer is invalid. After correcting the payment instrument, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the payment instrument, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the payment instrument | | 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | VELOCITY\_CHECK\_FAILED | The transfer has been rejected because the amount entered breaches the limits set for your payout account. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | Yes, after adhering to the transfer limit | | 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | DISABLED\_MODE | The transfer has been rejected because your payout account does not support this mode of transfer. You should get this mode activated on your payout account by contacting Cashfree, and then initiate a new transfer request. | You should get this mode activated on your payout account by contacting Cashfree, and then initiate a new transfer request. | Yes, after activating the mode | | 200 | REJECTED | BANK\_ACCOUNT\_INVALID | The transfer has been rejected because there is a mismatch in the Bank Account Number of the beneficiary ID and the Bank Account Number in the transfer request. After correcting the Bank Account Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the Bank Account Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the bank account number | | 200 | REJECTED | BANK\_IFSC\_INVALID | The transfer has been rejected because there is a mismatch in the IFSC of the beneficiary ID and the IFSC in the transfer request. After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the IFSC | | 200 | REJECTED | VPA\_INVALID | The transfer has been rejected because there is a mismatch in the VPA handle of the beneficiary ID and the VPA handle in the transfer request. After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the VPA handle | | 200 | REJECTED | PHONE\_INVALID | The transfer has been rejected because there is a mismatch in the Phone Number of the beneficiary ID and the Phone Number in the transfer request. After correcting the Phone Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the Phone Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the phone number. | | 200 | REJECTED | BANK\_ACCOUNT\_DETAILS\_MISSING | The transfer has been rejected because the Bank Account Details are missing in the transfer request. After adding the Bank Account Details, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After adding the Bank Account Details, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after adding the bank account details. | | 200 | REVERSED | ACCOUNT\_BLOCKED | The transfer has been reversed by the beneficiary bank as the end-beneficiary's account is blocked for receiving incoming funds. After correcting the account number or getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number or getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after adding the new details or getting the account unblocked | | 200 | REVERSED | FAILED | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | Yes | | 200 | REVERSED | NRE\_ACCOUNT\_FAIL | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account as it is an NRE Account and transfers to NRE Accounts are not supported. | Get a new account(non-NRE account) from the beneficiary; you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | No | | 200 | REVERSED | RETURNED\_FROM\_BENEFICIARY | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REVERSED | BENE\_BANK\_DECLINED | The transfer has been declined by the beneficiary bank and they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REVERSED | IMPS\_MODE\_FAIL | The transfer has been reversed by the beneficiary bank because the beneficiary bank account doesnot support IMPS transfers. This rejection is done by the beneficiary bank for the specific beneficiary account. You can try NEFT or other channels to do the disbursals. | You can reinitiate the transfer via Cashfree by changing the mode so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after changing the mode | | 200 | REVERSED | DEST\_LIMIT\_REACHED | The transfer has been reversed by the beneficiary bank as the end-beneficiary's account has reached a limit of receiving incoming funds. This rejection is done by the beneficiary bank for the specific beneficiary account. You can reinitiate the transfer after a while via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). The success of the request is contingent on beneficiary's limit being available to receive incoming funds. | The limits on the beneficiary account are typically refreshed every 24 hours. Its not clear when the 24 hour window shall elpase so you can then reinitiate the transfer via Cashfree after some time so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time. | | 200 | REVERSED | INVALID\_ACCOUNT\_FAIL | The transfer has been reversed by the beneficiary bank because the Account Number of the beneficiary is invalid. After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account number | | 200 | REVERSED | BENE\_NAME\_DIFFERS | The transfer has been reversed by the beneficiary bank because the Account Name of the beneficiary is different. After correcting the beneficiary name, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the beneficiary name, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account name | | 200 | SUCCESS | SENT\_TO\_BENEFICIARY | The transfer has been initiated via the partner bank successfully. The request is waiting to be processed at the beneficiary bank to do the credit to the end beneficiary. | - | - | | 200 | SUCCESS | COMPLETED | The transfer has been initiated via the partner bank successfully, hence your account is debited and the request is successfuly processed by the beneficiary bank and has been credited to the end beneficiary. | - | - | \| 200 | REJECTED | TRANSFERID\_INVALID | transferid can contain only alphabets, numbers, underscore (\_), hyphen (-). After correcting the transferid, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the transferid, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting transfer id. | \| 200 | REJECTED | AMOUNT\_INVALID | amount can contain only numbers. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be attempted. | After correcting the amount, you can reinitiate the transfer. | Yes, after correcting amount. | \| 200 | REJECTED | REMARKS\_INVALID | remarks can contain only alphabets, numbers and space. | After correcting the remarks, you can reinitiate the transfer. | Yes, after correcting remarks. | \| 200 | REJECTED | BENEID\_INVALID | beneId can contain only alphabets, numbers and underscore. | After correcting the beneId, you can reinitiate the transfer. | Yes, after correcting beneficiary id. | \| 200 | REJECTED | NAME\_INVALID | name can contain only alphabets, numbers and space. | After correcting the name, you can reinitiate the transfer. | Yes, after correcting name. | \| 200 | REJECTED | EMAIL\_INVALID | email is not a valid email format. | After correcting the email, you can reinitiate the transfer. | Yes, after correcting email. | \| 200 | REJECTED | IBAN\_INVALID | iban can contain only alphabets and numbers. | After correcting the iban, you can reinitiate the transfer. | Yes, after correcting IBAN. | \| 200 | REJECTED | TRANSFERMODE\_INVALID | transferMode invalid (allowed: banktransfer, upi, paytm, amazonpay, imps, neft, rtgs, ppc). | After correcting the transferMode, you can reinitiate the transfer. | Yes, after correcting mode. | \| 200 | REJECTED | CURRENCY\_INVALID | currency is invalid. | After correcting the currency, you can reinitiate the transfer. | Yes, after correcting currency. | \| 200 | REJECTED | ACCOUNT\_DOES\_NOT\_EXIST | The transfer has been rejected because the beneficiary account/ VPA does not exist as per our partner bank. After correcting the account number/ VPA, you can reinitiate the transfer. | After correcting the account number / VPA, reinitiate the transfer. | Yes, after correcting details. | \| 200 | FAILED | ACCOUNT\_DOES\_NOT\_EXIST | The transfer has failed because the beneficiary account/ VPA does not exist as per our partner bank. After correcting the account number/ VPA, you can reinitiate the transfer. | After correcting the account number / VPA, reinitiate the transfer. | Yes, after correcting details. | \| 200 | REJECTED | AMAZON\_AMOUNT\_EXCEED | The amount entered breaches the limits set for the beneficiary's Amazon account. | After verifying the limits, reinitiate the transfer. | Yes, after verifying limits. | \| 200 | FAILED | AMAZON\_AMOUNT\_EXCEED | The amount entered breaches the limits set for the beneficiary's Amazon account. | After verifying the limits, reinitiate the transfer. | Yes, after verifying limits. | \| 200 | REJECTED | ANOMALY\_DETECTION | The transfer has been rejected as risk product detected an anomaly. | Reinitiate after validation at your end. | Yes, after validation. | \| 200 | APPROVAL\_PENDING | ANOMALY\_DETECTION | The transfer requires approval as risk product detected an anomaly. | Approve / reject on dashboard (Payout Protect). | - | \| 200 | FAILED | BAD\_CONNECTION | Intermittent internal error between Cashfree and partner bank. | Reinitiate the transfer. | Yes, after some time. | \| 200 | REJECTED | BENE\_INVALID | Beneficiary in the request does not exist. | Add correct beneficiary then reinitiate. | Yes, after adding beneficiary. | \| 200 | FAILED | BENE\_INVALID | Beneficiary in the request does not exist. | Add correct beneficiary then reinitiate. | Yes, after adding beneficiary. | \| 200 | FAILED | BENE\_NOT\_REGISTERED | Beneficiary not registered with partner bank. | Add correct beneficiary then reinitiate. | Yes, after adding beneficiary. | \| 200 | VALIDATION\_PENDING| BENE\_VERIFICATION\_PENDING | Beneficiary verification pending; transfer will be attempted post validation. | Rely on Check Status API or webhooks. | - | \| 200 | FAILED | BENEFICIARY\_BANK\_UNAVAILABLE | Beneficiary bank offline. | Reinitiate after some time. | Yes, after some time. | \| 200 | FAILED | BENEFICIARY\_NAME\_DIFFERS | Beneficiary name differs per partner bank. | Add correct beneficiary then reinitiate. | Yes, after correcting name. | \| 200 | REJECTED | BENEFICIARY\_NAME\_DIFFERS | Beneficiary name differs per partner bank. | Add correct beneficiary then reinitiate. | Yes, after correcting name. | \| 200 | REJECTED | BENEFICIARY\_NAME\_MISMATCH | Beneficiary name differs per partner bank. | Add correct beneficiary then reinitiate. | Yes, after correcting name. | \| 200 | REJECTED | CARD\_UNSUPPORTED | Card not supported. | Change payment instrument then reinitiate. | Yes, after changing instrument. | \| 200 | FAILED | CARD\_UNSUPPORTED | Card not supported. | Change payment instrument then reinitiate. | Yes, after changing instrument. | \| 200 | FAILED | DUPLICATE\_FAILED | Bank claims duplicate request. | Reinitiate with different transfer id. | Yes, with new id. | \| 200 | FAILED | ERROR\_RETRIEVING\_BALANCE | Intermittent issue at partner bank retrieving balance. | Reinitiate after some time. | Yes, after some time. | \| 200 | REJECTED | INVALID\_CARD | Card details not correct. | Enter correct card details then reinitiate. | Yes, after correcting card. | \| 200 | FAILED | INVALID\_CARD | Card details not correct. | Enter correct card details then reinitiate. | Yes, after correcting card. | \| 200 | REJECTED | INVALID\_CURRENCY\_FOR\_PYID | Transfer currency not supported for payment instrument id. | Change currency to INR and reinitiate. | Yes, after changing currency. | \| 200 | FAILED | INVALID\_CURRENCY\_FOR\_PYID | Transfer currency not supported for payment instrument id. | Change currency to INR and reinitiate. | Yes, after changing currency. | \| 200 | FAILED | INVALID\_MODE\_FAIL | Transfer mode not supported for beneficiary account. | Change mode then reinitiate. | Yes, after changing mode. | \| 200 | REJECTED | INVALID\_OR\_NO\_SUCH\_ACCOUNT\_TYPE | Beneficiary account type invalid / unsupported. | Get new account from beneficiary then reinitiate. | Yes, after new account. | \| 200 | FAILED | INVALID\_OR\_NO\_SUCH\_ACCOUNT\_TYPE | Beneficiary account type invalid / unsupported. | Get new account from beneficiary then reinitiate. | Yes, after new account. | \| 200 | FAILED | INVALID\_PHONE\_BENEFICIARY | Phone number not linked to any VPA. | Add correct phone beneficiary then reinitiate. | Yes, after correcting phone. | \| 200 | REJECTED | INVALID\_TRANSFER\_CURRENCY | Transfer currency not supported. | Change currency to INR then reinitiate. | Yes, after changing currency. | \| 200 | FAILED | INVALID\_TRANSFER\_CURRENCY | Transfer currency not supported. | Change currency to INR then reinitiate. | Yes, after changing currency. | \| 200 | REJECTED | KYC\_COMPLIANCE\_VERIFICATION\_FAILED | KYC verification failed. | Reinitiate after resolving KYC. | Yes, after KYC resolution. | \| 200 | REJECTED | KYC\_REQUIREMENTS\_NOT\_SATISFIED | KYC requirements not satisfied. | Complete KYC then reinitiate. | Yes, after completing KYC. | \| 200 | FAILED | LOAD\_LIMIT\_EXHAUSTED | Beneficiary account reached max transaction amount limit. | Reinitiate after 24 hours. | Yes, after 24 hours. | \| 200 | FAILED | LOAN\_FUND\_MOVEMENT\_FAILURE | Intermittent issue at Cashfree. | Reinitiate transfer. | Yes, after some time. | \| 200 | PENDING | LOW\_BALANCE\_QUEUED | Balance in the fund source is exhausted; will auto process post recharge. | Recharge fund source; rely on status API/webhook. | - | \| 200 | REJECTED | MANUALLY\_REJECTED | Transfer manually rejected by you. | Reinitiate if required. | Yes, if needed. | \| 200 | REJECTED | PAYOUT\_INACTIVE | Payout account inactive. | Activate account then reinitiate. | Yes, after activation. | \| 200 | FAILED | POOL\_CONNECTION\_TIMEOUT | Connection issue with partner bank. | Reinitiate after some time. | Yes, after some time. | \| 200 | REJECTED | QUICK\_TRANSFER\_DISABLED | Quick transfer disabled for payout account. | Enable quick transfer then reinitiate. | Yes, after enabling. | \| 200 | REJECTED | REJECTED | Transfer rejected (generic). | Review request and correct issues. | Yes, after correction. | \| 200 | REVERSED | REVERSED | Transfer reversed by beneficiary bank; credit failed. | Reinitiate after correcting issue. | Yes, after correction. | \| 200 | FAILED | RTGS\_MODE\_FAIL | Beneficiary account does not support RTGS transfers. | Try NEFT or other channels. | Yes, via different mode. | \| 200 | FAILED | SUSPECTED\_FAILED | Partner bank suspects transfer is fraudulent. | Contact support / investigate before retry. | No (investigate). | \| 200 | REJECTED | VBA\_TRANSFER\_DISABLED | Transfers to virtual bank accounts not enabled. | Enable payouts to VBAs then reinitiate. | Yes, after enabling. | \| 200 | REJECTED | ERROR\_SELECTING\_FUND\_SOURCE | Issue with account configuration selecting fund source. | Contact care team; fix config then reinitiate. | Yes, after fixing config. | \| 200 | VALIDATION\_PENDING| VALIDATION\_PENDING | Beneficiary verification pending; transfer will be attempted post validation. | Rely on Status API / webhooks. | - | \| 200 | REJECTED | INVALID\_BENEFICIARY\_CODE | Beneficiary code invalid. | Correct beneficiary code then reinitiate. | Yes, after correcting code. | \| 200 | REJECTED | DUPLICATE\_TRANSFER | Transfer already present / processed; duplicate transferId. | Change transferId and reinitiate. | Yes, with new transfer id. | #### 4XX errors | HTTP Status Code | Error Code | Message | Next Action | | :--------------- | :------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | :---------------------------------------- | | 400 | batch\_transfer\_id\_missing | batch\_transfer\_id\_missing is missing in the request | Enter a batch transfer ID in the request. | | 400 | batch\_transfer\_id\_invalid | batch\_transfer\_id\_invalid should be alphanumeric | Enter a valid batch transfer ID. | | 400 | transfers\[0].transfer\_id\_invalid | transfer\_id should be alphanumeric | Enter a valid transfer ID. | | 400 | transfers\[0].transfer\_id\_missing | transfer\_id is missing in the request | Enter a transfer ID in the request. | | 400 | transfers\[0].transfer\_amount\_invalid | transfer\_amount should be greater then 1.00 | Enter an amount greater than 1.00. | | 400 | transfers\[0].transfer\_amount\_missing | transfer\_amount is missing in the request | Enter a transfer amount in the request. | | 400 | transfers\[0].transfer\_mode\_invalid | transfer\_mode is invalid allowed values are : bank, imps, neft, rtgs, upi, paytm, amazonpay, card and cardupi | Enter a valid transfer mode. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_id\_invalid | beneficiary\_id should be alphanumeric | Enter a valid beneficiary ID. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_name\_invalid | beneficiary\_name is invalid. only alphabets and whitespaces are allowed | Enter a valid beneficiary name. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.bank\_account\_number\_invalid | bank\_account\_number should be alphanumeric | Enter a valid bank account number. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.bank\_ifsc\_invalid | bank\_ifsc should be in standard ifsc format | Enter a valid IFSC. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.vpa\_invalid | vpa is in invalid format | Enter a valid VPA. |
When you get a 5XX response, don't initiate another transaction.
Check the status of the batch transfer using Get Batch Transfer Status V2 and then proceed further.
Use the [Get Batch Transfer Status V2](/api-reference/payouts/v2/transfers-v2/get-batch-transfer-status-v2) API to get the status of the batch transfer request. The Get Transfer Status V2 API does not give you the status of the batch transfer requests.
| HTTP Status Code | Status | Status Code | Status Description | Next Action | Try again via Cashfree - Yes or No | | :--------------- | :----------------- | :----------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- | | 200 | APPROVAL\_PENDING | VELOCITY\_CHECK\_FAILED | The transfer requires an approval as the count of transfers to a particular beneficiary etc, have breached the limit. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - | | 200 | APPROVAL\_PENDING | TRANSFER\_LIMIT\_BREACH | The transfer requires approval as the transfer amount etc, has breached the limit. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - | | 200 | APPROVAL\_PENDING | APPROVAL\_PENDING | The transfer requires approval. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - | | 200 | APPROVAL\_PENDING | ANOMALY\_DETECTION | The transfer requires approval as it is a high risk transaction detected by the Payout Protect model. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - | | 200 | APPROVAL\_PENDING | RISK\_CHECK\_MANUAL\_REVIEW\_REQ | The transfer requires approval as it has been flagged by the Payout Protect risk model for manual review. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | RISK\_CHECK\_ANOMALY\_DETECTED | The transfer requires approval as it has been flagged by the Payout Protect risk model for manual review due to anomaly detection. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | RISK\_CHECK\_BENEFICIARY\_HIGH\_RISK | The transfer requires approval as the beneficiary has been identified as high risk by the Payout Protect model. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | RISK\_CHECK\_VELOCITY\_THRESHOLD | The transfer requires approval as it breaches the velocity threshold set in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | RISK\_CHECK\_TIME\_WINDOW\_BREACH | The transfer requires approval as it falls outside the allowed time window defined in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | RISK\_CHECK\_AMOUNT\_THRESHOLD | The transfer requires approval as it exceeds the amount threshold set in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | HIGH\_RISK\_BENEFICIARY | The transfer requires approval as the beneficiary is identified as high risk. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | UNUSUAL\_ACTIVITY\_DETECTED | The transfer requires approval as unusual activity has been detected in the transfer pattern. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | BLACKOUT\_WINDOW\_RULE | The transfer requires approval as it falls within the blackout window defined in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | CUSTOM\_RULE\_TRIGGERED | The transfer requires approval as it has triggered a custom rule defined in the Payout Protect settings. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - | | 200 | APPROVAL\_PENDING | MANUAL\_APPROVAL\_REQUIRED | The transfer requires manual approval as per the configured workflow. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. | - | | 200 | APPROVAL\_PENDING | COMPLIANCE\_REVIEW\_PENDING | The transfer requires approval as it is pending compliance review. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. | - | | 200 | FAILED | WAIT\_TIME\_EXCEEDED | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | BENE\_BANK\_DECLINED | The transfer has failed because the beneficiary bank has declined the transfer. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | - | Yes | | 200 | FAILED | IMPS\_MODE\_FAIL | The transfer has failed because the beneficiary account does not support IMPS transfers. This rejection is done by the partner bank for the specific beneficiary account. You can try NEFT or other channels to do the disbursals | You can try NEFT or other channels to do the disbursals. | Yes, via a different mode | | 200 | FAILED | SOURCE\_BANK\_DECLINED | The transfer has failed because our partner bank has declined the transfer because of their internal checks, technical declines etc. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with other partner bank(s). | Yes | | 200 | FAILED | CONNECTION\_TIMEOUT | The transfer has failed because there was a connection timeout between the bank and Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | Yes | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | Yes | | 200 | FAILED | NPCI\_UNAVAILABLE | The transfer has failed because NPCI was unavailable to complete the transfer request. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree. The success of the request is contingent on NPCI services being up. | - | Yes, after some time | | 200 | FAILED | DEST\_LIMIT\_REACHED | The transfer has failed because the beneficiary account has breached the limit of receiving funds. This rejection is done by the beneficiary bank for the specific beneficiary account. You can reinitiate the transfer after a while via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). The success of the request is contingent on beneficiary's limit being available to receive incoming funds. | - | Yes, after some time | | 200 | FAILED | RETURNED\_FROM\_BENEFICIARY | The transfer has failed because the beneficiary bank has returned the transfer and has not need able to credit funds to the end beneficiary. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | - | - | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | INVALID\_BENE\_ACCOUNT\_OR\_IFSC | The transfer has failed because the beneficiary account or IFSC is invalid. After correcting the beneficiary account or IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | FAILED | The transfer has failed because there was an intermittent issue at the partner bank's end. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time | | 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | INSUFFICIENT\_BALANCE | The transfer has failed because of low balance in your Cashfree Wallet/ Bank Account. After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after recharging | | 200 | FAILED | INVALID\_BENE\_VPA | The transfer has failed because the beneficiary VPA is invalid. After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the VPA handle | | 200 | FAILED | INVALID\_IFSC\_FAIL | The transfer has failed because the IFSC is invalid. After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the IFSC | | 200 | FAILED | BAD\_GATEWAY | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | INVALID\_AMOUNT\_FAIL | The transfer has failed because the amount entered is invalid. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the amount | | 200 | FAILED | INVALID\_ACCOUNT\_FAIL | The transfer has failed because the Account Number of the beneficiary is invalid, as per our partner bank. After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account number | | 200 | FAILED | INVALID\_REQUEST | The transfer has failed because the transfer request is invalid, as per our partner bank, because of exceeding the character limit of certain parameter, wrong input etc. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - | | 200 | FAILED | ACCOUNT\_BLOCKED | The transfer has failed because the account is blocked, as per our partner bank. After getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after unblocking the account number | | 200 | FAILED | DEBIT\_FAILURE | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | BENEFICIARY\_BANK\_OFFLINE | The transfer has failed because the respective beneficiary bank is offline. After some time, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After some time, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | AUTHENTICATION\_FAILURE | The transfer has failed because there was an authentication failure at the partner bank's end. After checking with the partner bank, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | This is a scenario when the API access is not working at the partner bank's end. After checking with the partner bank, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | NRE\_ACCOUNT\_FAIL | The transfer has failed because the beneficiary account is an NRE Account and transfers to NRE Accounts are not supported, as per our partner bank. | Get a new account(non-NRE account) from the beneficiary; you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | No | | 200 | FAILED | SOURCE\_LIMIT\_REACHED | The transfer has been failed by the partner bank as the source bank account has reached a limit of transferring funds. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | If you are on Cashfree Wallet, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). If you are on Connected Bank, you need to recharge your bank account and then reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time | | 200 | FAILED | BANK\_GATEWAY\_ERROR | The transfer has failed because there was an intermittent issue at the partner bank's end. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | BAD\_REQUEST | The transfer has failed because the details of the transfer request is invalid, as per our partner bank. After correcting the details in the transfer request, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the details in the transfer request, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | FAILED | REINITIALIZE\_TRANSFER\_LATER | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | MANUALLY\_REJECTED | MANUALLY\_REJECTED | The transfer has failed because it has been manually rejected by the merchant or any team member user who has the permissions to do the same on [Merchant Dashboard](https://merchant.cashfree.com/auth/login). You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | If the merchant wants to reinitiate the transfer, they can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | Yes, if you want to reinitiate the transfer | | 200 | PENDING | SENT\_TO\_BANK | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. This has been sent to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | BANK\_GATEWAY\_ERROR | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | NO\_SUCH\_REQUEST | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank is not able to find the request at their end as of now, and it has been sent to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | IN\_PROCESS | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | ERROR\_FETCHING\_STATUS | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The response received from the partner bank has a new code. This has been raised with the bank to understand the new code. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | TRANSACTION\_PROCESSED | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | REQUEST\_TIMEDOUT | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank is not able to find the request at their end as of now as the request between the partner bank has probably timed out, and it has been highlighted to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | DUPLICATE | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank claims of receiving a duplicate request at their end as of now. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | PENDING | PENDING | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | | | | 200 | PENDING | SCHEDULED\_FOR\_NEXT\_WORKINGDAY | The transfer is currently in a Pending state, as the bank has scheduled the transfer for the next working day. This typically happens for NEFT/RTGS transfers if they are initiated beyond the cut-off hours or during bank holidays. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - | | 200 | PENDING | SUSPECT | The transfer is currently in a Pending state, as the bank has scheduled the transfer for the next working day. This typically happens for NEFT/RTGS transfers if they are initiated beyond the cut-off hours or during bank holidays. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - | | 200 | PENDING | IMPLEMENTATION\_ERROR | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - | | 200 | PENDING | UNKNOWN\_ERROR\_CODE | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The response received from the partner bank has a new code. This has been raised with the bank to understand the new code. Please do check statuses or await webhooks to know the terminal state of the transfer request. | - | - | | 200 | QUEUED | QUEUED | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | RECEIVED | RECEIVED | The transfer has been received by Cashfree successfully for further processing. You should use Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - | | 200 | REJECTED | BENE\_NOT\_EXIST | The transfer has been rejected because the beneficiary, added in the transfer request, does not exist. After adding the right beneficiary, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After adding the right beneficiary, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after adding the right beneficiary | | 200 | REJECTED | INSUFFICIENT\_BALANCE | The transfer has been rejected because of low balance in your Cashfree Wallet. After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after recharging | | 200 | REJECTED | INSIDE\_BLACKOUT\_WINDOW | The transfer has been rejected because the transfer falls under the blackout window defined by you in Payout Protect. You can reinitiate the transfer via Cashfree, after the blackout window or after modifying the blackout window from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login), so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree, after the blackout window or after modifying the blackout window from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login), so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | INVALID\_MODE\_FOR\_PYID | The transfer has been rejected because the payment instrument does not support this mode of transfer. You should get this mode activated on the payment instrument ID by contacting Cashfree, and then initiate a new transfer request. | You should get this mode activated on the payment instrument ID by contacting Cashfree, and then initiate a new transfer request. | Yes, after activating the mode. | | 200 | REJECTED | BENE\_BLACKLISTED | The transfer has been rejected because the beneficiary's bank account and/or VPA handles have been blacklisted by Risk team. You should get a different bank account and/or VPA to send the transfer, or you can connect with Cashfree Team to understand more about this. | You should get a different bank account and/or VPA to send the transfer, or you can connect with Cashfree Team to understand more about this. | Yes, after correcting the beneficiary details | | 200 | REJECTED | TRANSFER\_NOT\_ATTEMPTED | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | INVALID\_TRANSFER\_AMOUNT | The transfer has been rejected because the amount entered is invalid. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s) | Yes, after correcting the amount | | 200 | REJECTED | TRANSFER\_LIMIT\_BREACH | The transfer has been rejected because the amount entered breaches the limits set for your payout account. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | Yes, after adhering to the transfer limits | | 200 | REJECTED | INVALID\_PAYMENT\_INSTRUMENT | The transfer has been rejected because the payment instrument (fundsource\_id parameter in the API request) used for attempting the transfer is invalid. After correcting the payment instrument, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the payment instrument, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the payment instrument | | 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | VELOCITY\_CHECK\_FAILED | The transfer has been rejected because the amount entered breaches the limits set for your payout account. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | Yes, after adhering to the transfer limit | | 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REJECTED | DISABLED\_MODE | The transfer has been rejected because your payout account does not support this mode of transfer. You should get this mode activated on your payout account by contacting Cashfree, and then initiate a new transfer request. | You should get this mode activated on your payout account by contacting Cashfree, and then initiate a new transfer request. | Yes, after activating the mode | | 200 | REJECTED | BANK\_ACCOUNT\_INVALID | The transfer has been rejected because there is a mismatch in the Bank Account Number of the beneficiary ID and the Bank Account Number in the transfer request. After correcting the Bank Account Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the Bank Account Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the bank account number | | 200 | REJECTED | BANK\_IFSC\_INVALID | The transfer has been rejected because there is a mismatch in the IFSC of the beneficiary ID and the IFSC in the transfer request. After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the IFSC | | 200 | REJECTED | VPA\_INVALID | The transfer has been rejected because there is a mismatch in the VPA handle of the beneficiary ID and the VPA handle in the transfer request. After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the VPA handle | | 200 | REJECTED | PHONE\_INVALID | The transfer has been rejected because there is a mismatch in the Phone Number of the beneficiary ID and the Phone Number in the transfer request. After correcting the Phone Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the Phone Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the phone number. | | 200 | REJECTED | BANK\_ACCOUNT\_DETAILS\_MISSING | The transfer has been rejected because the Bank Account Details are missing in the transfer request. After adding the Bank Account Details, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After adding the Bank Account Details, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after adding the bank account details. | | 200 | REVERSED | ACCOUNT\_BLOCKED | The transfer has been reversed by the beneficiary bank as the end-beneficiary's account is blocked for receiving incoming funds. After correcting the account number or getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number or getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after adding the new details or getting the account unblocked | | 200 | REVERSED | FAILED | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | Yes | | 200 | REVERSED | NRE\_ACCOUNT\_FAIL | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account as it is an NRE Account and transfers to NRE Accounts are not supported. | Get a new account(non-NRE account) from the beneficiary; you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | No | | 200 | REVERSED | RETURNED\_FROM\_BENEFICIARY | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REVERSED | BENE\_BANK\_DECLINED | The transfer has been declined by the beneficiary bank and they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes | | 200 | REVERSED | IMPS\_MODE\_FAIL | The transfer has been reversed by the beneficiary bank because the beneficiary bank account does not support IMPS transfers. This rejection is done by the beneficiary bank for the specific beneficiary account. You can try NEFT or other channels to do the disbursals. | You can reinitiate the transfer via Cashfree by changing the mode so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after changing the mode | | 200 | REVERSED | DEST\_LIMIT\_REACHED | The transfer has been reversed by the beneficiary bank as the end-beneficiary's account has reached a limit of receiving incoming funds. This rejection is done by the beneficiary bank for the specific beneficiary account. You can reinitiate the transfer after a while via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). The success of the request is contingent on beneficiary's limit being available to receive incoming funds. | The limits on the beneficiary account are typically refreshed every 24 hours. Its not clear when the 24 hour window shall elpase so you can then reinitiate the transfer via Cashfree after some time so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time. | | 200 | REVERSED | INVALID\_ACCOUNT\_FAIL | The transfer has been reversed by the beneficiary bank because the Account Number of the beneficiary is invalid. After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account number | | 200 | REVERSED | BENE\_NAME\_DIFFERS | The transfer has been reversed by the beneficiary bank because the Account Name of the beneficiary is different. After correcting the beneficiary name, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the beneficiary name, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account name | | 200 | SUCCESS | SENT\_TO\_BENEFICIARY | The transfer has been initiated via the partner bank successfully. The request is waiting to be processed at the beneficiary bank to do the credit to the end beneficiary. | - | - | | 200 | SUCCESS | COMPLETED | The transfer has been initiated via the partner bank successfully, hence your account is debited and the request is successfully processed by the beneficiary bank and has been credited to the end beneficiary. | - | - | #### 4XX errors | HTTP Status Code | Error Code | Message | Next Action | | :--------------- | :------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | :---------------------------------------- | | 400 | batch\_transfer\_id\_missing | batch\_transfer\_id\_missing is missing in the request | Enter a batch transfer ID in the request. | | 400 | batch\_transfer\_id\_invalid | batch\_transfer\_id\_invalid should be alphanumeric | Enter a valid batch transfer ID. | | 400 | transfers\[0].transfer\_id\_invalid | transfer\_id should be alphanumeric | Enter a valid transfer ID. | | 400 | transfers\[0].transfer\_id\_missing | transfer\_id is missing in the request | Enter a transfer ID in the request. | | 400 | transfers\[0].transfer\_amount\_invalid | transfer\_amount should be greater then 1.00 | Enter an amount greater than 1.00. | | 400 | transfers\[0].transfer\_amount\_missing | transfer\_amount is missing in the request | Enter a transfer amount in the request. | | 400 | transfers\[0].transfer\_mode\_invalid | transfer\_mode is invalid allowed values are : bank, imps, neft, rtgs, upi, paytm, amazonpay, card and cardupi | Enter a valid transfer mode. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_id\_invalid | beneficiary\_id should be alphanumeric | Enter a valid beneficiary ID. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_name\_invalid | beneficiary\_name is invalid. only alphabets and whitespaces are allowed | Enter a valid beneficiary name. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.bank\_account\_number\_invalid | bank\_account\_number should be alphanumeric | Enter a valid bank account number. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.bank\_ifsc\_invalid | bank\_ifsc should be in standard ifsc format | Enter a valid IFSC. | | 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.vpa\_invalid | vpa is in invalid format | Enter a valid VPA. |
When you get a 5XX response, do not initiate another transaction.
Check the status of the batch transfer using Get Batch Transfer Status V2 and then proceed further.
Use the [Get Transfer Status V2](/api-reference/payouts/v2/transfers-v2/standard-transfer-v2) API to get the status of the batch transfer request. The Get Transfer Status V2 API does not give you the status of the batch transfer requests.
4. In the *Add Webhook* popup, enter the following information:
* **Webhook URL**: Enter the URL where you want to receive the transfer related notifications.
* **Select a webhook version**: Select **V1** from the dropdown menu.
5. Click **Test & Add Webhook**.
***
## Webhook events
Payouts webhooks enable you to receive updates about all event-driven activities originating from your account. Below is the list of payouts webhooks:
| Events | Notifications |
| :------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------- |
| [TRANSFER\_SUCCESS](/api-reference/payouts/v2/webhooks/webhooks-v1#transfer-success) | Transfer successful at the bank and account debited. |
| [TRANSFER\_FAILED](/api-reference/payouts/v2/webhooks/webhooks-v1#transfer-failed) | Sent whenever a transfer attempt fails. |
| [TRANSFER\_REVERSED](/api-reference/payouts/v2/webhooks/webhooks-v1#transfer-reversed) | Transfer reversed by the beneficiary bank. |
| [CREDIT\_CONFIRMATION](/api-reference/payouts/v2/webhooks/webhooks-v1#credit-confirmation) | Confirmation of balance credit. |
| [TRANSFER\_ACKNOWLEDGED](/api-reference/payouts/v2/webhooks/webhooks-v1#transfer-acknowledged) | After the beneficiary bank has deposited the money it confirms the transfer. |
| [TRANSFER\_REJECTED](/api-reference/payouts/v2/webhooks/webhooks-v1#transfer-rejected) | Transfer rejected by Cashfree Payments. |
| [BENEFICIARY\_INCIDENT](/api-reference/payouts/v2/webhooks/webhooks-v1#beneficiary-incident) | Sent whenever a beneficiary incident is created/resolved. |
| [LOW\_BALANCE\_ALERT](/api-reference/payouts/v2/webhooks/webhooks-v1#low-balance-alert) | Payouts recharge account low balance alert. |
| [BULK\_TRANSFER\_REJECTED](/api-reference/payouts/v2/webhooks/webhooks-v1#bulk-transfer-rejected) | One of the transfers in the batch transfer file has been rejected. |
### TRANSFER\_SUCCESS
Sent when a transfer is attempted successfully at the bank and the beneficiary account is credited.
| Parameters | Description |
| :----------- | :----------------------------------------------------------------------------------------------------- |
| event | It contains the name of the event which just occurred. Value = TRANSFER\_SUCCESS. |
| transferId | Id of the transfer passed by the merchant. |
| referenceId | Id of the transfer generated by Cashfree Payments. |
| acknowledged | The flag indicates if the beneficiary bank has acknowledged the transfer. |
| eventTime | Transfer initiation time. |
| utr | Unique transaction reference number provided by the bank. |
| signature | A unique string that helps distinguish that the request is genuine and initiated by Cashfree Payments. |
***
### What does the response parameter 'acknowledged' mean?
The acknowledged parameter value conveys if the beneficiary received the funds by checking its value. Ack = 1 or 0 . 1 denotes the beneficiary received funds, and 0 denotes the beneficiary had not received funds.
The cash flow happens as explained below:
1. Debit: The debit of the transfers happens on the remitter account. After a successful debit, the beneficiary bank does further processing. When only the debit is successful, Ack = 0.
2. Credit: The beneficiary bank credits the fund to the account. The transfer is sent from the remitter bank to the beneficiary bank after a successful debit. When the credit to the end beneficiary is successful, Ack = 1.
To confirm the status of a payout, you need to check the acknowledged parameter value. If the value is 1, you can mark the transfer as successful. However, if the value is 0, you must either wait for the TRANSFER\_ACKNOWLEDGED webhook event or use the [Get Transfer Status](/api-reference/payouts/v1/get-transfer-status-v12#get-transfer-status-v1-2) API and confirm the acknowledged value.
***
### TRANSFER\_FAILED
Sent when a transfer attempt fails.
| Parameters | Description |
| :---------- | :----------------------------------------------------------------------------------------------------- |
| event | It contains the name of the event which just occurred. Value = TRANSFER\_FAILED. |
| transferId | Id of the transfer passed by the merchant |
| referenceId | Id of the transfer generated by Cashfree Payments. |
| reason | Reason for failure. |
| signature | A unique string that helps distinguish that the request is genuine and initiated by Cashfree Payments. |
***
### TRANSFER\_REVERSED
Sent when the beneficiary bank reverses a transfer.
| Parameters | Description |
| :---------- | :------------------------------------------------------------------------------------------------------ |
| event | It contains the name of the event which just occurred. Value = TRANSFER\_REVERSED. |
| transferId | Id of the transfer passed by the merchant. |
| referenceId | Id of the transfer generated by Cashfree Payments. |
| eventTime | Time at which the transfer was reversed. |
| reason | Reason for failure. |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments. |
***
### CREDIT\_CONFIRMATION
Sent when the balance credit is confirmed.
| Parameters | Description |
| :------------ | :------------------------------------------------------------------------------------------------------ |
| event | It contains the name of the event which just occurred. Value = CREDIT\_CONFIRMATION. |
| ledgerBalance | The overall balance of ledger. |
| amount | Amount deposited. |
| utr | Unique transaction reference number provided by the bank. |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments. |
***
### TRANSFER\_ACKNOWLEDGED
Sent when the bank acknowledges a transfer.
| Parameters | Description |
| :----------- | :------------------------------------------------------------------------------------------------------ |
| event | It contains the name of the event which just occurred. Value = TRANSFER\_ACKNOWLEDGED. |
| transferId | Id of the transfer passed by the merchant. |
| referenceId | Id of the transfer generated by Cashfree Payments. |
| acknowledged | The flag which illustrates if the beneficiary bank acknowledges the transfer. |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments. |
***
### TRANSFER\_REJECTED
Sent when a transfer is rejected.
| Parameter | Description |
| :---------- | :----------------------------------------------------------------------------------------------------- |
| event | It contains the name of the event which just occurred. Value = TRANSFER\_REJECTED. |
| transferId | Id of the transfer passed by the merchant. |
| referenceId | Id of the transfer generated by Cashfree Payments. |
| reason | Reason for rejection. |
| signature | A unique string that helps distinguish that the request is genuine and initiated by Cashfree Payments. |
***
### BENEFICIARY\_INCIDENT
Sent when a beneficiary incident is created or resolved.
| Parameter | Description |
| :---------- | :------------------------------------------------------------------------------------ |
| event | It contains the name of the event which just occurred. Value = BENEFICIARY\_INCIDENT. |
| beneEntity | The entity of the beneficiary (BANK). |
| id | Identifier of the incident. |
| mode | Mode of the incident (IMPS/NEFT) |
| startedAt | Start time of the incident. |
| status | Status of the incident (ACTIVE/RESOLVED). |
| isScheduled | Scheduled or unscheduled incident (true or false). |
| severity | The severity of the incident (LOW/HIGH). |
| entityName | Name of the entity on which incident is created (Bank Name). |
| entityCode | Code of the entity on which incident is created. |
| resolvedAt | Resolution time of the incident. |
***
### LOW\_BALANCE\_ALERT
Sent when the payout balance is low.
| Parameter | Description |
| :------------- | :------------------------------------------------------------------------------------------------------ |
| event | It contains the name of the event which just occurred. Value = LOW\_BALANCE\_ALERT |
| currentBalance | The current balance of the beneficiary account |
| alertTime | Alert initiation time. |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments. |
### BULK\_TRANSFER\_REJECTED
Sent when one of the transfers in the batch transfer file has been rejected.
| Parameter | Description |
| :----------------------- | :------------------------------------------------------------------------------------------------------ |
| event | One of the transfers in the batch transfer file has been rejected |
| transferId | It is the unique ID you created to identify the transfer |
| batchTransferReferenceId | It is the ID created by Cashfree Payments for internal reference. |
| eventTime | Event initiation time |
| reason | It describes the reason for the rejection. |
| signature | A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments. |
**Delay in Receiving the Response**
Cashfree Payments receives a response from the bank with the status of the transfer instantly. At times the response may get delayed due to various reasons, and the transaction status will be marked as Pending, till we get a response.
Cashfree Payments polls the transaction status from the bank for the next 72 hours. In case we do not receive the status of a transaction after 72 hours, the transaction needs to be manually reconciled.
***
### Signature Verification
Cashfree Payments sends a signature alongside every webhook, verifying this signature ( passed along with the POST parameters ) is mandatory before processing any response. It helps authenticate that the webhook is from Cashfree Payments.
We strongly recommend whitelisting Cashfree Payments production IP to help make your communication with us more secure.
Following are the steps to verify Cashfree Payments signature:
1. Get all the POST parameters except ‘signature’ and assign it to an array as key-value pair.
2. Sort the array based on keys.
3. Concatenate all the values in this array and resultant is the post data (say, postData).
4. **postData** needs to be encrypted using SHA-256, and then base64 encoded.
5. Now verify if both the signature calculated and the signature received match.
6. Proceed further if it matches, else discards the request.
Our libraries also support signature verification. To verify the signature returned by Cashfree Payments call the following methods from the library.
Below are the code snippets that can help you verify the signature:
5. In the *Add Webhook* popup, enter the following information:
* **Webhook URL**: Enter the URL where you want to receive transfer-related notifications.
* **Select a webhook version**: Select **V2** from the dropdown menu.
## Webhook signature verification code
These code snippets provide functionality to verify the authenticity of webhook requests and parse the payload data. They ensure that incoming webhook requests are from a trusted source by checking their signature and then processing the request data.
Please ensure that the oldest active client secret is used to generate the webhook signature. Using any other client secret will lead to a signature mismatch.
Merchant onboarding and management
Create Merchant
Use this API to create and onboard a new sub-merchant account to your platform with their business details and configuration.
Get Merchant Status
Use this API to retrieve the current onboarding status and details of an existing sub-merchant account.
Update Merchant
Use this API to update sub-merchant account details and configuration after initial onboarding.
Upload Documents
Use this API to upload required KYC and business documents for merchant verification and compliance.
Create Embeddable Onboarding Link
Use this API to create a pre-built onboarding link for the sub-merchant account. Embed within your platform for KYC compliance.
Create Standard Onboarding Link
Use this API to create a pre-built onboarding link for the sub-merchant account. Requires merchant login via password or OTP for secure access.
User Management
Create PPI User
Use this API to create a new user in the PPI system with personal information required for wallet operations.
Get PPI User Details
Use this API to retrieve details of an existing user based on the user ID.
Wallet Management
Create Wallet
Use this API to create a wallet and associated sub-wallets based on a program configuration.
Credit Wallet
Use this API to credit funds to a user's sub-wallet and issue gift codes for gift wallets.
Debit Wallet
Use this API to debit an amount from a user's sub-wallet. Behaviour varies depending on the sub-wallet type.
Get Wallet Balance
Use this API to fetch total wallet and sub-wallet balances with optional filtering by specific sub-wallet.
4. The *New API Keys* popup displays with the client ID and client secret information.
5. Click **Download API Keys** to download the information and save them in your local system folder. Do not share the keys with anyone because they are confidential. You can generate a maximum of 10 API keys.
## Contact us for any queries
For identifying, diagnosing, and resolving problems related to API requests, ensure the information below is communicated while contacting us:
* Share the API request and response details along with `referenceId` or `verificationId`.
* Mention the registered email ID and environment in the email.
* Use your registered email address (with Cashfree Payments) to send the email or mention the registered email address.
* Include your account manager in the CC of the email request.
OCR and biometric verification
Face Liveness
Verify if the customer is real and detect spoofing attempts through facial analysis.
Face Match
Compare facial features between two images or validate against ID documents.
Name Match
Verify names with variations and fuzzy matching to handle different name formats and spellings.
Smart OCR
Extract and validate information from documents using advanced OCR technology.
E-sign
Create electronic signature requests for document signing and verification.
KYB (GSTIN Verification)
Know Your Business verification through GSTIN validation for comprehensive business identity verification.
Core banking services
Bank Account Verification
Verify bank account details to ensure account validity and customer name matching.
IFSC Verification
Verify IFSC codes and retrieve bank branch details for accurate banking operations.
Reverse Penny Drop
Validate bank account information through UPI-based ₹1 deposit verification method.
Video KYC
Initiate video-based KYC verification with live agent interaction for comprehensive identity validation.
Government documents
PAN Verification
Comprehensive PAN verification with PAN Lite and PAN 360 options for detailed customer information.
Driving License
Verify driving licence details including type, issue date, and expiry date.
Voter ID
Verify voter ID authenticity and retrieve constituency details using EPIC number.
Passport
Verify passport information using file number to ensure identity authenticity.
Udyam
Verify Udyam information using Udyam reference number to ensure identity authenticity.
Pan to Udyam
Verify Pan to Udyam information using Pan number to ensure identity authenticity.
Business and biometric verification
GSTIN
Verify GSTIN information to validate business registration details.
Smart OCR
Extract and validate information from documents using advanced OCR technology.
Face Liveness
Verify if the customer is real and detect spoofing attempts through facial analysis.
Face Match
Compare facial features between two images or validate against ID documents.
Digital onboarding and mobile services
1-Click Onboarding SDK
Streamline customer onboarding with mobile-based data retrieval and automated form pre-filling SDK from 15+ verified sources.
Mobile 360 Get OTP
Generate OTP for mobile-based identity verification and data retrieval for form pre-filling.
Mobile 360 Verify OTP
Verify OTP and retrieve comprehensive personal and financial data for automated form pre-filling.
Advanced Employment
Retrieve individual's employment details including member ID, joining date, and exit date.
Location and form services
Geocoding
Convert addresses into geographic coordinates for location-based verification.
Reverse Geocoding
Convert geographic coordinates into readable location information for verification purposes.
KYC Links
Generate verification forms and manage KYC link status for digital customer onboarding.
Account Aggregator
Initiate Account Aggregator services for comprehensive financial data verification.
Government documents
Driving Licence
Verify driving licence details including type, issue date, and expiry date.
Passport Verification
Verify passport information using file number to ensure identity authenticity.
Voter ID
Verify voter ID authenticity and retrieve constituency details using EPIC number.
Vehicle RC
Retrieve vehicle registration certificate details for vehicle ownership verification.
Udyam
Verify Udyam information using Udyam reference number to ensure identity authenticity.
Udyam with PAN
Fetch list of Udyam numbers associated with a PAN for business verification.
Business and employment
CIN Verification
Retrieve company information including incorporation date, director details, and CIN status.
Employment Details
Retrieve individual's employment details including member ID, joining date, and exit date.
GSTIN with PAN
Fetch list of GSTIN numbers associated with a PAN for business verification.
## Initializing SDKs
The SDK communicates with Cashfree and provides updates via the callbacks. Initialize the applicable SDK from the options below:
* [Web](#web)
* [Android native](#android-native)
* [iOS native](#ios-native)
### Web
To initiate the web SDK, pass the `sessionId` and callback functions. Refer to the JavaScript example below:
```javascript theme={"dark"}
const cf = CF1ClickOnboarding({
sessionId: newId,
successCb: successCallback,
errorCb: errorCallback,
mode: "production" // default: "sandbox"
});
const successCallback = (data) => {
console.log("Success: ", data);
};
const errorCallback = (error) => {
console.error("Error: ", error);
};
// Close the SDK programmatically
cf.closeSDK();
```
#### Importing hosted JS SDK
Include the following SDK in your HTML document for the production environment:
```html theme={"dark"}
```
` with ID `cf-sdk` is missing. |
| SUCCESS | The operation is completed successfully. |
| CLOSED | The SDK closes. |
**Notes**:
* Ensure the `
` with ID `cf-sdk` exists in your HTML.
* The SDK applies default styling for consistent behaviour; custom styling is not supported.
* The iframe uses sandboxing for secure interactions.
For detailed API documentation, refer to [1-Click Onboarding API](https://www.cashfree.com/docs/api-reference/vrs/v2/1-click-onboarding/data-availability) Integration.
# Data Availability
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/1-click-onboarding/data-availability
post /user/data-availability
Use this API to check the availability of user data. Provide the required details in the request to retrieve data availability status.
The `available_scopes` values returned in the response have a validity period of 1 hour. Ensure that user consent is obtained and submitted within this timeframe. After expiration, you must make a new API call to retrieve updated scopes.
# Fetch User Details From Access Token
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/1-click-onboarding/fetch-user-details-from-access-token
get /oauth2/user-details
Use this API to retrieve user details by providing a valid access token fetched from the OAuth Access Token Generation API. This endpoint fetches the information associated with the authenticated user.
# Initiate OAuth
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/1-click-onboarding/initiate-oauth
post /oauth2/session
Use this API to initiate the OAuth process by providing the necessary credentials to obtain the session details, which will be used to initiate the SDK.
**Notes**:
* The session ID generated by this API is valid for 1 hour.
* Get the X Client ID and X Client Secret from the [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/1-click-onboarding) when you create the app under the 1-Click section.
# OAuth Access Token Generation
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/1-click-onboarding/oauth-access-token-generation
post /oauth2/generate-token
Use this API to generate an access token after the user completes the OAuth authentication process. This token is required to access user details once the user provides consent.
> **Note**: The X Client ID and X Client Secret mentioned in this API are obtained from the [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/1-click-onboarding) when creating the app under 1-Click section.
# Aadhaar Masking
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/aadhaar/aadhaar-masking
post /aadhaar-masking
Use this API to mask the first 8 digits of your customer's aadhaar number and block the QR code (if it exists). Masking aadhaar card of your customers ensures privacy and makes it storable in your database. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#aadhaar-masking) and use the information to trigger the validations. The test data are usable only in test environments such as gamma and sandbox.
| Sub code | Status | Message | Next action |
| -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| 200 | SUCCESS | VALID | - |
| 200 | SUCCESS | INVALID\_DOCUMENT | Upload a valid copy of the aadhaar. |
| 400 | ERROR | x-client-id is missing in the request | Enter all the header information in the API request. |
| 400 | ERROR | image is missing in the request | Upload the image file of the aadhaar card that needs masking. |
| 400 | ERROR | verification\_id can include only alphanum, dot, hyphen and underscores | Only alphanumeric, period (.), hyphen (-), and underscore ( \_ ) are allowed. |
| 400 | ERROR | Client secret belongs to test environment | Enter the correct environment credentials in the request. |
| 401 | ERROR | Invalid clientId and clientSecret combination | Enter valid client ID and secret key in the request. |
| 403 | ERROR | IP not whitelisted your current IP is 106.51.91.104. For IP whitelisting assistance, visit our [IP Whitelisting guide](https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification) | Whitelist the IP address. |
| 409 | ERROR | verification ID already exists | Enter a unique verification ID. |
| 413 | ERROR | file size exceeded | The maximum file size should be 10 MB. |
| 422 | ERROR | Insufficient balance to process this request. | Ensure you have sufficient balance and then process the request. |
| 500 | ERROR | something went wrong | Try after some time. |
# Request Consent
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-consent-request
post /aa/consent
Use this API to request consent from the individual to fetch the financial information.
# Fetch Financial Information
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-fetch-fi-data
get /aa/fi
Fetch Financial Information
# Get Consent Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status
get /aa/consent
Get Consent Status
# Request Financial Information
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-request-fi
post /aa/fi
Request Financial Information
# Webhooks
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-webhook
Webhooks are server callbacks to your server from Cashfree payments.
Webhooks are event-based notifications that are received when a specific event related to the account aggregator occurs.
## Add webhooks
Add your webhook URL in our system for us to deliver webhook events.
Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/merchants/)** and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, fill in the following information:
* **Webhook URL**: Enter the URL in this field.
5. Click **Test & Add Webhook**.
## Consent webhook event
| Event | Description |
| :---------------------------------- | :------------------- |
| AA\_CONSENT\_VERIFICATION\_SUCCESS | Consent is approved. |
| AA\_CONSENT\_VERIFICATION\_PAUSED | Consent is paused. |
| AA\_CONSENT\_VERIFICATION\_REVOKED | Consent is revoked. |
| AA\_CONSENT\_VERIFICATION\_REJECTED | Consent is rejected. |
| AA\_CONSENT\_VERIFICATION\_EXPIRED | Consent has expired. |
```Text AA_CONSENT_VERIFICATION_SUCCESS theme={"dark"}
{
"event_type": "AA_CONSENT_VERIFICATION_SUCCESS",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "SUCCESS",
"consent_verification_id": "a12bc34def56789"
}
}
```
```Text AA_CONSENT_VERIFICATION_PAUSED theme={"dark"}
{
"event_type": "AA_CONSENT_VERIFICATION_PAUSED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "PAUSED",
"consent_verification_id": "a12bc34def56789"
}
}
```
```Text AA_CONSENT_VERIFICATION_REVOKED theme={"dark"}
{
"event_type": "AA_CONSENT_VERIFICATION_REVOKED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "REVOKED",
"consent_verification_id": "a12bc34def56789"
}
}
```
```Text AA_CONSENT_VERIFICATION_REJECTED theme={"dark"}
{
"event_type": "AA_CONSENT_VERIFICATION_REJECTED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "REJECTED",
"consent_verification_id": "a12bc34def56789"
}
}
```
```Text AA_CONSENT_VERIFICATION_EXPIRED theme={"dark"}
{
"event_type": "AA_CONSENT_VERIFICATION_EXPIRED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "EXPIRED",
"consent_verification_id": "a12bc34def56789"
}
}
```
## FI webhook event
| Event | Description |
| :---------------------------- | :------------------------------------------------ |
| AA\_FI\_VERIFICATION\_SUCCESS | Financial information verification is successful. |
| AA\_FI\_VERIFICATION\_ACTIVE | Financial information consent is active. |
| AA\_FI\_VERIFICATION\_FAILED | Financial information verification has failed. |
| AA\_FI\_VERIFICATION\_EXPIRED | Financial information verification has expired. |
```Text AA_FI_VERIFICATION_ACTIVE theme={"dark"}
{
"event_type": "AA_FI_VERIFICATION_ACTIVE",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "ACTIVE",
"fi_verification_id": "v1234567890abcdef",
"fi_status_response": [
{
"fip_id": "FIP_1",
"accounts": [
{
"link_ref_number": "b2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
"fi_status": "READY"
},
{
"link_ref_number": "a2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
"fi_status": "TIMEOUT"
}
]
},
{
"fip_id": "FIP_2",
"accounts": [
{
"link_ref_number": "c2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
"fi_status": "READY"
}
]
}
]
}
}
```
```Text AA_FI_VERIFICATION_SUCCESS theme={"dark"}
{
"event_type": "AA_FI_VERIFICATION_SUCCESS",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "SUCCESS",
"fi_verification_id": "v1234567890abcdef",
}
}
```
```Text AA_FI_VERIFICATION_FAILED theme={"dark"}
{
"event_type": "AA_FI_VERIFICATION_FAILED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "FAILED",
"fi_verification_id": "v1234567890abcdef",
}
}
```
```Text AA_FI_VERIFICATION_EXPIRED theme={"dark"}
{
"event_type": "AA_FI_VERIFICATION_EXPIRED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"status": "EXPIRED",
"fi_verification_id": "v1234567890abcdef",
}
}
```
## Webhook signature
You will receive the webhook signature in the webhook header. Here is a sample header from a webhook request.
| Header Name | Header Value |
| ------------------- | :------------------------------------------: |
| content-length | 1099 |
| x-webhook-attempt | 1 |
| content-type | application/json |
| x-webhook-signature | 07r5C3VMwsGYeldGOCYxe5zoHhIN1zLfa8O0U/yngHI= |
| x-webhook-timestamp | 1746427759733 |
Always capture the webhook payload in its raw text format before parsing into JSON. Parsing and re-serialising the payload can change the structure (for example, array ordering, spacing, or `null` handling) and cause a signature mismatch during verification. Use the exact raw body string from the request when computing the signature.
## Webhook payload fields
The webhook payload contains important metadata in its top-level fields.
| Field | Type | Description |
| ------------ | -------- | --------------------------------------------------------------------------------------------- |
| `event_type` | `string` | Indicates the type of event that triggered the webhook. |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`). |
| `version` | `string` | Indicates the webhook format being used. Default version is "v1". |
| `data` | `object` | Contains event-specific details related to this feature. |
Verifying the signature is mandatory before processing any response. Refer to [Signature Verification](/api-reference/vrs/webhook-signature-verification#webhook-signature-verification) for more details.
# Overview
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/overview
Learn about Account Aggregator
## Entities involved
* **Account aggregator (AA)**
An Account Aggregator is an intermediary entity that facilitates the collection and aggregation of financial data from various Financial Information Providers (FIPs) and provides it to Financial Information Users (FIUs).
* **Financial Information Provider (FIP)**
FIPs are financial institutions or organisations that hold financial data. These could include banks, credit unions, investment firms, and other entities that provide financial services.\\
* **Financial Information User (FIU)**
FIUs are entities or applications that use the aggregated financial data. They could be financial management apps, credit scoring services, or investment platforms.
### How they work?
1. **Consent Request:** The Account Aggregator APIs first request user consent to access their financial data from Financial Information Providers (FIPs).
2. **User Consent:** For an FIU to access data from an FIP, the end-user must provide consent. Users authenticate their accounts and authorise the API to retrieve their information.
3. **Data Collection:** Once consent is granted, the APIs connect directly to FIPs to collect financial data, such as account balances and transaction histories.
4. **Data Aggregation:** The APIs consolidate data from various FIPs into a unified format, making it easier to manage and analyse.
5. **Secure Transfer**: The Account Aggregator APIs ensure the secure transmission of data between FIPs and Financial Information Users (FIUs), using encryption and other security measures to protect sensitive information.
6. **Service Integration:** Financial Information Users (FIUs) receive the aggregated data through the API. They leverage this data to provide enhanced financial services, such as budgeting tools, investment analysis, and credit scoring.
## Account Aggregator APIs
With Cashfree Payments, you can securely access and aggregate financial data from various accounts and institutions. Utilise our APIs to collect data such as bank account balances, transaction history, investment portfolios, and more, from multiple sources in one place. They simplify the process of connecting to financial institutions by providing a standardised way to retrieve data, making it easier for developers to build applications that involve financial information.
| API | Description |
| :------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |
| [Request Consent](/api-reference/vrs/v2/account-aggregator/account-aggregator-consent-request) | Use this API to request consent from the individual to fetch the financial information. |
| [Get Consent Status](/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status) | Use this API to get the status of the consent request. |
| [Request Financial Information](/api-reference/vrs/v2/account-aggregator/account-aggregator-request-fi) | Use this API to request the financial information of the consented individual. |
| [Fetch Financial Information](/api-reference/vrs/v2/account-aggregator/account-aggregator-fetch-fi-data) | Use this API to fetch the financial information of the consented individual. |
## Use case scenario
A financial advisory firm, X, offers a digital platform that provides personalised financial planning and investment advice. To deliver accurate and tailored advice to clients, X leverages Cashfree Payments' Account Aggregator APIs to access and aggregate financial data.
### Steps involved
1. **Client onboarding**
Preethi signs up for X's financial planning service. To create a plan, X requires access to Preethi's complete financial data.
2. **Consent request**
X uses Cashfree Payments' Account Aggregator APIs to request Preethi's consent to access her financial data. X specifies what kind of financial information they require in the **[Request Consent](/api-reference/vrs/v2/account-aggregator/account-aggregator-consent-request)** API. The API directs Preethi to authenticate with her bank and other financial institutions to grant permission.
3. **Data collection**
Once Preethi provides consent, the **[Request Financial Information](/api-reference/vrs/v2/account-aggregator/account-aggregator-request-fi)** API connects to her various financial accounts and retrieves relevant data such as account balances, transaction histories, income statements, and investment holdings.
4. **Data Aggregation**
Cashfree Payments consolidates this data into a standardised format and X can view them using **[Fetch Financial Information](/api-reference/vrs/v2/account-aggregator/account-aggregator-request-fi)**. This allows the firm to view Preethi’s complete financial profile in one place.
5. **Financial Analysis**
X’s platform analyses the aggregated data to assess Preethi’s financial health. This includes evaluating her spending patterns, savings, investment performance, and overall financial situation.
6. **Personalised Recommendations**
Based on the analysis, X generates tailored financial advice and investment recommendations for Preethi. This might include budgeting strategies, savings goals, investment opportunities, and retirement planning tips.
7. **Client Review and Feedback**
Preethi reviews the personalised financial plan and recommendations through X's platform. She can provide feedback, ask questions, and make adjustments to her financial strategy based on the advice received.
# Get Employment Details
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/advanced-employment/get-employment-details
post /advance-employment
Use this API to to retrieve an individual's recent employment details such as member ID, joining date, and exit date of the company. Verifying the employment information of the individual mitigates risk and prevents fraud. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#employment-information) and use the information to trigger the validations. The test data are usable only in the sandbox environment.
# Bank Account Verification Async V2
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bank-account-verification-async-v2
post /bank-account/async
Use this API to verify bank account information. It is an aysnc request. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. You can use the test data only in sandbox environment.
* Cashfree does not support the verification of Deutsche Bank and Paytm Payments Bank accounts.
* For further queries, please refer to the [Bank Account Verification FAQs](https://www.cashfree.com/docs/secure-id/kyc-stack/verify-bank-account#faqs).
# Bank Account Verification Sync V2
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bank-account-verification-sync-v2
post /bank-account/sync
Use this API to do bank account verification in sync. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. You can use the test data only in sandbox environment.
* Cashfree does not support the verification of Deutsche Bank and Paytm Payments Bank accounts.
* For further queries, please refer to the [Bank Account Verification FAQs](https://www.cashfree.com/docs/secure-id/kyc-stack/verify-bank-account#faqs).
* IMPS verifies only the first five characters of the IFSC code, which represent the bank. It does not verify the remaining six characters that identify the branch.
# BAV Response Description
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bav-response-description
## account\_status
It displays the status of the bank account.
| STATUS | DESCRIPTION |
| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- |
| `VALID` | The account is successfully verified. |
| `INVALID` | The account is invalid. |
| `RECEIVED` | The transaction request has been successfully received and awaits processing or verification. |
| `FAILED` | The transaction failed due to an error or issue on the bank's side. |
| `REJECTED` | The transaction was rejected, typically due to issues such as insufficient funds. |
| `APPROVAL_PENDING` | This status indicates that the verification process is awaiting merchant approval of the submitted files to proceed further. |
| `PARTIALLY_APPROVED` | This status indicates that some of the submitted data or files have been approved for verification. |
| `IN_PROCESS` | This status indicates that the request is currently under validation, and the verification process is actively ongoing. |
| `CANCELLED` | This status indicates that the request was terminated by the user and will not proceed further. |
| `PROCESSING` | This status indicates that the request is being actively handled, and the system is working on completing the verification or transaction. |
| `MANUALLY_REJECTED` | This status indicates that the request was explicitly reviewed and rejected by a user. |
## account\_status\_code
| STATUS | DESCRIPTION |
| :----------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ACCOUNT_IS_VALID` | Bank account has been successfully verified. |
| `FRAUD_ACCOUNT` | Fraudulent activity has been detected involving the bank account and IFSC. As a precautionary measure, both the account and IFSC have been blocked to prevent future transactions. To request unblocking, please contact your account manager or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1). |
| `FAILED_AT_BANK` | The transaction failed due to an error or issue at the bank's end. |
| `NPCI_UNAVAILABLE` | The transaction could not be processed because the NPCI (National Payments Corporation of India) service is currently unavailable. |
| `CONNECTION_TIMEOUT` | The transaction failed due to a timeout while trying to establish a connection with the bank. |
| `SOURCE_BANK_DECLINED` | The transaction was declined by the source bank due to issues at their end. |
| `BENE_BANK_DECLINED` | The transaction was declined by the bene bank due to issues at their end. |
| `IMPS_MODE_FAIL` | The transaction failed because it could not be processed through the IMPS mode. |
| `BENEFICIARY_BANK_OFFLINE` | The transaction could not be processed because the beneficiary's bank is currently offline or unreachable. |
| `VALIDATION_IN_PROGRESS` | The transaction is currently being validated and is awaiting confirmation. |
| `INVALID_ACCOUNT_FAIL` | The transaction failed because the provided account details are invalid. |
| `INVALID_IFSC_FAIL` | The transaction failed because the provided IFSC code is invalid or incorrect. |
| `VERIFICATION_ALREADY_UNDER_PROCESS` | The verification is already in progress, and another verification request cannot be processed at this time. |
| `NRE_ACCOUNT_FAIL` | The transaction failed because the account is a Non-Resident External (NRE) account, which is not supported for this transaction type. |
| `ACCOUNT_BLOCKED` | The transaction failed because the account is blocked and cannot process transactions. |
| `INSUFFICIENT_BALANCE` | The transaction failed due to insufficient funds in the merchant account for processing the transaction. |
## name\_match\_result
It displays the result of the name match verification. Name match verification is done against the name provided in the request and the name associated with the bank account.
| STATUS | DESCRIPTION |
| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `DIRECT_MATCH` | Indicates that the name provided in the request matches exactly with the name associated with the bank account. |
| `GOOD_PARTIAL_MATCH` | Indicates a strong similarity between the provided name and the name associated with the bank account, with minor differences. |
| `MODERATE_PARTIAL_MATCH` | Indicates a noticeable similarity between the provided name and the name associated with the bank account, but with more significant variations or missing details. |
| `POOR_PARTIAL_MATCH` | Indicates a weak similarity between the provided name and the name associated with the bank account, suggesting a potential mismatch but with some common elements. |
| `NO_MATCH` | Indicates that there is no recognisable similarity between the provided name and the name associated with the bank account, or the names are entirely different. |
Example of name\_match\_result.
| Given Name | Name at bank | Match Score | Match Result | Account Number |
| :--------- | :----------- | :---------- | :----------------------- | :-------------- |
| JOHN DOE | john doe | 100.00 | DIRECT\_MATCH | 026291800001191 |
| JOHN DOE | john d | 85.00 | GOOD\_PARTIAL\_MATCH | 026291800001191 |
| JOHN DOE | j doe | 70.00 | MODERATE\_PARTIAL\_MATCH | 026291800001191 |
| JOHN DOE | jane d | 38.00 | POOR\_PARTIAL\_MATCH | 026291800001191 |
| TOM WELLS | tom wells | 100.00 | DIRECT\_MATCH | 1233943142 |
| TOM WELLS | tom w | 85.00 | GOOD\_PARTIAL\_MATCH | 1233943142 |
| TOM WELLS | t wells | 70.00 | MODERATE\_PARTIAL\_MATCH | 1233943142 |
| TOM WELLS | tim lee | 38.00 | POOR\_PARTIAL\_MATCH | 1233943142 |
| BOB HOPE | bob hope | 100.00 | DIRECT\_MATCH | 388108022658 |
| BOB HOPE | bob h | 85.00 | GOOD\_PARTIAL\_MATCH | 388108022658 |
| BOB HOPE | b hope | 70.00 | MODERATE\_PARTIAL\_MATCH | 388108022658 |
| BOB HOPE | bane hue | 38.00 | POOR\_PARTIAL\_MATCH | 388108022658 |
# Bulk Bank Account Verification V2
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bulk-bank-account-verification-v2
post /bank-account/bulk
Use this API to verify bank account information in bulk. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. You can use the test data only in sandbox environment.
* Cashfree does not support the verification of Deutsche Bank and Paytm Payments Bank accounts.
* For further queries, please refer to the [Bank Account Verification FAQs](https://www.cashfree.com/docs/secure-id/kyc-stack/verify-bank-account#faqs).
# Get BAV Status V2
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/get-bav-status-v2
get /bank-account
Use this API to get the details of the bank account verification request. You need to enter either the reference ID or user ID.
* Cashfree does not support the verification of Deutsche Bank and Paytm Payments Bank accounts.
* For further queries, please refer to the [Bank Account Verification FAQs](https://www.cashfree.com/docs/secure-id/kyc-stack/verify-bank-account#faqs).
# Get Bulk BAV Status V2
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/get-bulk-bav-status-v2
get /bank-account/bulk
Use this API to get the details of the bulk bank account verification request. You need to enter either the bulk reference ID or bulk validation ID. If you want to get the status of a single entry, enter the particular reference ID in the request.
* Cashfree does not support the verification of Deutsche Bank and Paytm Payments Bank accounts.
* For further queries, please refer to the [Bank Account Verification FAQs](https://www.cashfree.com/docs/secure-id/kyc-stack/verify-bank-account#faqs).
# Webhooks
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/webhooks-bank-account-verification
Webhooks are server callbacks to your server from Cashfree payments.
Webhooks are event-based notifications that are received when a specific event related to async bank account verification occurs.
In rare cases, such as network retries, read timeouts, processing delays, or delivery failures, the same webhook might be sent more than once for the same event. To prevent unintended side effects, implement idempotency in your webhook handler to handle duplicate deliveries.
## Add webhooks
Add your webhook URL in our system for us to deliver webhook events.
Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/merchants/)** and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, fill in the following information:
* **Webhook URL**: Enter the URL in this field.
5. Click **Test & Add Webhook**.
## Webhook event
| Event | Description |
| :------------------------------------ | :-------------------------------------- |
| BANK\_ACCOUNT\_VERIFICATION\_SUCCESS | Bank account verification is a success. |
| BANK\_ACCOUNT\_VERIFICATION\_REJECTED | Bank account verification is rejected. |
| BANK\_ACCOUNT\_VERIFICATION\_FAILED | Bank account verification is a failure. |
```Text BANK_ACCOUNT_VERIFICATION_SUCCESS theme={"dark"}
{
"signature":"signature",
"event_type":"BANK_ACCOUNT_VERIFICATION_SUCCESS",
"event_time":"2023-07-19 10:46:16",
"version":"v2",
"data":{
"reference_id": 1294785793,
"user_id" : "123123",
"name_at_bank": "John Doe",
"amount_deposited": "1.04",
"bank_name": "YES BANK",
"utr": "404223241811",
"city": "MUMBAI",
"branch": "SANTACRUZ, MUMBAI",
"micr": 400532038,
"name_match_score": "90.00",
"name_match_result": "GOOD_PARTIAL_MATCH",
"account_status": "VALID",
"account_status_code": "ACCOUNT_IS_VALID"
}
}
```
```Text BANK_ACCOUNT_VERIFICATION_REJECTED theme={"dark"}
{
"signature":"signature",
"event_type":"BANK_ACCOUNT_VERIFICATION_REJECTED",
"event_time":"2023-07-19 10:46:16",
"version":"v2",
"data":{
"reference_id": 1294785793,
"user_id" : "123123",
"account_status": "REJECTED",
"account_status_code": "INSUFFICIENT_BALANCE"
}
}
```
```Text BANK_ACCOUNT_VERIFICATION_FAILED theme={"dark"}
{
"signature":"signature",
"event_type":"BANK_ACCOUNT_VERIFICATION_FAILED",
"event_time":"2023-07-19 10:46:16",
"version":"v2",
"data":{
"reference_id": 1294785793,
"user_id" : "123123",
"account_status": "FAILED",
"account_status_code": "SOURCE_BANK_DECLINED"
}
}
```
## Webhook payload fields
The webhook payload contains important metadata in its top-level fields.
| Field | Type | Description |
| ------------ | -------- | ---------------------------------------------------------------------------------------------- |
| `signature` | `string` | A Base64-encoded HMAC-SHA256 signature of the payload, generated using a shared client secret. |
| `event_type` | `string` | Indicates the type of event that triggered the webhook. |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`). |
| `version` | `string` | Indicates the webhook format being used. Default version is "v1". |
| `data` | `object` | Contains event-specific details related to this feature. |
## Signature Verification
Verifying the signature is mandatory before processing any response. It helps authenticate that the webhook is from Cashfree Payments.
Follow the steps to verify the signature:
1. Sort the array based on keys.
2. Concatenate all the values in this array and the resultant is the post data (**postData**).
3. **postData** needs to be encrypted using SHA-256 and then base64 encoded.
4. Verify if both the signature calculated and the signature received match.
5. Proceed further only if the signatures match. If not, discard the request.
6. Ensure **clientSecret** you use is from the oldest active key pair.
For example, from the webhook received, extract the data and pass it to generate HMAC function:
```
{bank_account=026291800001191, ifsc=YESB0000262, upi=, name_at_bank=John Doe,
verification_id=fadsfdsf, ref_id=332, utr=332, status=SUCCESS,
added_on=2023-09-06T07:48:53+05:30, processed_on=2023-09-06 07:49:03,
penny_collected_on=2023-09-06 07:48:53}
```
```Text Java code - for reference theme={"dark"}
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.util.Map;
import java.util.TreeMap;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.codec.binary.Base64;
public class ComputedSignature {
public static String generateHMAC(String clientSecret, String data) {
String hash = null;
ObjectMapper objectMapper = new ObjectMapper();
try {
Map jsonMap = objectMapper.readValue(data, new TypeReference>() {
});
Map sortedMap = new TreeMap<>(jsonMap);
// sort the map based on keys
String postDataString = "";
for (Map.Entry entry : sortedMap.entrySet()) {
postDataString = postDataString + entry.getValue();
}
// encode the post data on sha256
Mac sha256HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secretKey = new SecretKeySpec(clientSecret.getBytes(), "HmacSHA256");
sha256HMAC.init(secretKey);
hash = Base64.encodeBase64String(sha256HMAC.doFinal(postDataString.getBytes()));
} catch (Exception e) {
e.printStackTrace();
}
return hash;
}
}
```
## IPs to whitelist
When you decide to consume the webhooks, first, you need to verify if your systems need an IP whitelisting to be done at your end or not. Accordingly you can whitelist the below IPs of Cashfree:
| Sandbox |
| :------------ |
| 52.66.25.127 |
| 15.206.45.168 |
| Prod |
| :------------ |
| 52.66.101.190 |
| 3.109.102.144 |
| 3.111.60.173 |
| 18.60.134.245 |
| 18.60.183.142 |
| Port |
| :------------ |
| 443 (secured) |
# Verify CIN
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/cin/verify-cin
post /cin
Use this API to retrieve information from CIN such as business incorporation date, director(s) details, CIN status, and more. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#cin) and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.
# Create URL
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/create-digilocker-url
post /digilocker
Use this API to create a DigiLocker URL to retrieve and verify Aadhaar, PAN, and driving-license information of your customer.
# DigiLocker Integration
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/digilocker-integration
Cashfree’s DigiLocker integration enables businesses to seamlessly retrieve and verify government-issued documents through DigiLocker.
This guide walks you through the steps to integrate Cashfree’s DigiLocker APIs into your application. With this integration, you can securely access user-consented documents such as Aadhaar, PAN, driving licence, and other records, improving onboarding speed and ensuring regulatory compliance.
DigiLocker access is strictly based on user consent and is compliant with the Digital Personal Data Protection Act (DPDPA), 2023.
## DigiLocker verification flow
Follow the steps below to verify your customers using DigiLocker:
### 1. Verify DigiLocker account
Use the [Verify Account API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/verify-digilocker-account) to check whether the user’s Aadhaar number or mobile number is linked with a DigiLocker account.
* If an account exists, continue with the sign-in flow.
* If not, continue with the sign-up flow.
### 2. Generate DigiLocker link
Use the [Create URL API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/create-digilocker-url) to generate a DigiLocker consent URL.
* Cashfree returns a unique, time-sensitive URL for DigiLocker login and document-consent sharing.
* The URL is valid for 10 minutes from the time of generation.
### 3. Redirect to consent URL
* Redirect the customer to the DigiLocker URL (in browser or WebView).
* The customer logs in using their Aadhaar number or Aadhaar-linked mobile number and enters the OTP.
* On successful login, DigiLocker shows a consent screen.
* The user reviews and approves the document-sharing request.
### 4. Check verification status
Use the [Get Verification Status API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-digilocker-verification-status) with the `verification_id` or `reference_id` to retrieve the current status.
Possible status values:
* `PENDING`: User hasn't completed the verification process.
* `AUTHENTICATED`: User has logged in and given consent.
* `EXPIRED`: Link expired before the process was completed.
* `CONSENT_DENIED`: When user rejects or denies consent.
### 5. Retrieve document
Once the user has successfully logged in and provided consent, call the [Get Document API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-document-from-digilocker) to fetch verified documents like Aadhaar, PAN, or driving license.
## Aadhaar via DigiLocker flow
The Aadhaar via DigiLocker flow allows businesses to securely retrieve Aadhaar documents by verifying users through their DigiLocker accounts. Follow the below steps to fetch the required details:
1. The user selects Aadhaar via DigiLocker on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. The user enters their Aadhaar number.
3. The system checks if a DigiLocker account exists using the [Verify Account API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/verify-digilocker-account).
* If account exists → Sign-in flow.
* If not → Sign-up flow.
* **Sign-up flow**: This is a PIN-based flow where the user must set a DigiLocker PIN. If the DigiLocker account already exists, the user is required to enter their existing PIN.
* **Sign-in flow**: Also referred to as the PIN-less flow, where the user can complete the login using only an OTP.
### Sign-in flow
The sign-in flow enables users with an existing DigiLocker account to log in using their Aadhaar-linked credentials and provide consent to share documents. Steps are as follows:
1. Call the `Create URL API` to generate the login consent link.
2. User logs in using Aadhaar and OTP.
3. User provides consent on DigiLocker.
4. Use `Get Verification Status API` to confirm.
5. Retrieve Aadhaar data using the `Get Document API`.
### Sign-up flow
The sign-up flow guides users without an existing DigiLocker account to create one, set a PIN, and provide consent to share their Aadhaar documents. Steps are as follows:
1. Call the `Create URL API` to generate sign-up consent link.
2. User lands on the Digilocker page and enters the OTP.
3. User sets DigiLocker PIN in case of new account is being created and if account exists, user resets PIN via OTP.
4. User provides document-sharing consent.
5. Use `Get Verification Status API` to confirm.
6. Retrieve Aadhaar document using the `Get Document API`.
## Webhook support
You will receive [webhooks](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/webhooks-digilocker) for every stage of the DigiLocker verification lifecycle, including status updates and completion callbacks.
## Summary
Provides a summary of all APIs involved in the flow:
| Step | API used | Description |
| ---- | --------------------------- | --------------------------------------------------------------- |
| 1 | Verify Account API | Checks if Aadhaar is linked with DigiLocker |
| 2 | Create URL API | Generates DigiLocker consent URL |
| 3 | Get Verification Status API | Checks status: PENDING, AUTHENTICATED, EXPIRED, CONSENT\_DENIED |
| 4 | Get Document API | Fetches verified user documents |
## Edge cases
Provides a summary of edge cases involved in the flow:
| **Step** | **Edge case** | **Scenario** | **Root cause** | **Resolution** |
| -------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1 | **`eaadhaar` not available in DigiLocker** | The `eaadhaar` field in the API response returns 'N'. | Indicates that the user’s Aadhaar document isn't currently available in their DigiLocker account. | Instruct the user to log in to DigiLocker and complete their profile by linking their Aadhaar. Once linked, fetch the document using the [Get Document API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-document-from-digilocker). |
| 2 | **`Can be accessed` label appears on consent screen** | The DigiLocker consent screen displays the label `Can be accessed` next to a document. | Indicates that the document isn't currently present in the user’s DigiLocker. This status implies that while the document is eligible to be linked, it hasn't yet been fetched or issued to the account. | Instruct the user to log in to DigiLocker and link the issued document manually from the issuing authority. Once linked, retrieve the document using the [Get Document API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-document-from-digilocker). |
# React Native Integration
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/digilocker-sdk
Learn more about integrating Cashfree SDK in your react native application.
Cashfree’s react native DigiLocker SDK allows you to seamlessly integrate DigiLocker-based identity verification into your mobile application. With this SDK, you can securely initiate DigiLocker flows, collect user consent, and retrieve verified government-issued documents.
This guide provides step-by-step instructions to help you:
* Install and configure the React Native SDK.
* Generate DigiLocker consent URLs from your backend.
* Launch DigiLocker in your React Native app.
* Handle consent flows and user responses.
* Fetch and verify user documents via secure APIs.
All sensitive operations such as generating DigiLocker URLs and retrieving documents, must be performed on your backend server. Don't call these APIs directly from your frontend or mobile application.
## Setting up SDK
The React Native SDK is hosted on [npm](https://www.npmjs.com/). You can get the latest SDK [here](https://www.npmjs.com/package/@cashfreepayments/react-native-digilocker).
Our React Native SDK supports Android SDK version 19 and above and iOS minimum deployment target of 10.3 and above.
Navigate to your project and run the following command:
```npm npm theme={"dark"}
npm install @cashfreepayments/react-native-digilocker
```
```yarn yarn theme={"dark"}
yarn add @cashfreepayments/react-native-digilocker
```
For iOS, you need to install pods:
```
cd ios && pod install
```
### Step 1: Create DigiLocker URL
To initiate the DigiLocker integration flow, your application must generate a DigiLocker consent URL.
This action must be performed from your backend server, as it requires authentication using your Client Secret. Don't call this API directly from your frontend or mobile application.
Once the DigiLocker URL is successfully generated, the API returns a unique reference\_id. Either this reference\_id or the verification\_id passed by you can be used in all the subsequent API calls.
You can view the complete request and response examples in the [Create DigiLocker URL](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/create-digilocker-url) API reference.
### Step 2: Opening the DigiLocker SDK
Once the DigiLocker URL is created, the next step is to open the DigiLocker URL so the user can give the consent. The React Native SDK offer below digilocker redirection flow:
#### Initialise app
```jsx theme={"dark"}
import { DigiLockerProvider } from '@cashfreepayments/react-native-digilocker';
function App() {
return (
{/* Your app content */}
);
}
```
### Step 3: Call verify function to initiate DigiLocker flow
```ts theme={"dark"}
const { verify } = useDigiLocker();
verify(
url: string, // DigiLocker URL to load
redirectUrl?: string, // Optional redirect URL (default: 'https://verification.cashfree.com/dgl/status')
options?: {
userFlow?: 'signin' | 'signup'; // Optional user flow type (restricted to 'signin' or 'signup')
onSuccess?: (data: any) => void; // Success callback
onError?: (error: string) => void; // Error callback
onCancel?: () => void; // Cancel callback
}
);
```
**Success callback**
```javascript theme={"dark"}
{
success: true,
redirect_url: 'https://example.com/thank-you?verification_id=123'
}
```
You can view the example implementation in the [DigiLocker React Native SDK](https://github.com/cashfree/react-native-digilocker/blob/master/example/src/App.tsx) GitHub repository.
### Step 4: Check verification status
Use the [Get Verification Status API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-digilocker-verification-status) with the `verification_id` received in the success callback to retrieve the current verification status.
### Step 5: Retrieve document
Once the user has successfully logged in and provided consent, call the [Get Document API](https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-document-from-digilocker) to fetch verified documents like Aadhaar, PAN, or driving license.
Steps 4 and 5 must be performed from your backend server. Don't call this APIs directly from your frontend or mobile application.
# Get Verification Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-digilocker-verification-status
get /digilocker
Use this API to get the status of the DigiLocker verification. You need to enter either the verification ID or reference ID.
# Get Document
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/get-document-from-digilocker
get /digilocker/document/{document_type}
Use this API to get your customer's document details from DigiLocker.
Currently we do not support downloading of full documents through Digilocker API. This feature will be added in the future enhancements.
# Verify Account
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/verify-digilocker-account
post /digilocker/verify-account
Use this API to verify whether a mobile number or Aadhaar number is already registered with DigiLocker. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#digilocker-verify-account) and use the information to trigger the validations. The test data are usable only in test environments such as sandbox.
# DigiLocker Webhooks
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/webhooks-digilocker
Webhooks are server callbacks to your server from Cashfree payments.
Webhooks are event-based notifications that are received when a specific event related to the DigiLocker verification occurs.
In rare cases, such as network retries, read timeouts, processing delays, or delivery failures, the same webhook might be sent more than once for the same event. To prevent unintended side effects, implement idempotency in your webhook handler to handle duplicate deliveries.
## Add webhooks
Add your webhook URL in our system for us to deliver webhook events.
Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/merchants/) and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, enter the webhook URL.
5. Click **Test & Add Webhook**.
## Webhook event
| Event Type | Description |
| :---------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
| `DIGILOCKER_VERIFICATION_SUCCESS` | Triggered when the user's DigiLocker verification is successfully completed. |
| `DIGILOCKER_VERIFICATION_LINK_EXPIRED` | Triggered when the DigiLocker URL expires due to user inaction. |
| `DIGILOCKER_VERIFICATION_CONSENT_DENIED` | Triggered when the user denies consent for DigiLocker verification. |
| `DIGILOCKER_VERIFICATION_CONSENT_EXPIRED` | Triggered when the user's document consent for DigiLocker verification expires, which occurs 1 hour after the user grants consent. |
| `DIGILOCKER_VERIFICATION_FAILURE` | Triggered when the DigiLocker verification fails due to a system error. |
### Sample webhook events
The following are examples of webhook events that you may receive.
```Text SUCCESS theme={"dark"}
{
"event_type":"DIGILOCKER_VERIFICATION_SUCCESS",
"event_time":"2006-01-02T15:04:05Z",
"version":"v1",
"data":{
"user_details": {
"name": "John Doe",
"dob": "02-02-1995",
"gender": "M",
"eaadhaar": "Y",
"mobile": "9999999999"
},
"status": "AUTHENTICATED",
"document_requested": [
"AADHAAR",
"PAN",
"DRIVING_LICENSE"
],
"document_consent": [
"AADHAAR",
"PAN",
"DRIVING_LICENSE"
],
"verification_id": "ABC00123",
"reference_id": 12345
}
}
```
```Text LINK_EXPIRED theme={"dark"}
{
"event_type":"DIGILOCKER_VERIFICATION_LINK_EXPIRED",
"event_time":"2006-01-02T15:04:05Z",
"version":"v1",
"data":{
"user_details": {},
"status": "EXPIRED",
"document_requested": [
"AADHAAR"
],
"document_consent": null,
"verification_id": "ABC00123",
"reference_id": 12345
}
}
```
```Text CONSENT_DENIED theme={"dark"}
{
"event_type":"DIGILOCKER_VERIFICATION_CONSENT_DENIED",
"event_time":"2006-01-02T15:04:05Z",
"version":"v1",
"data":{
"user_details": {},
"status": "CONSENT_DENIED",
"document_requested": [
"AADHAAR"
],
"document_consent": null,
"verification_id": "ABC00123",
"reference_id": 12345
}
}
```
```Text CONSENT_EXPIRED theme={"dark"}
{
"event_type":"DIGILOCKER_VERIFICATION_CONSENT_EXPIRED",
"event_time":"2006-01-02T15:04:05Z",
"version":"v1",
"data":{
"user_details": {
"name": "John Doe",
"dob": "02-02-1995",
"gender": "M",
"eaadhaar": "Y",
"mobile": "9999999999"
},
"status": "AUTHENTICATED",
"document_requested": [
"AADHAAR",
"PAN",
"DRIVING_LICENSE"
],
"document_consent": [
"AADHAAR",
"PAN",
"DRIVING_LICENSE"
],
"verification_id": "ABC00123",
"reference_id": 12345
}
}
```
```Text FAILURE theme={"dark"}
{
"event_type":"DIGILOCKER_VERIFICATION_FAILURE",
"event_time":"2006-01-02T15:04:05Z",
"version":"v1",
"data":{
"user_details": {},
"status": "FAILURE",
"document_requested": [
"AADHAAR"
],
"document_consent": null,
"verification_id": "ABC00123",
"reference_id": 12345
}
}
```
## Webhook signature
You will receive the webhook signature in the webhook header. Here is a sample header from a webhook request.
| Header Name | Header Value |
| ------------------- | :------------------------------------------: |
| content-length | 1099 |
| x-webhook-attempt | 1 |
| content-type | application/json |
| x-webhook-signature | 07r5C3VMwsGYeldGOCYxe5zoHhIN1zLfa8O0U/yngHI= |
| x-webhook-timestamp | 1746427759733 |
Always capture the webhook payload in its raw text format before parsing into JSON. Parsing and re-serialising the payload can change the structure (for example, array ordering, spacing, or `null` handling) and cause a signature mismatch during verification. Use the exact raw body string from the request when computing the signature.
## Webhook payload fields
The webhook payload contains important metadata in its top-level fields.
| Field | Type | Description |
| ------------ | -------- | --------------------------------------------------------------------------------------------- |
| `event_type` | `string` | Indicates the type of event that triggered the webhook. |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`). |
| `version` | `string` | Indicates the webhook format being used. Default version is "v1". |
| `data` | `object` | Contains event-specific details related to this feature. |
Verifying the signature is mandatory before processing any response. Refer to [Signature Verification](/api-reference/vrs/webhook-signature-verification) for more details.
# Authentication
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/docs/authentication
Calling the Authentication APIs allows you to get and verify bearer tokens returned by Cashfree Payments. We require this token for all further communication.
We do not support connected fund source accounts with respect to the Secure ID products.
## General instructions
* Cashfree Payments' libraries automatically call the Authorize API and internally store the token.
* Do not store the token in an insecure manner.
* Regenerating a new token does not invalidate the already generated token.
* Token generated from one IP address cannot be used from a different IP.
* Token generated is valid for 600 seconds. Please ensure that you recall the authorize API once the token has expired.
## IP Whitelisting and Public Key
Whitelist your IP address. Follow the instructions listed here to whitelist your IP address.
To add the public key in the code snippet, ensure you read the file directly and not copy paste it. Copy pasting the public key turns out to be erroneous.
# Verify Driving Licence Details
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/driving-license/verify-driving-licence-details
post /driving-license
Use this API to verify the driving license of your customer. We retrieve details of the driving licence that includes the type of licence, issue date, expiry date, and more. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#driving-licence) and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.
# Create E-Sign Request
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/e-sign/create-e-sign-request
post /esignature
Use this API to add the details of the document and signer(s) to initiate e-sign verification.
# Get E-Sign Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/e-sign/get-e-sign-status
get /esignature
Use this API to get the status of the initiated e-sign verification. You need to enter either the verification ID or reference ID.
# Upload Document For E-Sign
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/e-sign/upload-document-for-e-sign
post /esignature/document
Use this API to upload the document before creating the request for signing the document.
# Webhooks
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/e-sign/webhooks-esign
Webhooks are server callbacks to your server from Cashfree payments.
Webhooks are event-based notifications that are received when a specific event related to the e-sign verification occurs.
In rare cases, such as network retries, read timeouts, processing delays, or delivery failures, the same webhook might be sent more than once for the same event. To prevent unintended side effects, implement idempotency in your webhook handler to handle duplicate deliveries.
## Add webhooks
Add your webhook URL in our system for us to deliver webhook events.
Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/merchants/)** and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, fill in the following information:
* **Webhook URL**: Enter the URL in this field.
5. Click **Test & Add Webhook**.
***
## Webhook events
| Event | Description |
| :----------------------------- | :--------------------------------------------------------------------- |
| E\_SIGN\_VERIFICATION\_SUCCESS | You will receive this event when the e-sign verification is a success. |
| E\_SIGN\_VERIFICATION\_FAILURE | You will receive this event when the e-sign verification is a failure. |
| E\_SIGN\_VERIFICATION\_EXPIRED | You will receive this event when the e-sign verification is expired. |
```Text E_SIGN_VERIFICATION_SUCCESS theme={"dark"}
{
"event_type":"ESIGN_VERIFICATION_SUCCESS",
"event_time":"2023-07-19 10:46:16",
"version":"v1",
"data": {
"status": "SUCCESS",
"reference_id": 32,
"verification_id": "ABC00123",
"document_id": 36,
"signers": [
{
"name": "John Doe",
"status": "SUCCESS",
"is_notified": true
},
{
"name": "Frank Kelvin",
"status": "SUCCESS",
"is_notified": true
}
],
"signed_doc_url": "SIGNED_DOC_URL"
}
}
```
```Text E_SIGN_VERIFICATION_FAILURE theme={"dark"}
{
"event_type":"ESIGN_VERIFICATION_FAILURE",
"event_time":"2023-07-19 10:46:16",
"version":"v1",
"data": {
"status": "FAILURE",
"reference_id": 32,
"verification_id": "ABC00123",
"document_id": 36,
"signers": [
{
"name": "John Doe",
"status": "SUCCESS",
"is_notified": true
},
{
"name": "Frank Kelvin",
"status": "FAILURE",
"is_notified": false
}
],
"signed_doc_url": "SIGNED_DOC_URL"
}
}
```
```Text E_SIGN_VERIFICATION_EXPIRED theme={"dark"}
{
"event_type":"ESIGN_VERIFICATION_EXPIRED",
"event_time":"2023-07-19 10:46:16",
"version":"v1",
"data": {
"status": "EXPIRED",
"reference_id": 32,
"verification_id": "ABC00123",
"document_id": 36,
"signers": [
{
"name": "John Doe",
"status": "EXPIRED",
"is_notified": true
},
{
"name": "Frank Kelvin",
"status": "RECEVIED",
"is_notified": false
}
],
"signed_doc_url": ""
}
}
```
## Webhook signature
You will receive the webhook signature in the webhook header. Here is a sample header from a webhook request.
| Header Name | Header Value |
| ------------------- | :------------------------------------------: |
| content-length | 1099 |
| x-webhook-attempt | 1 |
| content-type | application/json |
| x-webhook-signature | 07r5C3VMwsGYeldGOCYxe5zoHhIN1zLfa8O0U/yngHI= |
| x-webhook-timestamp | 1746427759733 |
Always capture the webhook payload in its raw text format before parsing into JSON. Parsing and re-serialising the payload can change the structure (for example, array ordering, spacing, or `null` handling) and cause a signature mismatch during verification. Use the exact raw body string from the request when computing the signature.
## Webhook payload fields
The webhook payload contains important metadata in its top-level fields.
| Field | Type | Description |
| ------------ | -------- | --------------------------------------------------------------------------------------------- |
| `event_type` | `string` | Indicates the type of event that triggered the webhook. |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`). |
| `version` | `string` | Indicates the webhook format being used. Default version is "v1". |
| `data` | `object` | Contains event-specific details related to this feature. |
Verifying the signature is mandatory before processing any response. Refer to [Signature Verification](/api-reference/vrs/webhook-signature-verification#webhook-signature-verification) for more details.
# End Points
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/end-point
Use the Verification Suite APIs to verify bank account information, PAN, GSTIN of your customers. You can check the required parameters, success, and error responses.
Cashfree Payments uses API keys to allow access to the API. Once you have signed up at our merchant site, you will be able to see your AppId and SecretKey.
Cashfree expects API key to be included in all API requests to the server. Use the endpoint /api/v1/credentials/verify to verify your credentials.
## End Points
| Environment | URL |
| :---------- | :------------------------------------------------------------------------------------- |
| Production | [https://api.cashfree.com/verification](https://api.cashfree.com/verification) |
| Test | [https://sandbox.cashfree.com/verification](https://sandbox.cashfree.com/verification) |
***
## Test data
View the [test data](/api-reference/vrs/data-to-test-integration) and use this information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox, which are mentioned above.
***
## Signature Verification
Cashfree Payments sends a signature alongside every webhook, verifying this signature ( passed along with the POST parameters ) is mandatory before processing any response. It helps authenticate that the webhook is from Cashfree Payments.
We strongly recommend whitelisting Cashfree Payments production IP to help make your communication with us more secure.
Following are the steps to verify Cashfree Payments signature:
1. Get all the POST parameters except ‘signature’ and assign it to an array as key-value pair.
2. Sort the array based on keys.
3. Concatenate all the values in this array and resultant is the post data (**postData**).
4. **postData** needs to be encrypted using SHA-256 and then base64 encoded.
5. Proceed further only if the signatures match. If not, discard the request.
# Face Liveness Check
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/face-liveness/face-liveness
post /face-liveness
Use this API to detect live human presence and authenticate facial biometrics. The API analyzes facial characteristics and liveness signals to prevent spoofing attempts and validate genuine user presence. Returns comprehensive facial analysis including liveness confidence score and quality metrics. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#face-liveness) and use the information to trigger the validations. The test data are usable only in the test environment sandbox.
# Face Match
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/face-match/face-match
post /face-match
Use this API to verify the facial features of your customer in one image with another. You can compare an image with another image or with an image in an ID. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#face-match) and use the information to trigger the validations. The test data are usable only in the test environment sandbox.
# Generate KYC Link
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/generate-form-link
post /form
Use this API to generate a verification form to verify the KYC information of your users digitally.
# Geocoding
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/geocoding/geocoding
post /geocoding
Use this API to convert a physical address into geographic coordinates (latitude and longitude). This helps verify location accuracy, enable map integrations, calculate distances, and support location-based services. You can view the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#geocoding) and use the information to trigger the validations. Test data works only in the sandbox environment.
# Get KYC Link Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/get-form-status
get /form
Use this API to get the status of the verification form. You need to input either the verification_id or reference_id to get the KYC Link status.
# Verify GSTIN
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/gstin/verify-gstin
post /gstin
Use this API to verify if a given GSTIN information exists or not. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#gstin) and use the information to trigger the validations. The test data are usable only in the test environments such as sandbox.
# IFSC Verification V2
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/ifsc/ifsc-verification-v2
post /ifsc
Use this API to verify the provided IFSC information. You will receive the bank name, the branch that it belongs to, the supported transfer modes, and the respective MICR code in the response. View the [test data](/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. You can use the test data only in test environments such as gamma and sandbox.
# Verify IP
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/ip/verify-ip
post /ip
Use this API to verify location, proxy details, city risk score, and proxy type risk score of an IP address. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#ip-address) and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.
| Sub code | Status | Message | Next action |
| -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| 200 | SUCCESS | VALID | - |
| 400 | ERROR | x-client-id is missing in the request. | Enter all the header information in the request. |
| 400 | ERROR | verification\_id already exists. | Enter a unique verification ID to identify the request. |
| 400 | ERROR | Client secret belongs to test environment | Enter the correct environment credentials in the request. |
| 400 | ERROR | please enter a valid IP address | Enter a valid IP address in the request. |
| 401 | ERROR | Invalid clientId and clientSecret combination | Ensure you enter valid x-client-id and x-client-secret information in the API request. |
| 403 | ERROR | IP not whitelisted your current IP is 106.51.91.104. For IP whitelisting assistance, visit our [IP Whitelisting guide](https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification) | Whitelist the IP address. |
| 404 | ERROR | unable to find IP details | Enter a valid IP address in the request. |
| 422 | ERROR | Insufficient balance to process this request | Try again with sufficient balance. |
| 500 | ERROR | something went wrong, please try after some time | Try again after some time. |
# Deactivate Static KYC Link
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/deactivate-static-link
delete /form/static-link
Use this API to deactivate a static KYC Link.
# Generate KYC Link
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/generate-form-link
post /form
Use this API to generate a verification form to verify the KYC information of your users digitally.
# Generate Static KYC Link
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/generate-static-link
post /form/static-link
Use this API to generate a static KYC link to verify the KYC information of your users digitally.
# Get KYC Link Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status
get /form
Use this API to get the status of the verification form. You need to input either the verification_id or reference_id to get the KYC Link status.
# Get Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-status
## Bank account verification V2
Find the APIs to check the status of bank account verification V2 requests:
| API | Description |
| :---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Get BAV Status V2](/api-reference/vrs/v2/bav-v2/get-bav-status-v2) | Use this API to get the details of the bank account verification request. You need to enter either the reference ID or user ID. |
| [Get Bulk BAV Status V2](/api-reference/vrs/v2/bav-v2/get-bulk-bav-status-v2) | Use this API to get the details of the bulk bank account verification request. You need to enter either the bulk reference ID or bulk validation ID. If you want to get the status of a single entry, enter the particular reference ID in the request. |
## PAN
Find the APIs to check the status of the PAN verification requests:
| API | Description |
| :--------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Get Status of Verify PAN Sync](/api-reference/vrs/v2/pan/get-status-of-verify-pan-sync) | Use this API to get the verification status of the Verify PAN Sync API. You need to enter the reference ID to get the verification status. |
| [Get Status for Verify PAN in Bulk](/api-reference/vrs/v2/pan/get-status-for-verify-pan-in-bulk) | Use this API to get the status of the Verify PAN in Bulk API request. You need to enter either the reference ID or bulk verification ID. |
| [Get Status of PAN Verification via OCR](/api-reference/vrs/v2/pan/get-status-of-pan-verification-via-ocr) | Use this API to get the status of the created PAN Verification via OCR request. You need to enter either the reference ID or verification ID to get the status. |
## Aadhaar
Finds the APIs to check the status of the aadhaar verification requests:
| API | Description |
| :--------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Get Status of Aadhaar Verification via OCR](/api-reference/vrs/v2/aadhaar/get-status-of-aadhaar-verification-via-ocr) | Use this API to get the status of the created Aadhaar Verification via OCR request. You need to enter either the reference ID or verification ID to get the status. |
# Webhooks
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/webhooks
Webhooks are server callbacks to your server from Cashfree payments.
Webhooks are event-based notifications that are received when a specific event related to the KYC verification occurs.
In rare cases, such as network retries, read timeouts, processing delays, or delivery failures, the same webhook might be sent more than once for the same event. To prevent unintended side effects, implement idempotency in your webhook handler to handle duplicate deliveries.
## Add webhooks
Add your webhook URL in our system for us to deliver webhook events.
Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/merchants/)** and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, fill in the following information:
* **Webhook URL**: Enter the URL in this field.
5. Click **Test & Add Webhook**.
***
## Webhook events
| Event | Description |
| :--------------------------- | :------------------------------------------------------------------------------------- |
| KYC\_LINK\_ACTION\_PERFORMED | You will receive this event when one of the verifications is performed using the link. |
| KYC\_LINK\_SUCCESS | You will receive this event when all the verifications are performed successfully. |
| KYC\_LINK\_EXPIRED | You will receive this event when the link expires. |
```Text KYC_LINK_ACTION_PERFORMED theme={"dark"}
{
"signature": "3YdAGMqBPDgWqy4zteRad/MoCmH59cm+93sogQWhOa8=",
"event_type": "KYC_LINK_ACTION_PERFORMED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"name": "Test",
"phone": "9999999999",
"email": "test@cashfree.com",
"verification_id": "testverificationid",
"reference_id": 235461,
"link_expiry": "2025-12-02",
"form_link": "https://forms.cashfree.com/",
"form_status": "RECEIVED",
"verification_details": [
{
"reference_id": 234,
"type": "OFFLINE_AADHAAR_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 0,
"type": "PANDETAILS_VERIFICATION",
"status": "RECEIVED"
},
{
"reference_id": 0,
"type": "BANKDETAILS_VALIDATION",
"status": "RECEIVED"
},
{
"reference_id": 0,
"type": "UPIDETAILS_VALIDATION",
"status": "RECEIVED"
}
]
}
}
```
```Text KYC_LINK_SUCCESS theme={"dark"}
{
"event_type": "KYC_LINK_SUCCESS",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"name": "Test",
"phone": "9999999999",
"email": "test@cashfree.com",
"verification_id": "testverificationid",
"reference_id": 235461,
"link_expiry": "2025-12-02",
"form_link": "https://forms.cashfree.com/",
"form_status": "SUCCESS",
"verification_details": [
{
"reference_id": 234,
"type": "OFFLINE_AADHAAR_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 235,
"type": "PANDETAILS_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 236,
"type": "BANKDETAILS_VALIDATION",
"status": "SUCCESS"
},
{
"reference_id": 237,
"type": "UPIDETAILS_VALIDATION",
"status": "SUCCESS"
}
]
}
}
```
```Text KYC_LINK_EXPIRED theme={"dark"}
{
"event_type": "KYC_LINK_EXPIRED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"name": "Test",
"phone": "9999999999",
"email": "test@cashfree.com",
"verification_id": "testverificationid",
"reference_id": 235461,
"link_expiry": "2025-12-02",
"form_link": "https://forms.cashfree.com/",
"form_status": "EXPIRED",
"verification_details": [
{
"reference_id": 234,
"type": "OFFLINE_AADHAAR_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 0,
"type": "PANDETAILS_VERIFICATION",
"status": "EXPIRED"
},
{
"reference_id": 236,
"type": "BANKDETAILS_VALIDATION",
"status": "SUCCESS"
},
{
"reference_id": 0,
"type": "UPIDETAILS_VALIDATION",
"status": "EXPIRED"
}
]
}
}
```
## Webhook signature
You will receive the webhook signature in the webhook header. Here is a sample header from a webhook request.
| Header Name | Header Value |
| ------------------- | :------------------------------------------: |
| content-length | 1099 |
| x-webhook-attempt | 1 |
| content-type | application/json |
| x-webhook-signature | 07r5C3VMwsGYeldGOCYxe5zoHhIN1zLfa8O0U/yngHI= |
| x-webhook-timestamp | 1746427759733 |
Always capture the webhook payload in its raw text format before parsing into JSON. Parsing and re-serialising the payload can change the structure (for example, array ordering, spacing, or `null` handling) and cause a signature mismatch during verification. Use the exact raw body string from the request when computing the signature.
## Webhook payload fields
The webhook payload contains important metadata in its top-level fields.
| Field | Type | Description |
| ------------ | -------- | --------------------------------------------------------------------------------------------- |
| `event_type` | `string` | Indicates the type of event that triggered the webhook. |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`). |
| `version` | `string` | Indicates the webhook format being used. Default version is "v1". |
| `data` | `object` | Contains event-specific details related to this feature. |
Verifying the signature is mandatory before processing any response. Refer to [Signature Verification](/api-reference/vrs/webhook-signature-verification) for more details.
# Mobile 360 OTP Less
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-otpless
post /mobile360/otpless
Use this API to extract multiple identity types from mobile number.
# Mobile 360 Send OTP Request
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-send-otp-request
post /mobile360/otp/send
The Mobile Send OTP API generates and sends a One-Time Password (OTP) to a user's mobile number via specified notification modes like SMS or WhatsApp.It captures consent details, ensuring secure and compliant user verification. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#mobile-360) and use the information to trigger the validations. You can use the test data only in test environments such as sandbox.
# Mobile 360 Verify OTP
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-verify-otp
post /mobile360/otp/verify
Use this API to extract multiple identity types from mobile number.
The following table outlines the key data fields returned in the OTP verification response:
| **Field** | **Description** |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| PERSONAL\_DETAILS | Provides personal information such as full name, gender, date of birth, age, income, and occupation. |
| RELATIVE\_DETAILS | Provides information about family members, including their names and relationships. |
| BANK\_ACCOUNT\_DETAILS | Contains banking information such as account number, IFSC code, bank address, and associated linkage. |
| UAN\_EMPLOYMENT\_DETAILS | Contains employment records linked to a UAN, including member ID, establishment ID, joining and exit dates, and Aadhaar linkage status. |
| RECENT\_EMPLOYMENT\_DETAILS | Provides recent employment history, including employee and employer details, EPFO verification, and PF filing data. |
| PAN | Contains the PAN number associated with the individual. |
| PAN\_METADATA | Provides metadata related to the PAN, such as the registered name, name on the card, type, and Aadhaar linkage status. |
| PHONE\_LIST | Lists phone numbers associated with the individual, including the number type and linkage source. |
| EMAIL\_LIST | Lists email addresses associated with the individual and their linkage sources. |
| PASSPORT\_NUMBER | Contains the passport number and associated linkage information. |
| AADHAAR\_NUMBER | Provides a masked Aadhaar number and its source of linkage. |
| RATION\_CARD | Contains the ration card number and linkage information. |
| DRIVING\_LICENSE | Contains the driving license number and associated linkage. |
| VOTER\_ID | Contains the voter ID and its linkage information. |
| ADDRESS\_LIST | Lists known addresses, including full address, city, state, pincode, and linkage source. |
| MOBILE\_NUMBER\_INTELLIGENCE | Provides key insights about the mobile number, including its validity, connection status, and service provider details. |
| CREDIT\_SCORE | Provides the individual's credit score as a numeric value. |
| RISK\_INTELLIGENCE | Provides risk insights about the mobile number, including is safe, risk level, reason, description, and relevant timestamps. |
# Verify Name Match
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/name-match/name-match
post /name-match
Use this API to verify names that have enormous variations. Provide us the names you want to verify, and we will tell you whether they match and provide the reason. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#name-match) and use the information to trigger the validations. The test data are usable only in the test environments such as sandbox.
# Fetch GSTIN with PAN
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan-to-gstin/fetch-gstin-with-pan
post /pan-gstin
Use this API to fetch the list of GSTIN associated with the PAN information. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#fetch-gstin-with-pan) and use the information to trigger the validations. You can use the test data only in test environments such as sandbox.
# Fetch Udyam with PAN
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan-to-udyam/fetch-udyam-with-pan
post /pan-udyam
Use this API to fetch the Udyam registration number associated with a PAN number. You need to enter the PAN number and we retrieve the corresponding Udyam registration number if it exists. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan-to-udyam) and use the information to trigger the validations. The test data are usable only in the test environments such as sandbox.
# Get Status.
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan/get-status-for-verify-pan-in-bulk
get /pan/bulk
Use this API to get the status of the Verify PAN in Bulk API request. You need to enter either the reference ID or bulk verification ID.
# Get Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan/get-status-of-verify-pan-sync
get /pan/{reference_id}
Use this API to get the verification status of the Verify PAN Sync API. You need to enter the reference ID to get the verification status.
# PAN 360
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan/pan-360
post /pan/advance
Use this API to verify the PAN information of your customers. You can retrieve more information such as first name, last name, masked aadhaar number,masked email, masked mobile number and other contact information and more. Mobile number ,email and address fields will have fill rate around 45% based on the recent changes to the source of the information. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations. The test data are usable only in the test environments such as sandbox.
The name returned by the API may differ from the name printed on the physical PAN card. The API returns the registered name from the Income Tax Department's records, which is the authoritative source and may not match the name displayed on the card.
# PAN Lite
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan/pan-lite
post /pan-lite
Use this API to validate PAN information of individuals. The API helps verify the unique identifier, name of the individual, date of birth, and other information that helps you in customer onboarding, KYC verification, and other fraud prevention security measures. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations.You can use the test data only in sandbox environment.
The name returned by the API may differ from the name printed on the physical PAN card. The API returns the registered name from the Income Tax Department's records, which is the authoritative source and may not match the name displayed on the card.
# Verify
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan/verify-pan-in-bulk
post /pan/bulk
Use this API to verify your customers' PAN information individually or in batches at a time. This API comes in handy when you have to verify a large number of PAN information. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations. The test data are usable only in the test environment sandbox.
The name returned by the API may differ from the name printed on the physical PAN card. The API returns the registered name from the Income Tax Department's records, which is the authoritative source and may not match the name displayed on the card.
# Verify
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/pan/verify-pan-sync
post /pan
Use this API to verify if a given PAN exists. You will receive the name registered with the PAN and the PAN type (Individual or Business) in the response for a valid PAN. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations. The test data are usable only in the test environment sandbox.
The name returned by the API may differ from the name printed on the physical PAN card. The API returns the registered name from the Income Tax Department's records, which is the authoritative source and may not match the name displayed on the card.
# Verify Passport
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/passport/verify-passport
post /passport
Use this API to verify passport information and ensure the identity of your customer. Provide the passport file number in the request and we help you fetch the details. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#passport) and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox. Passport verification is supported only for Indian passports. Passports from other countries are not eligible.
| Sub code | Status | Message | Next action |
| -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| 200 | SUCCESS | VALID | - |
| 200 | SUCCESS | INVALID | Enter the correct information in the request. |
| 400 | ERROR | verification\_id is missing in the request. | Enter a valid verification\_id in the request. |
| 400 | ERROR | verification\_id can include only alphanum, dot, hyphen, and underscores. | Only alphanumeric, period (.), hyphen (-), and underscore ( \_ ) are allowed. |
| 400 | ERROR | file\_number is missing in the request. | Enter the file number in the request. |
| 400 | ERROR | dob is missing in the request. | Enter the date of birth of the passport holder in the request. |
| 400 | ERROR | dob should be of type YYYY-MM-DD. | Enter the DOB in the YYYY-MM-DD format. |
| 400 | ERROR | Client secret belongs to test environment. | Enter the correct environment credentials in the request. |
| 400 | ERROR | x-client-id is missing in the request. | Enter all the header information in the API request. |
| 401 | ERROR | Invalid clientId and clientSecret combination. | Ensure you enter valid x-client-id and x-client-secret information in the API request. |
| 403 | ERROR | IP not whitelisted your current IP is 106.51.91.104. For IP whitelisting assistance, visit our [IP Whitelisting guide](https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification) | Whitelist the IP address. |
| 409 | ERROR | verification ID already exists. | Enter a unique verification ID to identify the request. |
| 422 | ERROR | Insufficient balance to process this request. | Try again with sufficient balance. |
| 500 | ERROR | something went wrong. | Try again after some time. |
| 502 | ERROR | verification attempt failed. | Try again after some time. |
# Reverse Geocoding
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/reverse-geocoding/reverse-geocoding
post /reverse-geocoding
Use this API to convert geohraphic coordinates (latitude and longitude) into readable location information for verification purposes. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#reverse-geocoding-coordinates) and use the information to trigger the validations.You can use the test data only in sandbox environment.
# Create Reverse Penny Drop Request
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/reverse-penny-drop/create-reverse-penny-drop-request
post /reverse-penny-drop
Use this API to create a reverse penny drop request. Reverse penny drop is a verification method for validating bank account information. Your customers/users deposit 1 rupee through a UPI based transaction and get the 1 rupee back once the verification is complete. The generated RPD link is valid for 10 minutes. You must complete the reverse penny drop process within this time.
# Get Reverse Penny Drop Request Details
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/reverse-penny-drop/get-reverse-penny-drop-request-details
get /remitter/status
Use this API to get the details of the created reverse penny drop request. You need to enter either the reference ID or verification ID.
# Webhooks
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/reverse-penny-drop/webhooks-reverse-penny
Webhooks are server callbacks to your server from Cashfree payments.
Webhooks are event-based notifications that are received when a specific event related to the reverse penny drop verification occurs.
In rare cases, such as network retries, read timeouts, processing delays, or delivery failures, the same webhook might be sent more than once for the same event. To prevent unintended side effects, implement idempotency in your webhook handler to handle duplicate deliveries.
## Add webhooks
Add your webhook URL in our system for us to deliver webhook events.
Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/merchants/)** and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, fill in the following information:
* **Webhook URL**: Enter the URL in this field.
5. Click **Test & Add Webhook**.
## Webhook event
| Event | Description |
| :---------------------------------------- | :------------------------------------------------ |
| RPD\_BANK\_ACCOUNT\_VERIFICATION\_SUCCESS | The reverse penny drop verification is a success. |
| RPD\_BANK\_ACCOUNT\_VERIFICATION\_EXPIRED | The reverse penny drop verification expired. |
| RPD\_BANK\_ACCOUNT\_VERIFICATION\_FAILURE | The reverse penny drop verification is a failure. |
```Text RPD_BANK_ACCOUNT_VERIFICATION_SUCCESS theme={"dark"}
{
"signature":"signature",
"event_type":"RPD_BANK_ACCOUNT_VERIFICATION_SUCCESS",
"event_time":"2023-07-19 10:46:16",
"version":"v1",
"data":{
"bank_account":"026291800001191",
"ifsc":"YESB0000262",
"upi": "success@upi",
"name_at_bank":"BHARATHTEST GKUMARUT",
"verification_id":"91",
"ref_id":"49",
"utr":"49" ,
"status":"SUCCESS",
"name_match_score":"",
"name_match_result":"",
"added_on":"2023-07-14 17:29:50",
"processed_on":"2023-07-14 17:30:50",
"penny_collected_on":"2023-07-14 17:30:50"
"reversal_status": "PENDING",
"account_type": "SAVINGS"
}
}
```
```Text RPD_BANK_ACCOUNT_VERIFICATION_EXPIRED theme={"dark"}
{
"signature":"signature",
"event_type":"RPD_BANK_ACCOUNT_VERIFICATION_EXPIRED",
"event_time":"2023-07-19 10:46:16",
"version":"v1",
"data":{
"bank_account":"",
"ifsc":"",
"upi": "",
"name_at_bank":"",
"verification_id":"91",
"ref_id":"49",
"utr":"" ,
"status":"EXPIRED",
"name_match_score":"",
"name_match_result":"",
"added_on":"2023-07-14 17:29:50",
"processed_on":"2023-07-14 17:30:50",
"penny_collected_on":""
}
}
```
```Text RPD_BANK_ACCOUNT_VERIFICATION_FAILURE theme={"dark"}
{
"signature":"signature",
"event_type":"RPD_BANK_ACCOUNT_VERIFICATION_FAILURE",
"event_time":"2023-07-19 10:46:16",
"version":"v1",
"data":{
"bank_account":"",
"ifsc":"",
"upi": "",
"name_at_bank":"",
"verification_id":"91",
"ref_id":"49",
"utr":"" ,
"status":"FAILURE",
"name_match_score":"",
"name_match_result":"",
"added_on":"2023-07-14 17:29:50",
"processed_on":"2023-07-14 17:30:50",
"penny_collected_on":""
}
}
```
## Webhook payload fields
The webhook payload contains important metadata in its top-level fields.
| Field | Type | Description |
| ------------ | -------- | ---------------------------------------------------------------------------------------------- |
| `signature` | `string` | A Base64-encoded HMAC-SHA256 signature of the payload, generated using a shared client secret. |
| `event_type` | `string` | Indicates the type of event that triggered the webhook. |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`). |
| `version` | `string` | Indicates the webhook format being used. Default version is "v1". |
| `data` | `object` | Contains event-specific details related to this feature. |
## Signature Verification
Verifying the signature is mandatory before processing any response. It helps authenticate that the webhook is from Cashfree Payments.
Follow the steps to verify the signature:
1. Sort the array based on keys.
2. Concatenate all the values in this array and the resultant is the post data (**postData**).
3. Encrypt the `postData` with SHA-256 and Base64-encode it.
4. Verify that the calculated signature matches the signature received.
5. Continue processing only if the signatures match. Otherwise, discard the request.
6. Ensure that the `clientSecret` you use belongs to the oldest active key pair.
For example, from the webhook received, extract the data and pass it to generate HMAC function:
```
{bank_account=026291800001191, ifsc=YESB0000262, upi=, name_at_bank=John Doe,
verification_id=fadsfdsf, ref_id=332, utr=332, status=SUCCESS,
added_on=2023-09-06T07:48:53+05:30, processed_on=2023-09-06 07:49:03,
penny_collected_on=2023-09-06 07:48:53}
```
```Text Java code - for reference theme={"dark"}
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.util.Map;
import java.util.TreeMap;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.codec.binary.Base64;
public class ComputedSignature {
public static String generateHMAC(String clientSecret, String data) {
String hash = null;
ObjectMapper objectMapper = new ObjectMapper();
try {
Map jsonMap = objectMapper.readValue(data, new TypeReference>() {
});
Map sortedMap = new TreeMap<>(jsonMap);
// sort the map based on keys
String postDataString = "";
for (Map.Entry entry : sortedMap.entrySet()) {
postDataString = postDataString + entry.getValue();
}
// encode the post data on sha256
Mac sha256HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secretKey = new SecretKeySpec(clientSecret.getBytes(), "HmacSHA256");
sha256HMAC.init(secretKey);
hash = Base64.encodeBase64String(sha256HMAC.doFinal(postDataString.getBytes()));
} catch (Exception e) {
e.printStackTrace();
}
return hash;
}
}
```
## IPs to whitelist
When you decide to consume the webhooks, first, you need to verify if your systems need an IP whitelisting to be done at your end or not. Accordingly you can whitelist the below IPs of Cashfree:
| Sandbox |
| :------------ |
| 52.66.25.127 |
| 15.206.45.168 |
| Prod |
| :------------ |
| 52.66.101.190 |
| 3.109.102.144 |
| 3.111.60.173 |
| 18.60.134.245 |
| 18.60.183.142 |
| Port |
| :------------ |
| 443 (secured) |
# API vs SDK
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/sdk/api-sdk
This topic explains the key differences between APIs and SDKs, highlighting their roles, benefits, and how SDKs simplify and accelerate development.
### What is an API?
Application Programming Interface or an API is a set of rules that allows one application to communicate with another. It defines how to send requests and receive responses, typically over a network.
**Key characteristics**:
* Facilitates communication between systems.
* Exposes specific functions or data.
* Requires manual implementation such as building request payloads, handling errors.
* Typically language-agnostic such as example, REST, GraphQL.
### What is an SDK?
Software Development Kit or an SDK is a comprehensive set of tools that helps developers build applications for a specific platform or service. It often includes APIs, libraries, documentation, and utilities.
**Key components**:
* APIs and wrapper libraries.
* Code samples and documentation.
* Tools like compilers or debuggers depending on the platform.
* Language-specific support such as Android SDK for Java/Kotlin, iOS SDK for Swift.
### API vs SDK: A quick comparison
| **Aspect** | **API** | **SDK** |
| ---------------- | ----------------------------------- | ------------------------------------------- |
| Purpose | Enables interaction between systems | Facilitates application development |
| Scope | Focused on specific functionality | Comprehensive toolkit, often includes APIs |
| Ease of Use | Requires manual setup | Provides abstractions and ready-to-use code |
| Language Support | Typically language-agnostic | Usually language-specific |
| Included Tools | None | Often includes debuggers, emulators, etc. |
### Benefits of using an SDK
While APIs are essential building blocks, SDKs enhance the development experience with several added advantages:
**Faster development**:
SDKs offer pre-built methods and helper functions, reducing time spent writing and debugging repetitive code.
**Simplified integration**:
Common tasks like authentication, request formatting, and error handling are often built-in, minimising setup effort.
**Platform optimisation**:
SDKs are tailored for specific languages and platforms, ensuring smoother integration and better performance.
**Developer-friendly**:
Bundled documentation, code examples, and utilities help reduce the learning curve and improve onboarding.
# Server side SDKs
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/sdk/verification-suite-server-sdks
In this article, you will learn the reasons to use our server-side software development kits (SDKs) and where to find them to integrate our Secure ID APIs.
We created SDKs with pre-written code, tools, and resources that help you integrate Secure ID APIs into your application.
## Why use server SDKs?
At Cashfree Payments, we're committed to streamlining backend integrations for merchants using our robust Server SDKs. Here's why opting for Server SDKs is a game-changer:
* **Effortless integration**
Our SDKs compile common functionalities within user-friendly code libraries, tailor made for programming languages like Node, PHP, Java, and Python. This allows you to easily integrate our APIs into your existing infrastructure. This saves a lot of your time spent on integration that can be put to use for your other business needs.
* **Simplified backend calls**
We help you make backend API calls effortlessly by leveraging with language-specific SDKs. They include API complexities and allows you to smoothly integrate with server-side applications.
* **Automated updates**
Our SDKs are automatically updated in sync with API modifications, ensuring alignment with the latest features and enhancements.
### Choose your language-specific SDK
# Smart OCR
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/smart-ocr
post /bharat-ocr
Smart OCR to validate and extract all the relevant fields from a document.
**Sandbox environment** is a testing environment and responses are mocked. For real time verifications, please use the **production environment**.
# Driving Licence
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/DL
This page provides the success response of the Smart OCR API for the Driving Licence document.
```Text DRIVING_LICENCE_OCR theme={"dark"}
{
"verification_id": "test_verification_id",
"reference_id": 1358,
"status": "VALID",
"document_type": "DRIVING_LICENCE",
"document_fields": {
"address": "123 Main Street, Sector 15, Noida, Uttar Pradesh",
"blood_group": "B+",
"date_of_birth": "2004-10-02",
"full_name": "John Doe",
"guardian_name": "Josh Doe",
"issuing_authority": "Assam",
"license_issue_date": "2019-08-16",
"license_expiry_date": "2024-05-13",
"license_number": "AB1120040002378",
"pin": "247001",
"vehicle_class": [
{
"issue_date": "2004-05-14",
"vehicle_type": "MCWG"
},
{
"issue_date": "2004-05-14",
"vehicle_type": "LMV"
}
]
},
"quality_checks": {
"blur": true,
"glare": false,
"partially_present": false,
"black_and_white": false,
"face_present": true,
"face_clear": false,
"qr_present": false,
"obscured": false
},
"fraud_checks": {
"is_screenshot": true,
"is_photo_of_screen": false,
"is_photo_imposed": false,
"is_overwritten": false
},
"verification_details": {
"verification_id": "verification-uuid-sample-456",
"reference_id": 9876544,
"dl_number": "AB1120040002378",
"dob": "2004-10-02",
"status": "VALID",
"badge_details": [
{
"badge_issue_date": "2019-08-16",
"badge_no": "DL002378",
"class_of_vehicle": [
"MCWG",
"LMV"
]
}
],
"dl_validity": {
"non_transport": {
"to": "2024-05-13",
"from": "2019-08-16"
},
"hazardous_valid_till": null,
"transport": {
"to": null,
"from": null
},
"hill_valid_till": null
},
"details_of_driving_licence": {
"date_of_issue": "2019-08-16",
"date_of_last_transaction": "2022-08-15",
"status": "ACTIVE",
"last_transacted_at": "2022-08-15T14:30:00Z",
"name": "John Doe",
"father_or_husband_name": "Josh Doe",
"address_list": [
{
"complete_address": "123, Main Street, Sector 15, Noida, Uttar Pradesh, 247001",
"type": "permanent",
"split_address": {
"district": [
"GAUTAM BUDDHA NAGAR"
],
"state": [
[
"UTTAR PRADESH",
"UP"
]
],
"city": [
"NOIDA"
],
"pincode": "247001",
"country": [
"IN",
"IND",
"INDIA"
],
"address_line": "123, Main Street, Sector 15"
}
},
{
"complete_address": "123, Main Street, Sector 15, Noida, Uttar Pradesh, 247001",
"type": "temporary",
"split_address": {
"district": [
"GAUTAM BUDDHA NAGAR"
],
"state": [
[
"UTTAR PRADESH",
"UP"
]
],
"city": [
"NOIDA"
],
"pincode": "247001",
"country": [
"IN",
"IND",
"INDIA"
],
"address_line": "123, Main Street, Sector 15"
}
}
],
"address": "123, Main Street, Sector 15, Noida, Uttar Pradesh, 247001",
"photo": "https://example-bucket.s3.amazonaws.com/sample-dl-photo-456.jpg",
"split_address": {
"district": [
"GAUTAM BUDDHA NAGAR"
],
"state": [
[
"UTTAR PRADESH",
"UP"
]
],
"city": [
"NOIDA"
],
"pincode": "247001",
"country": [
"IN",
"IND",
"INDIA"
],
"address_line": "123, Main Street, Sector 15"
},
"cov_details": []
}
}
}
```
# Aadhaar
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/aadhaar
This page provides the success response of Smart OCR API for Aadhaar document.
```Text AADHAAR_FRONT theme={"dark"}
{
"verification_id": "test_verification_id",
"reference_id": 1358,
"status": "VALID",
"document_type": "AADHAAR_FRONT",
"document_fields": {
"address": "S / O Josh Doe, 202-parivar daser complex , dal bazar , Gird , Gwalior , Lashkar City , Madhya Pradesh , 474019",
"dob": "2004-10-02",
"father": "Josh Doe",
"gender": "Male",
"name": "John Doe",
"uid": "123456789012",
},
"quality_checks": {
"blur": true,
"glare": false,
"partially_present": false,
"black_and_white": false,
"face_present": true,
"face_clear": false,
"qr_present": false,
"obscured": false
},
"fraud_checks": {
"is_screenshot": true,
"is_photo_of_screen": false,
"is_photo_imposed": false,
"is_overwritten": false
},
"qr_details": {
"status": "SECURE",
"name": "John Doe",
"dob": "2004-10-02",
"gender": "Male",
"care_of": "S / O : Josh Doe",
"address": "S / O : Josh Doe, 202-parivar daser complex, parivar daser complex, dal bazar, dal bazar, Lashkar City, Gird, Gwalior, Gwalior, Madhya Pradesh - 474019",
"split_address": {
"country": "India",
"dist": "Gwalior",
"house": "202-parivar daser complex",
"landmark": "dal bazar",
"pincode": 474019,
"po": "Lashkar City",
"state": "Madhya Pradesh",
"street": "parivar daser complex",
"subdist": "Gird",
"vtc": "Gwalior",
"locality": "dal bazar"
},
"year_of_birth": 2004,
"aadhaar_last_four_digit": "9012",
"email_linked": true,
"mobile_linked": true,
"mobile_hash": "hashed_mobile_value",
"email_hash": "hashed_email_value",
"photo_link": ""
}
}
```
```Text AADHAAR_BACK theme={"dark"}
{
"verification_id": "test_verification_id",
"reference_id": 1358,
"status": "VALID",
"document_type": "AADHAAR_BACK",
"document_fields": {
"address": "S / O Josh Doe, 202-parivar daser complex , dal bazar , Gird , Gwalior , Lashkar City , Madhya Pradesh , 474019",
"pincode": "474019",
"uid": "123456789012"
},
"quality_checks": {
"blur": true,
"glare": false,
"partially_present": false,
"black_and_white": false,
"face_present": false,
"face_clear": false,
"qr_present": false,
"obscured": false
},
"fraud_checks": {
"is_screenshot": true,
"is_photo_of_screen": false,
"is_photo_imposed": false,
"is_overwritten": false
},
"qr_details": {
"status": "SECURE",
"name": "John Doe",
"dob": "2004-10-02",
"gender": "Male",
"care_of": "S / O : Josh Doe",
"address": "S / O : Josh Doe, 202-parivar daser complex, parivar daser complex, dal bazar, dal bazar, Lashkar City, Gird, Gwalior, Gwalior, Madhya Pradesh - 474019",
"split_address": {
"country": "India",
"dist": "Gwalior",
"house": "202-parivar daser complex",
"landmark": "dal bazar",
"pincode": 474019,
"po": "Lashkar City",
"state": "Madhya Pradesh",
"street": "parivar daser complex",
"subdist": "Gird",
"vtc": "Gwalior",
"locality": "dal bazar"
},
"year_of_birth": 2004,
"aadhaar_last_four_digit": "9012",
"email_linked": true,
"mobile_linked": true,
"mobile_hash": "hashed_mobile_value",
"email_hash": "hashed_email_value",
"photo_link": ""
}
}
```
# CANCELLED CHEQUE
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/cancelled-cheque
This page provides the success response of the Smart OCR API for the Vehicle Registration Certificate (RC) document.
```Text CANCELLED_CHEQUE theme={"dark"}
{
"verification_id": "test_verification_id1",
"reference_id": 1358,
"status": "VALID",
"document_type": "CANCELLED_CHEQUE",
"document_fields": {
"ifsc": "ABCD1234567",
"pincode": "522201",
"account_number": "123456789012",
"bank_name": "State Bank Of India",
"cheque_number": "123456",
"account_type": "Current",
"micr_code": "123456789",
"contact": "8644225960",
"branch": "TENALI BAZAR",
"name": "JohnDoe",
"split_address": {
"district": "UNTUR DISTRICT",
"state": "ANDHRA PRADESH",
"city": "TENALI",
"pincode": "522201",
"country": "INDIA"
},
"address_line": "RMZ Eco world, Building 7 10th Floor, Devarabeesanahalli, Marathalli Outer Ring road, Bangalore - 560103",
"issue_date": "2024-10-02",
"expiry_date": "2024-10-30"
}
}
```
# INVOICE
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/invoice
This page provides the success response of the Smart OCR API for the Invoice document.
```Text INVOICE theme={"dark"}
{
"verification_id": "test_verification_id1",
"reference_id": 1358,
"status": "VALID",
"document_type": "INVOICE",
"document_fields": {
"vendor": {
"name": "Tech Solutions Pvt Ltd",
"address": "1234, Business Park, MG Road, Bangalore, Karnataka, 560001, IN",
"contact": "9876543210",
"email": "contact@techsolutions.com",
"gstin": "29AALCT1234E1Z9",
"state": "Karnataka",
"state_code": "29",
"pan": "AALCT1234E"
},
"buyer": {
"name": "Global Enterprises",
"address": "5678, Industrial Complex, Sector 15, Noida, Uttar Pradesh, 201301, IN",
"contact_person": "Ravi Kumar",
"contact": "9123456789",
"gstin": "09AABCG1234C1Z5",
"state": "Uttar Pradesh",
"state_code": "09",
"place_of_supply": "Uttar Pradesh"
},
"invoice_details": {
"invoice_number": "INV-20250319-001",
"invoice_date": "2025-03-19",
"order_reference": {
"order_ref_no": "ORD-20250318-1234",
"order_ref_date": "2025-03-18"
},
"indent": {
"indent_no": "IND-20250317-5678",
"indent_date": "2025-03-17"
},
"dispatched_through": "XYZ Logistics",
"payment_terms": "Net 30 Days",
"sales_person": "John Doe",
"destination": "Noida, Uttar Pradesh"
},
"line_items": [
{
"item_no": 1,
"model_no": "PROD-001",
"description": "Wireless Mouse Model X, 2.4 GHz, Black, Ergonomic Design",
"total_amount": 1200.00,
"unit_rate": 200.00,
"quantity": 6,
"alternate_quantity": 6,
"hsn_sac": "84716040"
},
{
"item_no": 2,
"model_no": "PROD-002",
"description": "Mechanical Keyboard, RGB Backlit, USB-C, 104 Keys",
"total_amount": 3000.00,
"unit_rate": 750.00,
"quantity": 4,
"alternate_quantity": 4,
"hsn_sac": "84716090"
}
],
"totals": {
"sub_total": 4200.00,
"igst": 0.00,
"cgst": 378.00,
"sgst": 378.00,
"round_off": 0.00,
"grand_total": 4956.00,
"amount_in_words": "Four Thousand Nine Hundred Fifty-Six Only"
},
"bank_details": {
"bank_name": "HDFC Bank",
"account_number": "123456789012",
"branch_ifs": "HDFC0000123",
"swift_code": "HDFCINBBXXX"
},
"declaration": "This is a computer-generated invoice and does not require a signature.",
"additional_info": {
"delivery_note": "DN-20250319-001",
"po_no": "PO-20250318-1234",
"po_date": "2025-03-18",
"order_form_no": "OF-20250318-5678",
"proforma_invoice_no": "PI-20250318-001",
"proforma_invoice_date": "2025-03-18"
}
}
}
```
# PAN
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/pan
This page provides the success response of Smart OCR API for PAN document.
```
{
"verification_id": "test_verification_id",
"reference_id": 1358,
"status": "VALID",
"document_type": "PAN_OCR",
"document_fields": {
"pan": "DUXPR7763F",
"dob": "2004-10-02",
"name": "John Doe",
"father": "Josh Doe"
},
"quality_checks": {
"blur": true,
"glare": false,
"partially_present": false,
"black_and_white": false,
"face_present": true,
"face_clear": true,
"qr_present": false,
"obscured": false
},
"fraud_checks": {
"is_screenshot": true,
"is_photo_of_screen": false,
"is_photo_imposed": false,
"is_overwritten": false
},
"verification_details": {
"reference_id": 98237899,
"status": "VALID",
"pan": "DUXPR7763F",
"name": "John Doe",
"dob": "2004-10-02",
"name_match": "Y",
"dob_match": "Y",
"pan_status": "E",
"aadhaar_seeding_status": "Y",
"aadhaar_seeding_status_desc": "Aadhaar is linked to PAN"
}
}
```
# Passport
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/passport
This page provides the success response of the Smart OCR API for the Passport document.
```Text PASSPORT_FRONT theme={"dark"}
{
"verification_id": "test_verification_id",
"reference_id": 1358,
"status": "VALID",
"document_type": "PASSPORT_FRONT",
"document_fields": {
"birth_city": "Gwalior",
"country_code": "IND",
"dob": "1964-02-15",
"expiry_date": "2023-06-05",
"gender": "M",
"given_name": "John Doe",
"issue_city": "Gwalior",
"issue_date": "2013-06-06",
"mrz": {
"line1": "P
# Vehicle RC
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/vehicle-rc
This page provides the success response of the Smart OCR API for the Vehicle Registration Certificate (RC) document.
```Text VEHICLE_RC theme={"dark"}
{
"verification_id": "test_verification_id1",
"reference_id": 1358,
"status": "VALID",
"document_type": "VEHICLE_RC",
"document_fields": {
"address": "S / O Josh Doe, 202-parivar daser complex , dal bazar , Gird , Gwalior , Lashkar City , Madhya Pradesh , 474019",
"chassis_number": "AB2A36FX5RCA68564",
"engine_number": "ABCDEA82167",
"manufacturer_name": "BAJAJ AUTO LTD",
"manufacturing_date": "2024-04",
"owner_name": "John Doe",
"registration_date": "2024-05-22",
"registration_number": "UP12KD1234",
"registration_validity": "2039-05-21",
"relation_name": "Josh Doe",
"type": "ind_rc",
"vehicle_model": "PULSAR NS 200",
"vehicle_type": "M-Cycle/Scooter"
}
}
```
# Voter ID
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/smart-ocr/success-responses/voterId
This page provides the success response of the Smart OCR API for the Voter ID document.
```Text VOTER_ID_FRONT theme={"dark"}
{
"verification_id": "test_verification_id",
"reference_id": 1358,
"status": "VALID",
"document_type": "VOTER_ID_FRONT",
"document_fields": {
"age_on_issue_date": "20",
"dob": "2004-06-10",
"epic_number": "ABC1234567",
"gender": "Male",
"issue_date": "2024-09-07",
"name": "John Doe",
"relative_name": "Josh Doe",
"type_voter_id": "New"
}
}
```
```Text VOTER_ID_BACK theme={"dark"}
{
"verification_id": "test_verification_id",
"reference_id": 1358,
"status": "VALID",
"document_type": "VOTER_ID_BACK",
"document_fields": {
"address": "S / O Josh Doe, 202-parivar daser complex , dal bazar , Gird , Gwalior , Lashkar City , Madhya Pradesh , 474019",
"age_on_issue_date": "20",
"dob": "2004-06-10",
"epic_number": "ABC1234567",
"gender": "Male",
"issue_date": "2024-09-07",
"state": "Gwalior",
"type_voter_id": "New"
}
}
```
# Verify Udyam
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/udyam/verify-udyam
post /udyam
Use this API to verify the authenticity of your customer's Udyam registration. You need to enter the Udyam reference number and we retrieve complete enterprise details including enterprise data, NIC classification, and enterprise units information. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#udyam) and use the information to trigger the validations. The test data are usable only in the test environments such as sandbox.
# Get Vehicle RC Status
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details
get /vehicle-rc
Vehicle RC get status
# Verify Vehicle RC Details
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details-1
post /vehicle-rc
Use this API to verify the authenticity of vehicle details. We help you find out the complete information of the vehicle including the owner, chassis number, registration date, registration number, and more. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#registration-certificate-vehicle) and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.
# API Rate Limits
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/verification-rate-limits
To maintain service reliability, protect against abuse, and ensure consistent quality of service for all users, the following rate limits apply to the APIs. All Secure ID verification APIs are subject to rate limits measured in **transactions per minute (TPM)**. These limits apply per merchant account and are categorised based on resource requirements and typical usage patterns of each API.
**100 TPM**: Verification APIs that require real-time processing and external data validation
**200 TPM**: Lightweight verification services with faster processing capabilities
**5 TPM**: Resource-intensive bulk operations that require significant processing time
## Rate limits
**Standard rate limit: 100 transactions per minute**
Secure ID APIs that require real-time processing and external data validation.
| API | Description |
| :--------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------- |
| [Aadhaar Masking](/api-reference/vrs/v2/aadhaar/aadhaar-masking) | Masks sensitive Aadhaar information |
| [Bank Account Verification Async V2](/api-reference/vrs/v2/bav-v2/bank-account-verification-async-v2) | Asynchronous bank account validation |
| [Bank Account Verification Sync V2](/api-reference/vrs/v2/bav-v2/bank-account-verification-sync-v2) | Synchronous bank account validation |
| [Create Auth Token](/api-reference/vrs/v2/video-kyc/oauth-token) | Creates authentication token for Video KYC |
| [Create E-Sign Request](/api-reference/vrs/v2/e-sign/create-e-sign-request) | Initiates electronic signature process |
| [Create User for Secure ID Suite](/api-reference/vrs/v2/video-kyc/add-user) | Creates user profile for Video KYC |
| [Data Availability](/api-reference/vrs/v2/data-availability/data-availability) | Checks data availability for verification |
| [Deactivate Static KYC Link](/api-reference/vrs/v2/static-kyc/deactivate-static-kyc-link) | Deactivates static KYC verification link |
| [Driving Licence](/api-reference/vrs/v2/driving-license/verify-driving-licence-details) | Validates driving licence information |
| [Employee Details](/api-reference/vrs/v2/advanced-employment/get-employment-details) | Retrieves employment verification data |
| [Face Match](/api-reference/vrs/v2/face-match/face-match) | Compares facial biometric data |
| [Fetch Financial Information](/api-reference/vrs/v2/financial-info/fetch-financial-information) | Retrieves financial account information |
| [Fetch GSTIN with PAN](/api-reference/vrs/v2/pan-to-gstin/fetch-gstin-with-pan) | Retrieves GST numbers linked to PAN |
| [GETFetch User Details From Access Token](/api-reference/vrs/v2/oauth/get-user-details-from-access-token) | Retrieves user details using access token |
| [Generate Static KYC Link](/api-reference/vrs/v2/static-kyc/generate-static-kyc-link) | Generates static KYC verification link |
| [Geocoding](/api-reference/vrs/v2/geocoding/geocoding) | Converts address to geographical coordinates |
| [Get BAV Status V2](/api-reference/vrs/v2/bav-v2/get-bav-status-v2) | Retrieves bank account verification status |
| [Get Consent Status](/api-reference/vrs/v2/consent/get-consent-status) | Checks consent status for data access |
| [Get E-Sign Status](/api-reference/vrs/v2/e-sign/get-e-sign-status) | Checks electronic signature status |
| [Get Status for Verify PAN in Bulk](/api-reference/vrs/v2/pan/get-status-for-verify-pan-in-bulk) | Retrieves bulk PAN verification status |
| [Get Status of Aadhaar Verification via OCR](/api-reference/vrs/v2/aadhaar/get-status-of-aadhaar-verification-via-ocr) | Checks OCR-based Aadhaar verification |
| [Get Status of PAN Verification via Smart OCR](/api-reference/vrs/v2/smart-ocr/smart-ocr) | Checks OCR-based PAN verification |
| [Get Status of Verify PAN Sync](/api-reference/vrs/v2/pan/get-status-of-verify-pan-sync) | Checks synchronous PAN verification status |
| [Get Video KYC Status](/api-reference/vrs/v2/video-kyc/get-vkyc-status) | Gets Video KYC session status |
| [IFSC Verification V2](/api-reference/vrs/v2/ifsc/ifsc-verification-v2) | Validates IFSC codes and retrieves bank branch details |
| [Initiate Video KYC Request](/api-reference/vrs/v2/video-kyc/initiate-vkyc) | Starts Video KYC verification process |
| [Mobile 360 Send OTP Request](/api-reference/vrs/v2/mobile-360/send-otp-request) | Sends OTP for mobile verification |
| [Mobile 360 Verify OTP](/api-reference/vrs/v2/mobile-360/verify-otp) | Verifies OTP for mobile authentication |
| [Name Match](/api-reference/vrs/v2/name-match/name-match) | Compares name variations and matches |
| [PAN 360](/api-reference/vrs/v2/pan/pan-360) | Comprehensive PAN details and validation |
| [Initiate OAuth](/api-reference/vrs/v2/oauth/initiate-oauth) | Initiates OAuth authentication process |
| [OAuth Access Token Generation](/api-reference/vrs/v2/oauth/oauth-access-token-generation) | Generates OAuth access token |
| [Passport](/api-reference/vrs/v2/passport/verify-passport) | Validates passport information |
| [Request Consent](/api-reference/vrs/v2/consent/request-consent) | Requests user consent for data access |
| [Request Financial Information](/api-reference/vrs/v2/financial-info/request-financial-information) | Requests access to financial data |
| [Reverse Geocoding](/api-reference/vrs/v2/reverse-geocoding/reverse-geocoding) | Converts coordinates to address information |
| [Smart OCR](/api-reference/vrs/v2/smart-ocr/smart-ocr) | Optical character recognition for documents |
| [Upload Document For E-Sign](/api-reference/vrs/v2/e-sign/upload-document-for-e-sign) | Uploads documents for electronic signing |
| [Vehicle RC](/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details) | Retrieves vehicle registration details |
| [Verify CIN](/api-reference/vrs/v2/cin/verify-cin) | Validates Corporate Identity Numbers |
| [Verify GSTIN](/api-reference/vrs/v2/gstin/verify-gstin) | Validates GST identification numbers |
| [Voter ID](/api-reference/vrs/v2/voter-id/verify-voter-id) | Validates voter identification cards |
**Medium rate limit: 200 transactions per minute**
Lightweight verification services with faster processing capabilities.
| API | Description |
| :------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------- |
| [Create DigiLocker URL](/api-reference/vrs/v2/digilocker/create-digilocker-url) | Creates DigiLocker integration link |
| [Create Reverse Penny Drop Request](/api-reference/vrs/v2/reverse-penny-drop/create-reverse-penny-drop-request) | Initiates reverse penny drop verification |
| [Generate KYC Link](/api-reference/vrs/v2/1-click-onboarding/generate-kyc-link) | Generates KYC verification link |
| [Get DigiLocker Verification Status](/api-reference/vrs/v2/digilocker/get-digilocker-verification-status) | Checks DigiLocker document verification |
| [Get Document from DigiLocker](/api-reference/vrs/v2/digilocker/get-document-from-digilocker) | Retrieves documents from DigiLocker |
| [Get KYC Link Status](/api-reference/vrs/v2/1-click-onboarding/get-1-click-onboarding-status) | Gets KYC link verification status |
| [Get Reverse Penny Drop Request Details](/api-reference/vrs/v2/reverse-penny-drop/get-reverse-penny-drop-request-details) | Retrieves reverse penny drop status |
| [IP](/api-reference/vrs/v2/ip/verify-ip) | Validates IP address information |
| [Verify PAN Sync](/api-reference/vrs/v2/pan/verify-pan-sync) | Synchronous PAN verification |
**Restricted rate limit: 5 transactions per minute**
Resource-intensive bulk operations that require significant processing time.
| API | Description |
| :----------------------------------------------------------------- | :-------------------------------------------------- |
| [Verify PAN in Bulk](/api-reference/vrs/v2/pan/verify-pan-in-bulk) | Processes multiple PAN verifications simultaneously |
## Rate limit error handling
When you exceed the rate limit for any API, the system returns an HTTP 429 status code.
The following response structure is returned when rate limits are exceeded:
```json theme={"dark"}
{
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Too many requests",
"details": [
{
"field": "rate_limit",
"issue": "Rate limit exceeded for this endpoint"
}
]
}
```
## Best practices for rate limit management
Use these guidelines to optimise your API usage and avoid rate limit errors.
When you receive a 429 response, implement retry logic with exponential backoff:
```javascript theme={"dark"}
async function makeAPIRequest(url, options, maxRetries = 3) {
for (let attempt = 1; attempt <= maxRetries; attempt++) {
try {
const response = await fetch(url, options);
if (response.status === 429) {
const retryAfter = response.headers.get('retry-after');
const delay = retryAfter ? parseInt(retryAfter) * 1000 : Math.pow(2, attempt) * 1000;
console.log(`Rate limit exceeded. Retrying after ${delay}ms`);
await new Promise(resolve => setTimeout(resolve, delay));
continue;
}
return response;
} catch (error) {
if (attempt === maxRetries) throw error;
}
}
}
```
Check the rate limit headers in successful responses to proactively manage your request timing:
```javascript theme={"dark"}
const response = await fetch('/api/verify-gstin', options);
const remaining = response.headers.get('X-RateLimit-Remaining');
const resetTime = response.headers.get('X-RateLimit-Reset');
if (parseInt(remaining) < 10) {
console.log('Approaching rate limit. Consider slowing down requests.');
}
```
Avoid sending bursts of requests at the beginning of each minute. Instead, distribute your requests evenly throughout the time window.
**Example strategy:**
* For 100 TPM limit: Send 1 request every \~600ms
* For 200 TPM limit: Send 1 request every \~300ms
* For 5 TPM limit: Send 1 request every \~12 seconds
## Requesting rate limit increases
If your application requires higher rate limits, you can submit a request through the [support form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) or contact your account manager directly. When you submit your request, include the following information:
* Your merchant ID
* Current usage patterns and volumes
* Expected future usage requirements
* Business justification for the increase
Your account manager can provide faster processing and personalized assistance for rate limit increase requests.
# Create User for Secure ID
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/add-user
post /user
Use this API to create a new user profile for the Secure ID, which enables Video KYC (Know Your Customer) verification. The user profile includes basic details such as phone number, name, and address, and is required to initiate the KYC process.
# Get User Detail
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/get-user
get /user
Use this API to retrieve the details of a user registered for Video KYC. You can fetch user information using either the **user_id** (provided by you) or the **user_reference_id** (generated by Cashfree).
# Get status of Video KYC
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/get-vkyc-status
get /vkyc
Use this API to check the status of a Video KYC (vKYC) request. You can query the request using the **reference_id** (generated by Cashfree) or the **verification_id** (created by you). The response includes the current status, vKYC link, link expiry, and optional Aadhaar and security question details.
# Initiate Video KYC Request
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/initiate-vkyc
post /vkyc
Use this API to initiate a Video KYC request for a user by generating a secure verification link. The link is sent through selected notification channels (SMS, email, or WhatsApp) and can be customised using user and agent templates.
**Template Behavior**: Including Aadhaar details in this request skips the DigiLocker verification step, reducing the user journey from 3 steps to 2. See [User Templates](/api-reference/vrs/v2/video-kyc/vkyc-descriptions#user-templates) for details.
# Create Auth Token to Initialise the SDK
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/oauth-token
post /oauth/token
Use this API to generate an authentication token required to initialize the Cashfree SDK. Provide your **app_id**, and product name (such as Video KYC) in the request body. The API returns an **access_token** and its expiry details.
# Update User Detail
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/update-user
patch /user
Update User Detail
# Status Codes and Templates
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/vkyc-descriptions
Understand VKYC status codes, sub-status combinations, user templates, and agent templates for Video KYC implementation.
This reference guide explains the status codes, user templates, and agent templates available for Video KYC (VKYC) implementation. Use this information to understand response parameters and configure your VKYC flow.
## Status and sub-status reference
The following table describes all possible status and sub-status combinations returned by the VKYC API, along with recommended actions for each scenario.
### Request status types
The status codes are organised by verification phase. Each phase contains specific sub-status codes that indicate the current state and required actions.
| Sub-status | Description | Recommended action |
| ---------------------- | --------------------------------------------------- | ----------------------------------------------- |
| `INSUFFICIENT_BALANCE` | The request is rejected due to insufficient balance | Add funds to your account and retry the request |
| Sub-status | Description | Recommended action |
| ---------------- | ------------------------------------------------- | ----------------------------------------------------------- |
| `LINK_GENERATED` | The link for Video KYC was generated successfully | Share the link with the user through your preferred channel |
| Sub-status | Description | Recommended action |
| ------------------------------------ | ----------------------------------------------------- | ------------------------------------------------------ |
| `AADHAAR_VERIFICATION_SUCCESS` | The user's Aadhaar details were verified successfully | Proceed to the next verification step |
| `AADHAAR_VERIFICATION_FAILED` | The user's Aadhaar details could not be verified | Ask the user to retry with correct Aadhaar information |
| `AADHAAR_VERIFICATION_EXPIRED` | The Aadhaar verification session expired | Restart the Aadhaar verification process |
| `USER_IP_VERIFICATION_SUCCESSFUL` | The user's IP address was verified successfully | Continue with the verification flow |
| `USER_PROXY_DETECTED` | A proxy or VPN was detected | Ask the user to disable proxy/VPN and retry |
| `TECHNICAL_FAILURE` | A technical issue occurred during verification | Retry after some time or contact support |
| `USER_LOCATION_VERIFICATION_SUCCESS` | The user's location was verified successfully | Proceed to device checks |
| `USER_LOCATION_OUTSIDE_INDIA` | The user is outside India | Reject the request or ask user to retry from India |
| `USER_AUDIO_CHECK_FAILED` | The user's microphone is not enabled | Ask the user to enable microphone access |
| `USER_VIDEO_CHECK_FAILED` | The user's camera is not enabled | Ask the user to enable camera access |
| `USER_LOCATION_PERMISSION_DISABLED` | The user did not grant location access | Ask the user to allow location permissions |
| `USER_DEVICE_CHECK_SUCCESS` | The user's device passed all checks | Proceed to agent assignment |
| `USER_QUEUED` | The user is waiting for an available agent | Display queue position and estimated wait time |
| `SCHEDULED_USER_QUEUED` | The user is queued for a scheduled appointment | Notify user of scheduled time |
| `NO_AGENT_FOUND` | No agent is available at this time | Retry after some time or offer scheduling |
| `AGENT_ASSIGNED_TO_USER` | An agent has been assigned to the user | Notify user that verification will begin |
| `USER_MEETING_SCHEDULED` | The user's meeting is scheduled successfully | Send meeting details to the user |
| `USER_MEETING_CANCELLED` | The user's meeting was cancelled | Offer rescheduling options |
| Sub-status | Description | Recommended action |
| ----------------------- | ------------------------------------------ | ----------------------------------------- |
| `USER_ACCEPTED_MEETING` | The user accepted the meeting invitation | Start the VKYC verification process |
| `USER_REJECTED_MEETING` | The user rejected the meeting invitation | Reschedule or mark verification as failed |
| `USER_MISSED_MEETING` | The user missed the scheduled meeting | Offer rescheduling options |
| `USER_DROPPED_OFF` | The user disconnected during verification | Log the issue and offer reconnection |
| `AGENT_DROPPED_OFF` | The agent disconnected during verification | Retry with another agent |
| `USER_ENDED_CALL` | The user ended the call | Review session completeness |
| `AGENT_ENDED_CALL` | The agent ended the call | Review agent's remarks and next steps |
| Sub-status | Description | Recommended action |
| ----------------- | ---------------------------------------------- | --------------------------------------------- |
| `TECHNICAL_ERROR` | A technical error occurred during verification | Retry the verification or escalate to support |
| Sub-status | Description | Recommended action |
| -------------------------- | ---------------------------------------------- | --------------------------------------- |
| `AGENT_APPROVED` | The agent approved the user's KYC verification | Proceed to auditor review stage |
| `AGENT_REJECTED` | The agent rejected the user's KYC verification | Notify user with rejection reason |
| `AGENT_UNABLE_TO_VALIDATE` | The agent could not complete validation | Retry with another agent or new session |
| Sub-status | Description | Recommended action |
| ------------------ | ------------------------------------------------ | ----------------------------- |
| `AUDITOR_APPROVED` | The auditor approved the user's KYC verification | Mark verification as complete |
| `AUDITOR_REJECTED` | The auditor rejected the user's KYC verification | Mark verification as failed |
## User templates
User templates define the customer journey and determine which verification steps are included in the VKYC process. The template you choose affects the user experience and verification flow.
### vkyc\_user\_template\_v1
This is the standard template that includes mobile OTP authentication, conditional DigiLocker Aadhaar verification, and agent-assisted video verification.
The template behaviour depends on whether Aadhaar details are provided in the [Initiate Video KYC Request](/api-reference/vrs/v2/video-kyc/initiate-vkyc):
**When Aadhaar details are provided:** The DigiLocker verification step is skipped, creating a streamlined 2-step process.
**When Aadhaar details are not provided:** The complete 3-step verification process including DigiLocker authentication.
**Custom templates:** To create a custom `user_template` tailored to your specific requirements, contact your account manager.
## Agent templates
Agent templates define the verification steps that agents must complete during the VKYC process. These templates ensure consistent verification procedures across all sessions.
### vkyc\_agent\_template\_v1
This is the default template used by verification agents during the VKYC process. It includes standardised verification steps and documentation requirements.
**Custom agent templates:** To create a custom `agent_template` with specific verification steps or compliance requirements, contact your account manager.
# Video KYC Integration
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/vkyc-integration
Cashfree Video KYC (VKYC) is a secure, RBI-compliant digital customer verification solution that enables businesses to complete customer onboarding remotely through a live video interaction. Merchants can choose to integrate VKYC in two ways, depending on their user experience requirements and technical capabilities.
Cashfree offers the following ways to integrate VKYC:
**Integrating using the SDK**
* Integrate the VKYC process directly into your web or mobile application.
* Provide a seamless in-app experience for customers without redirecting them.
* Support an OTP-less flow if the customer is already authenticated in your application.
* Use SDK callbacks to handle events such as success, failure, or closure, and to track activity and customise your user interface.
**Integrating using the APIs**
* Generate a unique VKYC link for each customer.
* Share the link via SMS, email, or any external channel.
* Allow customers to complete the VKYC process outside your application.
The VKYC SDK supports **Web**, **Android**, and **iOS** platforms and communicates securely with Cashfree servers through callbacks.
This topic includes the following sections:
1. [SDK VKYC flow](/api-reference/vrs/v2/video-kyc/vkyc-integration#sdk-vkyc-flow)
2. [Initialising SDK](#initialising-sdk)
3. [Callback structure](#callback-structure)
### SDK VKYC flow
Refer to the steps below for the VKYC flow for SDK:
1. Create the user using the [Create User for Secure ID Suite API](/api-reference/vrs/v2/video-kyc/add-user). You must complete this step before initiating the VKYC session.
2. Start the VKYC session using the [Initiate Video KYC Request API](/api-reference/vrs/v2/video-kyc/initiate-vkyc). Pass the user ID and authentication token to the SDK.
3. Generate an authentication token using the [Create Auth Token API](/api-reference/vrs/v2/video-kyc/oauth-token). This token is required to initialise the SDK. Use it to bypass OTP verification if the user is already authenticated in your application.
4. Retrieve the current session status using the [Get Video KYC Status API](/api-reference/vrs/v2/video-kyc/get-vkyc-status).
5. Configure webhooks to receive real-time updates on VKYC events. For more information, refer to [Webhook](/api-reference/vrs/v2/video-kyc/webhook).
Refer to the image below for a sample workflow:
### Initialising SDK
Refer to the instructions below to initialise the SDK for your target platform. The SDK communicates with Cashfree and provides real-time updates through callbacks.
You can initialise the SDK for:
* [Web](/api-reference/vrs/v2/video-kyc/vkyc-integration#web-integration)
* [Android native](/api-reference/vrs/v2/video-kyc/vkyc-integration#android-native-integration)
* [iOS native](/api-reference/vrs/v2/video-kyc/vkyc-integration#ios-native-integration)
#### Web integration
**Initialise the Web SDK**
Refer to the example code snippet below to initialise the Web SDK:
```javascript theme={"dark"}
const vkyc = CFVKYC({
srcUrl: "https://forms.cashfree.com/verification/",
oAuthToken: "", // Optional: enables OTP-less flow
callback: (response) => {
console.log("VKYC Response:", response);
},
});
```
| Parameter | Type | Required | Description |
| ------------ | -------- | -------- | --------------------------------------- |
| `srcUrl` | string | Yes | Base or full VKYC verification URL. |
| `oAuthToken` | string | No | Pass this token for OTP-less flow. |
| `callback` | function | Yes | Handles all SDK messages and responses. |
Do not pass the OAuth token if you want Cashfree to perform the OTP check.
**Close the SDK programmatically**
Refer to the code snippet below to close the SDK instance in your application:
```javascript theme={"dark"}
vkyc.closeSDK();
```
**Import the hosted JavaScript SDK**
Refer to the instructions below to import the SDK script into your HTML page.
1. Add the SDK script for your environment.
**Production environment:**
```html theme={"dark"}
```
**Sandbox environment:**
```html theme={"dark"}
```
2. Include a `
## Consent webhook event
| Event | Description |
| :---------------------------------- | :------------------- |
| AA\_CONSENT\_VERIFICATION\_SUCCESS | Consent is approved. |
| AA\_CONSENT\_VERIFICATION\_PAUSED | Consent is paused. |
| AA\_CONSENT\_VERIFICATION\_REVOKED | Consent is revoked. |
| AA\_CONSENT\_VERIFICATION\_REJECTED | Consent is rejected. |
| AA\_CONSENT\_VERIFICATION\_EXPIRED | Consent has expired. |
## Use case scenario
A financial advisory firm, X, offers a digital platform that provides personalised financial planning and investment advice. To deliver accurate and tailored advice to clients, X leverages Cashfree Payments' Account Aggregator APIs to access and aggregate financial data.
### Steps involved
1. **Client onboarding**
Preethi signs up for X's financial planning service. To create a plan, X requires access to Preethi's complete financial data.
2. **Consent request**
X uses Cashfree Payments' Account Aggregator APIs to request Preethi's consent to access her financial data. X specifies what kind of financial information they require in the **[Request Consent](/api-reference/vrs/v2/account-aggregator/account-aggregator-consent-request)** API. The API directs Preethi to authenticate with her bank and other financial institutions to grant permission.
3. **Data collection**
Once Preethi provides consent, the **[Request Financial Information](/api-reference/vrs/v2/account-aggregator/account-aggregator-request-fi)** API connects to her various financial accounts and retrieves relevant data such as account balances, transaction histories, income statements, and investment holdings.
4. **Data Aggregation**
Cashfree Payments consolidates this data into a standardised format and X can view them using **[Fetch Financial Information](/api-reference/vrs/v2/account-aggregator/account-aggregator-request-fi)**. This allows the firm to view Preethi’s complete financial profile in one place.
5. **Financial Analysis**
X’s platform analyses the aggregated data to assess Preethi’s financial health. This includes evaluating her spending patterns, savings, investment performance, and overall financial situation.
6. **Personalised Recommendations**
Based on the analysis, X generates tailored financial advice and investment recommendations for Preethi. This might include budgeting strategies, savings goals, investment opportunities, and retirement planning tips.
7. **Client Review and Feedback**
Preethi reviews the personalised financial plan and recommendations through X's platform. She can provide feedback, ask questions, and make adjustments to her financial strategy based on the advice received.
# Get Employment Details
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/advanced-employment/get-employment-details
post /advance-employment
Use this API to to retrieve an individual's recent employment details such as member ID, joining date, and exit date of the company. Verifying the employment information of the individual mitigates risk and prevents fraud. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#employment-information) and use the information to trigger the validations. The test data are usable only in the sandbox environment.
# Bank Account Verification Async V2
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bank-account-verification-async-v2
post /bank-account/async
Use this API to verify bank account information. It is an aysnc request. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. You can use the test data only in sandbox environment.
## Webhook event
| Event | Description |
| :------------------------------------ | :-------------------------------------- |
| BANK\_ACCOUNT\_VERIFICATION\_SUCCESS | Bank account verification is a success. |
| BANK\_ACCOUNT\_VERIFICATION\_REJECTED | Bank account verification is rejected. |
| BANK\_ACCOUNT\_VERIFICATION\_FAILED | Bank account verification is a failure. |
# React Native Integration
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/digilocker/digilocker-sdk
Learn more about integrating Cashfree SDK in your react native application.
Cashfree’s react native DigiLocker SDK allows you to seamlessly integrate DigiLocker-based identity verification into your mobile application. With this SDK, you can securely initiate DigiLocker flows, collect user consent, and retrieve verified government-issued documents.
This guide provides step-by-step instructions to help you:
* Install and configure the React Native SDK.
* Generate DigiLocker consent URLs from your backend.
* Launch DigiLocker in your React Native app.
* Handle consent flows and user responses.
* Fetch and verify user documents via secure APIs.
## Webhook event
| Event Type | Description |
| :---------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
| `DIGILOCKER_VERIFICATION_SUCCESS` | Triggered when the user's DigiLocker verification is successfully completed. |
| `DIGILOCKER_VERIFICATION_LINK_EXPIRED` | Triggered when the DigiLocker URL expires due to user inaction. |
| `DIGILOCKER_VERIFICATION_CONSENT_DENIED` | Triggered when the user denies consent for DigiLocker verification. |
| `DIGILOCKER_VERIFICATION_CONSENT_EXPIRED` | Triggered when the user's document consent for DigiLocker verification expires, which occurs 1 hour after the user grants consent. |
| `DIGILOCKER_VERIFICATION_FAILURE` | Triggered when the DigiLocker verification fails due to a system error. |
### Sample webhook events
The following are examples of webhook events that you may receive.
***
## Webhook events
| Event | Description |
| :----------------------------- | :--------------------------------------------------------------------- |
| E\_SIGN\_VERIFICATION\_SUCCESS | You will receive this event when the e-sign verification is a success. |
| E\_SIGN\_VERIFICATION\_FAILURE | You will receive this event when the e-sign verification is a failure. |
| E\_SIGN\_VERIFICATION\_EXPIRED | You will receive this event when the e-sign verification is expired. |
***
## Webhook events
| Event | Description |
| :--------------------------- | :------------------------------------------------------------------------------------- |
| KYC\_LINK\_ACTION\_PERFORMED | You will receive this event when one of the verifications is performed using the link. |
| KYC\_LINK\_SUCCESS | You will receive this event when all the verifications are performed successfully. |
| KYC\_LINK\_EXPIRED | You will receive this event when the link expires. |
## Webhook event
| Event | Description |
| :---------------------------------------- | :------------------------------------------------ |
| RPD\_BANK\_ACCOUNT\_VERIFICATION\_SUCCESS | The reverse penny drop verification is a success. |
| RPD\_BANK\_ACCOUNT\_VERIFICATION\_EXPIRED | The reverse penny drop verification expired. |
| RPD\_BANK\_ACCOUNT\_VERIFICATION\_FAILURE | The reverse penny drop verification is a failure. |
User authenticates using mobile OTP sent to their registered number
Direct connection with verification agent for identity confirmation
User authenticates using mobile OTP
Aadhaar verification through DigiLocker
Agent-assisted video verification call
Standard agent interface with verification checklist and documentation requirements
### Initialising SDK
Refer to the instructions below to initialise the SDK for your target platform. The SDK communicates with Cashfree and provides real-time updates through callbacks.
You can initialise the SDK for:
* [Web](/api-reference/vrs/v2/video-kyc/vkyc-integration#web-integration)
* [Android native](/api-reference/vrs/v2/video-kyc/vkyc-integration#android-native-integration)
* [iOS native](/api-reference/vrs/v2/video-kyc/vkyc-integration#ios-native-integration)
#### Web integration
**Initialise the Web SDK**
Refer to the example code snippet below to initialise the Web SDK:
```javascript theme={"dark"}
const vkyc = CFVKYC({
srcUrl: "https://forms.cashfree.com/verification/` for the SDK container.
```html theme={"dark"}
Video KYC
```
### Android native integration
**Add the SDK dependency**
Refer to the steps below to add the SDK to your Android project.
1. Add the Maven repository in `settings.gradle.kts`.
```kotlin theme={"dark"}
repositories {
google()
mavenCentral()
maven { url = URI("https://maven.cashfree.com/release") }
}
```
2. Add the SDK dependency in `build.gradle.kts`.
```kotlin theme={"dark"}
dependencies {
implementation("com.cashfree.vrs:kyc-verification:1.0.4")
}
```
3. Click **Sync Now** in Android Studio to sync your project.
**Initialise and use the SDK**
1. Create an instance of the verification service.
```kotlin theme={"dark"}
val verificationService = CFVerificationService.Builder()
.setContext(this)
.build()
```
2. Configure the callback to handle verification responses.
```kotlin theme={"dark"}
verificationService.setKycVerificationCallback(object : CFVerificationCallback {
override fun onVerificationResponse(response: CFVerificationResponse) {
showAlert(response)
}
override fun onErrorResponse(error: CFErrorResponse) {
showAlert("Verification Error", error.message)
}
override fun onVKycCloseResponse(response: CFVKycCloseResponse) {
showAlert("VKYC Closed", response.verificationId)
}
})
```
3. Initiate the verification process.
```kotlin theme={"dark"}
verificationService.doVerification(kycUrl, token)
```
| Parameter | Description |
| --------- | ----------------------------- |
| `kycUrl` | VKYC video call URL |
| `token` | Authentication token for VKYC |
### iOS native integration
The following are the requirements before integrating the iOS SDK:
* iOS version: 13.0 or later
* Swift version: 5.0 or later
* Xcode version: 14.0 or later
**Install the SDK**
To install the SDK:
1. Open your Xcode project.
2. Go to **File > Add Packages**.
3. Enter the repository URL:
```
https://github.com/cashfree/KycVerificationSdk.git
```
4. Select the version and add the package to your project.
**Initialise and use the SDK**
1. Create an instance.
```swift theme={"dark"}
let kycService = CFVerificationService.getInstance()
```
2. Set up callback handlers.
```swift theme={"dark"}
func onVerificationCompletion(verificationResponse: KycVerificationSdk.CFVerificationResponse) {
if verificationResponse.status == "SUCCESS" {
print("Success: Verification successful")
} else {
print("Error: Verification failed, please try again")
}
}
func onErrorResponse(errorReponse: KycVerificationSdk.CFErrorResponse) {
print("Error: \(errorReponse.message ?? "")")
}
func onVerification(_ verificationResponse: KycVerificationSdk.CFSecureShareResponse) {
print("Verification ID: \(verificationResponse.verificationId ?? "N/A")")
}
func onVerificationError(_ errorResponse: KycVerificationSdk.CFSecureShareErrorResponse) {
print("Error Status: \(errorResponse.status ?? "N/A")")
}
func onUserDrop(_ userDropResponse: KycVerificationSdk.CFUserDropResponse) {
print("User Dropped: \(userDropResponse.verificationId ?? "N/A")")
}
func onVkycCloseResponse(verificationResponse: KycVerificationSdk.CFVKycCloseResponse) {
print("VKYC Closed")
}
```
3. Start the VKYC session.
```swift theme={"dark"}
do {
let kycService = CFVerificationService.getInstance()
try kycService.doVerification(kycUrl, self, self, accessToken)
} catch let error {
print("Error: \(error)")
}
```
### Callback structure
Refer to the sample response below for the VKYC callback structure:
```json theme={"dark"}
{
"verificationId": "verificationId_value",
"status": ""
}
```
| Status | Description |
| ----------------- | --------------------------------------------- |
| `TOKEN_EXPIRED` | The OAuth token has expired. |
| `SRC_URL_MISSING` | The `srcUrl` parameter isn't provided. |
| `DIV_MISSING` | The `
` with ID `cf-vkyc-sdk` is missing. |
| `CLOSE` | The SDK session was closed by Cashfree. |
**Additional Notes:**
* Ensure the `
` with ID `cf-vkyc-sdk` exists in your HTML.
* The SDK applies default styling for consistent behaviour. Custom styling is not supported.
* The embedded iframe uses sandboxing for secure interactions.
Use a standalone link if you prefer to reach customers through external channels instead of integrating the flow in your app.
To share a standalone VKYC link integrate the following APIs:
1. Create the user using the [Create User for Secure ID Suite API](/api-reference/vrs/v2/video-kyc/add-user). You must complete this step before initiating the VKYC session.
2. Get the VKYC link using the [Initiate Video KYC Request API](/api-reference/vrs/v2/video-kyc/initiate-vkyc). Pass the user ID.
3. Retrieve the current session status using the [Get Video KYC Status API](/api-reference/vrs/v2/video-kyc/get-vkyc-status).
4. Configure webhooks to receive real-time updates on VKYC events. For more information, refer to [Webhook](/api-reference/vrs/v2/video-kyc/webhook).
# Integration Overview
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/vkyc-overview
Cashfree's Video KYC (VKYC) is a digital solution that enables businesses to verify customer identities remotely through a secure, agent-assisted video call. It helps businesses meet RBI-mandated Know Your Customer (KYC) requirements with a seamless, scalable, and easy-to-integrate process.
## Key features
Cashfree Video KYC (VKYC) offers the following features to help you verify your customers quickly and securely:
* **Capture a customer photograph**: Take a live photo of your customer and match it with the photo on an official KYC document, such as an Aadhaar card. This feature supports high-quality image capture, even in low-bandwidth conditions.
* **Verify customer identity**: Verify your customer's identity using OTP-based verification or through DigiLocker authentication. The details are verified against official sources.
* **Capture a PAN card image**: Capture a photo of your customer's PAN card to extract key details. These details are validated against trusted databases.
* **Use geo-tagging for compliance**: Confirm that your customer is located in India, as required by RBI regulations.
* **Perform a liveness check**: Ask a registered entity (RE) agent to confirm your customer's physical presence. During the check, the agent asks the customer to read a randomly generated 4-digit number.
* **Assign agents for VKYC**: Meet RBI requirements by completing VKYC through a live agent. Use the agent assignment module to manage and track this process.
* **Access session logs for auditing**: View logs for every VKYC session. Both you and Cashfree can use these logs for compliance audits.
## Integration options
Cashfree provides two options for integrating Video KYC based on your application flow:
* API-based integration for full control of the user experience
* SDK-based integration for an embedded, in-app experience
### Video KYC using APIs
Use this option if you want to manage the entire VKYC workflow through your backend and present a custom user interface.
1. **Create a user**: Register the user using the [Create User for Secure ID Suite API](/api-reference/vrs/v2/video-kyc/add-user). This step is required before you initiate the VKYC session. The user profile includes basic details such as phone number, name, and address, and is required to initiate the KYC process.
2. **Initiate the Video KYC session**: Start the VKYC session using the [Initiate Video KYC Request API](/api-reference/vrs/v2/video-kyc/initiate-vkyc) by generating a secure verification link. The link is sent through selected notification channels (SMS, email, or WhatsApp) and can be customised using user and agent templates.
3. **Get the VKYC status**: Retrieve the current VKYC session status using the [Get Video KYC Status API](/api-reference/vrs/v2/video-kyc/get-vkyc-status). Use this to check if the session is pending, in progress, completed, or failed.
### Video KYC using the SDK
Use this option if you want to embed the VKYC flow directly into your mobile or web application using the Cashfree SDK.
1. **Create an authentication token**: Generate an auth token using the [Create Auth Token API](/api-reference/vrs/v2/video-kyc/oauth-token). This token is required to initialise the SDK and allows you to bypass OTP verification if the user is already authenticated in your app.
2. **Create a user**: Register the user using the [Create User for Secure ID Suite API](/api-reference/vrs/v2/video-kyc/add-user). This step must be completed before you initiate the VKYC session.
3. **Initiate the Video KYC session**: Start the VKYC session using the [Initiate Video KYC Request API](/api-reference/vrs/v2/video-kyc/initiate-vkyc) and pass the user ID and authentication token to the SDK.
4. **Get the VKYC status**: Retrieve the current VKYC session status using the [Get Video KYC Status API](/api-reference/vrs/v2/video-kyc/get-vkyc-status).
**Notes**:
For detailed API documentation, refer to [Video KYC API](/api-reference/vrs/v2/video-kyc/add-user) Integration.
# Webhooks
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/webhook
Configure webhooks to receive real-time updates about VKYC events.
Webhooks are event-based notifications that are received when specific events related to Video KYC occur. These notifications help you track the status and progress of VKYC in real-time.
## Add webhooks
Add your webhook URL in our system for us to deliver webhook events.
Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/merchants/)** and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, fill in the following information:
* **Webhook URL**: Enter the URL in this field.
5. Click **Test & Add Webhook**.
## VKYC webhook events
The following events are triggered at different stages of the Video KYC process:
| Event | Description |
| :------------------------------ | :------------------------------------------------------- |
| VKYC\_USER\_LINK\_GENERATED | User VKYC link has been generated for the user |
| VKYC\_USER\_LINK\_EXPIRED | User VKYC link has expired |
| VKYC\_USER\_AADHAAR\_VERIFIED | User's Aadhaar has been successfully verified |
| VKYC\_USER\_CALL\_SCHEDULED | User VKYC call has been scheduled |
| VKYC\_USER\_PRECHECK\_FAILED | User Pre-verification checks have failed |
| VKYC\_USER\_CALL\_QUEUED | User has joined and is waiting in the queue for an agent |
| VKYC\_USER\_CALL\_STARTED | User VKYC call has started with an agent |
| VKYC\_USER\_DROPOFF\_FROM\_CALL | User has dropped off from the VKYC call |
| VKYC\_USER\_CALL\_COMPLETED | User VKYC call has been completed successfully |
```Text VKYC_USER_LINK_GENERATED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_LINK_GENERATED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "RECEIVED",
"sub_status": "LINK_GENERATED",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "",
"meeting_schedule": ""
}
}
```
```Text VKYC_USER_LINK_EXPIRED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_LINK_EXPIRED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "EXPIRED",
"sub_status": "VKYC_EXPIRED",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-05-22",
"recording_link": "",
"meeting_schedule": ""
}
}
```
```Text VKYC_USER_AADHAAR_VERIFIED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_AADHAAR_VERIFIED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "PRE_VIDEO_CALL",
"sub_status": "AADHAAR_VERIFICATION_SUCCESS",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "",
"meeting_schedule": ""
}
}
```
```Text VKYC_USER_CALL_SCHEDULED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_CALL_SCHEDULED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "PRE_VIDEO_CALL",
"sub_status": "USER_MEETING_SCHEDULED",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "",
"meeting_schedule": "2025-05-23T14:30:00Z"
}
}
```
```Text VKYC_USER_PRECHECK_FAILED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_PRECHECK_FAILED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "PRE_VIDEO_CALL",
"sub_status": "USER_VIDEO_CHECK_FAILED",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "",
"meeting_schedule": ""
}
}
```
```Text VKYC_USER_CALL_QUEUED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_CALL_QUEUED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "PRE_VIDEO_CALL",
"sub_status": "USER_QUEUED",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "",
"meeting_schedule": ""
}
}
```
```Text VKYC_USER_CALL_STARTED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_CALL_STARTED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "VIDEO_CALL",
"sub_status": "USER_ACCEPTED_MEETING",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "",
"meeting_schedule": ""
}
}
```
```Text VKYC_USER_DROPOFF_FROM_CALL theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_DROPOFF_FROM_CALL",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "VIDEO_CALL",
"sub_status": "USER_DROPPED_OFF",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "",
"meeting_schedule": ""
}
}
```
```Text VKYC_USER_CALL_COMPLETED theme={"dark"}
{
"signature": "wBBgeTOZUyXgj6vySAm9fJYCtdXvlVHQCA6dV5uVssw=",
"event_type": "VKYC_USER_CALL_COMPLETED",
"event_time": "2025-05-22T03:51:14Z",
"version": "v1",
"data": {
"verification_id": "test333",
"reference_id": 10449,
"user_reference_id": 10259,
"user_id": "test11",
"status": "POST_VIDEO_CALL",
"sub_status": "AGENT_APPROVED",
"vkyc_link": "https://forms.qa.cashfree.net/verification/c8k926bpt84g",
"link_expiry": "2025-06-21",
"recording_link": "https://storage.cashfree.com/vkyc/recordings/test333.mp4",
"meeting_schedule": ""
}
}
```
## Webhook payload fields
The webhook payload contains important metadata in its top-level fields.
| Field | Type | Description |
| ------------ | -------- | ---------------------------------------------------------------------------------------------- |
| `signature` | `string` | A Base64-encoded HMAC-SHA256 signature of the payload, generated using a shared client secret. |
| `event_type` | `string` | Indicates the type of event that triggered the webhook. |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`). |
| `version` | `string` | Indicates the webhook format being used. Default version is "v1". |
| `data` | `object` | Contains event-specific details related to this feature. |
## Important status information
For certain webhook Events, specifically **`VKYC_USER_PRECHECK_FAILED`** and **`VKYC_USER_CALL_SCHEDULED`**, you may encounter more than one `subStatus` value.
**Action:** Consult the [Status-SubStatus Mapping](https://www.cashfree.com/docs/api-reference/vrs/v2/video-kyc/vkyc-descriptions#status-substatus-mapping) for a comprehensive list.
Verifying the signature is mandatory before processing any response. Refer to [Signature Verification](/api-reference/vrs/webhook-signature-verification) for more details.
# Verify Voter ID
Source: https://www.cashfree.com/docs/api-reference/vrs/v2/voter-id/verify-voter-id
post /voter-id
Use this API to verify the authenticity of your customer's voter ID. You need to enter the Electoral Photo Identity Card (EPIC) number and we retrieve complete details including assembly and parliamentary constituency details. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#voter-id) and use the information to trigger the validations. The test data are usable only in the test environments such as sandbox.
# Webhook Signature Verification
Source: https://www.cashfree.com/docs/api-reference/vrs/webhook-signature-verification
Verifying the signature is mandatory before processing any response. It helps authenticate that the webhook is from Cashfree Payments.
Every webhook contains a signature (`x-webhook-signature`) in the header.
The verification process is as follows:
1. Extract the **`x-webhook-timestamp`** from the headers.
2. Concatenate the timestamp and the **raw request body** (exact payload, unmodified).
3. Generate an **HMAC-SHA256 hash** of this string using your **client secret**.
4. Base64-encode the hash.
5. Compare it with the `x-webhook-signature` header value. If they match, the webhook is valid.
* Always use the **raw request body** and not a parsed JSON object. This prevents signature mismatch.
* Reject the webhook if the signature does not match.
### Sample Code
```javascript Node (Express) theme={"dark"}
const crypto = require("crypto");
function verify(req) {
const ts = req.headers["x-webhook-timestamp"];
const rawBody = req.rawBody; // middleware must store raw body
const secretKey = "";
const signStr = ts + rawBody;
return crypto.createHmac("sha256", secretKey).update(signStr).digest("base64");
}
```
```go Go (Echo) theme={"dark"}
import (
"crypto/hmac"
"crypto/sha256"
"encoding/base64"
"io/ioutil"
)
func VerifySignature(expectedSig, ts, body string) (string, error) {
signStr := ts + body
key := ""
h := hmac.New(sha256.New, []byte(key))
h.Write([]byte(signStr))
b := h.Sum(nil)
return base64.StdEncoding.EncodeToString(b), nil
}
// usage
timestamp := c.Request().Header.Get("x-webhook-timestamp")
body, _ := ioutil.ReadAll(c.Request().Body)
rawBody := string(body)
signature := c.Request().Header.Get("x-webhook-signature")
VerifySignature(signature, timestamp, rawBody)
```
```php PHP theme={"dark"}
function computeSignature() {
$rawBody = file_get_contents('php://input');
$ts = getallheaders()['x-webhook-timestamp'];
$signStr = $ts . $rawBody;
$key = "";
$computeSig = base64_encode(hash_hmac('sha256', $signStr, $key, true));
return $computeSig; // compare with x-webhook-signature
}
```
```java Java (Servlet) theme={"dark"}
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.util.Base64;
public String generateSignature(HttpServletRequest request) throws Exception {
BufferedReader bufferedReader = request.getReader();
StringBuilder stringBuilder = new StringBuilder();
String line;
while ((line = bufferedReader.readLine()) != null) {
stringBuilder.append(line);
}
String payload = stringBuilder.toString();
String timestamp = request.getHeader("x-webhook-timestamp");
String data = timestamp + payload;
String secretKey = "";
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key_spec = new SecretKeySpec(secretKey.getBytes(), "HmacSHA256");
sha256_HMAC.init(secret_key_spec);
return Base64.getEncoder().encodeToString(sha256_HMAC.doFinal(data.getBytes()));
}
```
```python Python (Flask/Django) theme={"dark"}
import base64
import hashlib
import hmac
def generateSignature(request):
raw_body = request.data
payload = raw_body.decode('utf-8')
timestamp = request.headers['x-webhook-timestamp']
signatureData = timestamp + payload
message = bytes(signatureData, 'utf-8')
secretkey = bytes("", 'utf-8')
signature = base64.b64encode(hmac.new(secretkey, message, digestmod=hashlib.sha256).digest())
return signature.decode("utf-8") # compare with x-webhook-signature
```
## IPs to whitelist
When you decide to consume the webhooks, first, you need to verify if your systems need an IP whitelisting to be done at your end or not. Accordingly you can whitelist the below IPs of Cashfree:
| Sandbox |
| :------------ |
| 52.66.25.127 |
| 15.206.45.168 |
| Prod |
| :------------ |
| 52.66.101.190 |
| 3.109.102.144 |
| 3.111.60.173 |
| 18.60.134.245 |
| 18.60.183.142 |
| Port |
| :------------ |
| 443 (secured) |
# Account FAQs
Source: https://www.cashfree.com/docs/help/account/account-activation
posthog.capture('Accordion Clicked', { title: "My account is active, but settlements are on hold. What should I do?" })}>
Once your account is activated, settlements are processed according to your agreed cycle. However, settlements may be put on hold due to a few common reasons:
Penny Test not confirmed:
A small amount (₹1) is sent to your bank account to verify it's correct. You’ll receive an email titled “Bank account confirmation” or “Penny test confirmation”. Please reply to that email once you receive the amount.
Missing Website/App Policy Pages:
Ensure that your website or app includes all the required policy pages—like Privacy Policy, Refund Policy, Terms & Conditions, etc.
Pending Documents:
Double-check that you’ve submitted all the necessary documents. In some cases, additional documents may be requested. Your Account Manager will reach out if anything is missing.
If you’ve already taken care of all the above and your settlements are still on hold, please contact your Account Manager directly for the quickest resolution.
posthog.capture('Accordion Clicked', { title: " Can I add my team members to my Cashfree account?" })}>
Yes, absolutely! When you create a Cashfree account, you become the account owner by default.
You can then:
Add multiple team members to the same account
Assign roles to each user (like Finance, Tech, Support, etc.)
Control what each user can access or do based on their role
You can also customise permissions further if needed. There’s no limit to how many users you can add.
Want the full details? Check out our guide on [multi-user management](https://www.cashfree.com/blog/cashfree-user-management-manual/) to know more.
posthog.capture('Accordion Clicked', { title: "I have created an account. How long can I access the features in the test mode? Is there a trial period?" })}>
There’s no time limit on test mode—you can use it for as long as you want to try out the features.
However, to start accepting real payments or sending money, you’ll need to activate your account by submitting the required [documents](https://www.cashfree.com/docs/help/account/overview#activate-account)
posthog.capture('Accordion Clicked', { title: "Are there any specific businesses that are not supported by Cashfree?" })}>
As a business policy, Cashfree does not support businesses that deal in certain prohibited items. If your business deals in any such items, your Cashfree Payment Gateway account will not be activated.
### Prohibited items and services:
1. Adult goods and services which include pornography and other sexually suggestive materials (including literature, imagery and other media); escort or prostitution services.
2. Alcohol, which includes Alcohol or alcoholic beverages such as beer, liquor, wine, or champagne.
3. Body parts which include organs or other body parts.
4. Bulk marketing tools which include email lists, software, or other products enabling unsolicited email messages (spam).
5. Cable descramblers and black boxes, which include devices intended to obtain cable and satellite signals for free.
6. Child pornography, which includes pornographic materials involving minors.
7. Copyright-unlocking devices, which include Mod chips or other devices designed to circumvent copyright protection.
8. Copyrighted media, which includes unauthorised copies of books, music, movies, and other licensed or protected materials.
9. Copyrighted software which includes unauthorised copies of software, video games and other licensed or protected materials, including OEM or bundled software.
10. Counterfeit and unauthorised goods, which include replicas or imitations of designer goods; items without a celebrity endorsement that would normally require such an association, fake autographs, counterfeit stamps, and other potentially unauthorised goods.
11. Cryptocurrency Exchanges, platforms dealing in cryptocurrency trading
12. Drugs and drug paraphernalia, which include illegal drugs and drug accessories, including herbal drugs like salvia and magic mushrooms.
13. Drug test circumvention aids, which include drug cleansing shakes, urine test additives, and related items.
14. Endangered species, which include plants, animals or other organisms (including product derivatives) in danger of extinction.
15. Gaming/gambling, which includes lottery tickets, sports bets, memberships/enrollment in online gambling sites, and related content.
16. Government IDs or documents which include fake IDs, passports, diplomas, and noble titles.
17. Hacking and cracking materials which includes manuals, how-to guides, information, or equipment enabling illegal access to software, servers,watomites, or other protected property.
18. Illegal goods, which include materials, products, or information promoting illegal goods or enabling illegal acts.
19. Miracle cures which include unsubstantiated cures, remedies or other items marketed as quick health fixes.
20. Offensive goods which include literature, products or other materials that: a) Defame or slander any person or groups of people based on race, ethnicity, national origin, religion, sex, or other factors, b) Encourage or incite violent acts, c) Promote intolerance or hatred.
21. Offensive goods, crime which includes crime scene photos or items, such as personal belongings, associated with criminals.
22. Prescription drugs or herbal drugs, which include drugs or other products requiring a prescription by a licensed medical practitioner.
23. Pyrotechnic devices and hazardous materials, which include fireworks and related goods; toxic, flammable, and radioactive materials and substances.
24. Regulated goods which includes air bags; batteries containing mercury; Freon or similar substances/refrigerants, chemical/industrial solvents, government uniforms, car titles or logos, license plates, police badges and law enforcement equipment, lock-picking devices, pesticides; postage meters, recalled items, slot machines, surveillance equipment; goods regulated by government or other agency specifications.
25. Securities, which include stocks, bonds, or related financial products.
26. Tobacco and cigarettes, which include cigarettes, cigars, chewing tobacco, and related products.
27. Traffic devices which include radar detectors/jammers, license plate covers, traffic signal changers, and related products.
28. Weapons which include firearms, ammunition, knives, brass knuckles, gun parts, and other armaments.
29. Wholesale currency, which includes discounted currencies or currency exchanges.
30. Live animals or hides/skins/teeth, nails and other parts, etc. of animals.
31. Multi Level Marketing collection fees.
32. Ponzi schemes, pyramid and chain marketing.
33. Matrix sites or sites using a matrix scheme approach.
34. Drop-shipped merchandise.
35. Any product or service which is not in compliance with all applicable laws and regulations whether federal, state, local or international including the laws of India.
36. The Merchant shall not sell, purchase, provide or exchange a cardholder’s name or MasterCard / Visa account number information in any form obtained because of a MasterCard/ Visa Card transaction to any third party other than its MasterCard/ Visa acquiring Member-Citrus Pay, or according to a government /statutory or competent body’s request.
37. Pyrotechnic devices, combustibles, corrosives and hazardous materials, which include explosives, fireworks and related goods; toxic, flammable, and radioactive materials and substances.
If Cashfree activates your Payment Gateway and later finds that your business does not comply with these terms and conditions, Cashfree may deactivate your account at its discretion.
# Account Management FAQs
Source: https://www.cashfree.com/docs/help/account/account-management
posthog.capture('Accordion Clicked', { title: "I don't have access to the phone number saved for my account, how can I log in?" })}>
We recommend that you update your account records from the Profile section after successful login.
Please follow the instructions [here](https://www.cashfree.com/docs/help/account/overview#update-phone-number).
If the problem still persists please contact us at [care@cashfree.com](mailto:care@cashfree.com).
posthog.capture('Accordion Clicked', { title: "I am not able to get the OTP, what can I do?" })}>
Please check the last four digits of the phone number where the OTP is being sent. If you don't recognize or have access to this phone number please contact us at [care@cashfree.com](mailto:care@cashfree.com) and get it updated. If you are not able to receive OTP on the correct phone number or if you are facing any other troubles with OTP verification please wait and try again after some time. If the problem still persists please contact us at [care@cashfree.com](mailto:care@cashfree.com).
posthog.capture('Accordion Clicked', { title: "Why am I being asked for OTP on login?" })}>
We have rolled out a new feature that mandates two-factor authentication on login from a new device and again after every 30 days.
This is being done to ensure the safety and security of your Cashfree account, and we strongly recommend that you keep your account details updated to avoid any login difficulties.
For more information please refer to the product update communication we sent with the subject line: \[Product Updates] Two-Factor Authentication on New Device Login
posthog.capture('Accordion Clicked', { title: "I don’t want to get OTP on sms, how can I change the OTP preference?" })}>
We strongly recommend that you use your phone number as the second factor of authentication to secure your Cashfree account.
You can also opt for Google Authenticator to receive 2FA OTPs and you can configure this from your profile section.
Please follow the instructions [here](https://www.cashfree.com/docs/help/account/overview#2fa-authentication)
If you are facing issues with mobile OTPs and wish to use email as an OTP channel please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) and we will be happy to assist you.
posthog.capture('Accordion Clicked', { title: "I want to change the phone number being used to send OTPs what can I do?" })}>
You can change your phone number from your profile section.
Please follow the instructions [here](https://www.cashfree.com/docs/help/account/overview#update-phone-number).
Please note that you will be asked to verify your identity through Aadhaar OTP validation, so make sure that you can access the Aadhaar and Phone number that was used during the activation process. please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) if you require further assistance.
posthog.capture('Accordion Clicked', { title: "I want to change the registered email address from my Cashfree Account, what can I do?" })}>
You can change your registered email address from your profile section.
Please follow the instructions [here](https://www.cashfree.com/docs/help/account/overview#update-customer-support-email-id).
Please note that you will be asked to verify your identity through Aadhaar OTP validation, so make sure that you can access the Aadhaar and Phone number that was used during the activation process. please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) if you require further assistance.
posthog.capture('Accordion Clicked', { title: "As an team member user, how can I change my phone number?" })}>
Team member user details can be updated only by the account owner from the Settings section of the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
As an team member, you can ask your account owner to update your profile details by logging in to [https://merchant.cashfree.com/auth/login](https://merchant.cashfree.com/auth/login) and following the instructions [here](https://www.cashfree.com/docs/help/account/overview#update-phone-number)
posthog.capture('Accordion Clicked', { title: "I can\'t find the “Login by Alias” tab on the login page. Where did it go?" })}>
As of March 2025, the "Alias" login method has been deprecated. This functionality has been fully transitioned to the Team Members feature. Team members can now log in using their email addresses, and new team members can be invited via email.
posthog.capture('Accordion Clicked', { title: "Lost access to the authenticator app used for multi-factor authentication (MFA): how can you recover access to your Cashfree account?" })}>
If you've lost access to the authenticator app used for multi-factor authentication (MFA), contact [care@cashfree.com](mailto:care@cashfree.com) for support.
In your email:
* Clearly describe the issue.
* Use your registered email ID.
* Include a phone number to receive OTPs.
The Cashfree team will verify your details and switch your MFA method to OTP.
posthog.capture('Accordion Clicked', { title: "Lost access to the phone number used for OTP multi-factor authentication (MFA): how can you recover access to your Cashfree account?" })}>
If you no longer have access to the phone number used for OTP-based MFA, contact [care@cashfree.com](mailto:care@cashfree.com) for support.
In your email:
* Clearly describe the issue.
* Use your registered email ID.
* Provide your new phone number to receive OTPs.
The Cashfree team will verify your details and update your OTP MFA phone number.
# Account Overview
Source: https://www.cashfree.com/docs/help/account/overview
Let us learn how to create a Cashfree Payments account. Once you create an account, you have test and production environments in which the former helps you simulate the different features of our products.
## Create account
### Sign up with Cashfree Payments
To set up an account:
1. Go to the Cashfree Payments website and click **Create Account**.
2. Enter the email address of your business and set a password. Use these credentials to sign in to Cashfree Payments.
3. Click **Continue** to proceed.
4. Enter the mobile number. We may reach out to you for any clarifications during the onboarding process. If you want to receive account updates on Whatsapp, enable the checkbox.
5. Choose **Yes** if your business has a website or an application and provide the information in the **Business info or Facebook/Instagram link**.
6. Click **Create Account**.
### Explore test environment
The next step is to activate your account. If you wish to do it later, click **Skip and explore dashboard**.
You can access the test environment anytime before activating the account. Use the test environment to familiarise yourself with the dashboard, explore integrations, read product documents, and test the product features. Once you are ready, activate your Cashfree Payments account to process real-time payments.
***
## Activate account
Activating the account allows you to access the production environment where you can collect payments, make payouts, and verify customer's identity. Once you sign up, select the products and activate your account. In the **Welcome to Cashfree Payments** screen, select the products you want to activate and click **Continue with Product activation**.
To activate Cashfree Payments account, you need to complete the onboarding process by providing necessary information, uploading mandatory documents, and signing the agreement with us. The details required and the stages might change based on your line of business. This document helps you understand the following stages:
* [Contact Information](#contact-information)
* [Business PAN](#business-pan)
* [Business Owner PAN](#business-owner-pan)
* [Business Details](#business-details)
* [Business Registration Details](#business-registration-details)
* [Website Details](#website-details)
* [Bank Account Details](#bank-account-details)
* [Business Owner Details](#business-owner-details)
* [Upload Documents](#upload-documents)
* [Declaration of Beneficial Ownership](#declaration-of-beneficial-ownership)
* [Service Agreement](#service-agreement)
### Contact information
We need your contact information to reach out to you for anything related to your account. It could be for clarifications on the information provided, missing information or documents.
1. Fill in the following fields:
* **Registered Email**: This field is auto-filled with the email address you provided during signup. Fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) if you wish to edit the registered email address. The registered email address receives a verification link. If you do not find it in your inbox, check the spam folder. Click the link in the email to verify your email account.
* **Contact Phone Number**: The phone number is auto filled but you can edit the contact number if required.
* **Receive account updates via Whatsapp**: Check the box if you want notifications regarding promotions, offers, product and account updates on your Whatsapp.
2. Click **Continue**.
### Business PAN
For verification purposes and account activation, we need your business PAN information.
1. Enter the information in the following fields:
* **Business PAN**: Enter your business PAN details. If your business is unregistered or if you are a proprietor, enter your personal PAN information.
* **Name as per PAN**: Enter the name as per the PAN card.
2. Click **Continue**.
### Business Owner PAN
We would require the business PAN details of the business owner or the individual who owns 25% or more of the shares, capital, and company's profile.
1. Enter the information in the following fields:
* **Business Owner PAN**: Enter the business PAN details of the business owner/individual.
* **Name as per PAN**: Enter the name as per the PAN card.
2. Click **Continue**.
### Business details
Provide the details about your business. It helps us understand the nature of your operations and help cater services that fit your business requirements.
1. Enter the following information:
* **Select Business Type**: Choose your business type from the dropdown menu. Check the [list of documents required](#account-activation-checklist) based on your business type.
* **Select Business Model**: Choose your business model from the dropdown menu.
* **Select Business Category**: Choose your business category from the dropdown menu.
* **Select Business Subcategory**: Choose your business subcategory from the dropdown menu. If you do not find your business subcategory, select **Others** and describe your business in the text box.
Business categories and subcategories help you define your business from the
broadest to the narrowest field. For example, if you are a payment service
provider, choose **Finance** as your business category and **Payment Service
Provider** as your subcategory.
2. Click **Continue**.
Ensure the selected options comply with our terms and conditions. Please read
them carefully.
### Business registration details
Based on the selected business type, we would require your business registration information. Refer to the table below to view the required information for each business type:
| Business Type | Required Information |
| :----------------------------------------------- | :----------------------------------------- |
| Individual (Unregistered) | Business Operating Address |
| Public Limited / Private Limited | CIN / GSTIN / Business Operating Address |
| LLPIN | LLPIN / GSTIN / Business Operating Address |
| Partnership / Proprietor / Society / Trust / NGO | GSTIN / Business Operating Address |
1. Fill in the information for the following fields:
* **GSTIN**: Enter your GSTIN details if your business is GST registered. If not, choose **I do not have GSTIN** from the dropdown.
* **CIN**: Enter your corporate identification number (CIN).
* **LLPIN**: Enter your limited liability partnership identification number (LLPIN).
* **Business Address**: Enter the address of your business location in the respective fields.
* **Same as GST Address**: If the address of your business location is the same as the GST registration, check this box.
2. Click **Continue**.
### Bank account details
We require your bank account details to process settlements.
1. Enter the following information:
* Account Number: Enter your bank account number. Ensure the bank
account holder name is the same as the name in the GST or PAN registration.
* IFSC: Enter the IFSC of the bank branch where the account is
active.
* Upload: Alternatively, you can upload a cancelled cheque if you
do not have your bank account information or due to an unsuccessful verification.
2. Click **Continue**.
### Website details
We require your website details to enable live API keys for your business. This enables you to accept payments.
1. Enter the information in the following fields:
* **Website Link**: Enter your website link in this field. This is a required field.
* **App Link**: Enter your app link. This is optional.
2. Click **Continue**.
The following details must be on your website/app: nature of your business,
business contact information, privacy policy, terms and conditions, and
cancellation/refund policy.
### Business owner details
We require government ID information of the business owner to activate your Cashfree Payments account. Ensure that the details match the submitted owner PAN information.
1. Fill in the following fields:
You need to enter the information of two directors, but one director's
signature is sufficient in the declaration of beneficial ownership.
**Download template and upload signed copy of the declaration**
1. Click Download Document Template to download the template.
2. Sign the document and use the **Upload** button to upload it.
3. Click Submit.
The onboarding process is now complete. Our team reviews the submitted documents and activates the selected products in 24-48 hours. We might contact you for any queries regarding the submitted information over email or call.
You can view the activated products on the **Congratulations** screen. You can transact up to ₹25,00,000. Click **Next** to sign the agreement and transact limit free.
### Service agreement
The agreement is between you and Cashfree Payments. Read the document carefully before signing it.\
You can sign the agreement in two ways:
* **Instant Agreement Signing**
* **Download Template and Upload**
**Instant Agreement Signing**
1. Enter either of the following details:
* **Email ID**: Enter the email address of the business owner.
* **Mobile Number**: Enter the mobile number of the business owner.
2. Click **Send Agreement**.
3. The email ID or the mobile number receives the link to the agreement details. You can use Aadhaar OTP to instantly sign the agreement.
**Download Template and Upload**
1. Click **Generate and Download Agreement** and sign the generated agreement.
2. Upload the following files:
* **Upload signed agreement**: Use the **Upload** button to upload the signed agreement.
* **Upload PAN card copy of the business owner**: Use the **Upload** button to upload PAN of the business owner.
Our team reviews the uploaded agreement and updates the status in 24-48 hours.
***
## Account activation checklist
### Individuals (Unregistered business)
If you run a business without any formal registration with the government, you have an unregistered business.
* Business PAN (Your personal PAN that is linked to your business account)
* Bank account details or a cancelled cheque (The details should be in the business owner's name)
* Aadhaar number of the business owner (Will be validated via OTP verification)
* [Line of business(LOB) specific documents](#upload-documents)
The PAN and Aadhaar information should belong to the same person (business
owner).
### Proprietorship
If you are the sole owner and operator of your business with no legal distinction between you and the business, you have a sole proprietorship.
* Business PAN (Your personal PAN that is linked to your business account)
* Bank account details or a cancelled cheque (The details should be in the business owner's name)
* Aadhaar number of the business owner (Will be validated via OTP verification)
* If you do not have GSTIN, then provide any of the following proof of business identity and existence:
* Municipal Certificate
* Shop Establishment Certificate
* Udyog Aadhaar
* Other Government-Issued Registration Proof
* [Line of business(LOB) specific documents](#upload-documents)
The PAN and Aadhaar information should belong to the same person (business
owner).
### Public/private limited
| Public Limited | Private Limited |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| A public limited company, also known as PLC, is a business structure that incorporates a large or publicly traded company. It is a legal entity separated from its owners and owned by several shareholders who hold shares of stock in the company. | A private limited company, also known as a limited liability company or LLC, is a business structure that incorporates a small or medium-sized business. It is a legal entity separated from its owners and owned by a few private shareholders. |
* Business PAN(COMPANY)
* CIN
* Bank account details or a cancelled cheque (The bank account details should be in the business name as per COMPANY PAN)
* PAN of the Authorised Signatory
* Aadhaar of the Authorised Signatory
(if Authorised Signatory is not the Director)
* PAN of the Director
* Identity proof of the Director
* Board Resolution signed by the Director
* [Line of business(LOB) specific documents](#upload-documents)
The PAN and Aadhaar information should belong to the same person (Authorised
Signatory or the Director)
### Limited Liability Partnership(LLP)
LLP is a type of business structure that combines elements of partnerships and corporations. They enable the protection of a corporation and allow the flexibility of a partnership.
* Business PAN (COMPANY)
* LLPIN
* Bank account details or a cancelled cheque (The bank details should be in the name of the business as per PAN)
* PAN of the Authorised Signatory (Partner of the firm)
* Aadhaar of the Authorised Signatory (Partner of the firm)
(if Authorised Signatory is not the Partner of the firm)
* PAN of the Partner
* Identity proof of the Partner
* Board Resolution signed by the Partner
* [Line of business(LOB) specific documents](#upload-documents)
The PAN and Aadhaar information should belong to the same person (Authorised
Signatory or the Partner)
### Partnership
Partnership is a business type when two or more people own the business and share profits and losses.
* Business PAN (FIRM)
* Bank account details or a cancelled cheque (The bank details should be in the name of the business as per PAN)
* PAN of the Authorised Signatory (Partner of the firm)
* Aadhaar of the Authorised Signatory (Partner of the firm)
(if Authorised Signatory is not the Partner of the firm)
* PAN of the Partner
* Identity proof of the Partner
* Board Resolution signed by the Partner
* Business registration proof
* Partnership Deed
* Registration Certificate from Registrar of Firms
* [Line of business(LOB) specific documents](#upload-documents)
### Hindu Undivided Family (HUF)
* The PAN information of the HUF
* The PAN information of the business owner
* Bank account details or a cancelled cheque
* Aadhaar number of the business owner (Will be validated via OTP verification)
* HUF Registration Proof - HUF Deed
* [Line of business(LOB) specific documents](#upload-documents)
### Society/Trust/NGO/Local Authority/Artificial Juridicial Person/Government
| Society | Trust | NGO |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| A society is a group of people who come together for a common purpose, such as a social, cultural, or charitable cause. They are often registered with the government and may have legal status as nonprofit organisations. | A trust is a legal arrangement in which one or more trustees manage assets on behalf of one or more beneficiaries. Trusts manage property assets, protect finances, serve as a charitable organisation, and perform estate planning. | NGO stands for Non-Governmental Organisation. They are a nonprofit organisation independent of government and focused on social or environmental causes. Often registered as charities or other nonprofit organisations, they may receive funds from governments, foundations, and individual donors. |
| Local Authority | Artificial Juridical Person | Government |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| A local authority is a government body at the municipal or regional level responsible for delivering local services and facilities, including education, housing, and public safety. | An artificial juridical person is a legal entity, like a corporation or organisation, recognized by law as having rights and responsibilities similar to those of a natural person, but it is not a human being. | A government is the system or group of people that governs an organised community, such as a state, and is responsible for creating and enforcing laws, policies, and public administration. |
* The Business PAN information of TRUST/Society/Local Authority/Artificial Juridical Person/Government. * The PAN information of the Authorised Signatory (Trustee of the firm) * Bank account details or a cancelled cheque * Aadhaar number of the Authorised Signatory (Trustee of the firm) If Authorised Signatory is not the Trustee of the firm * The PAN information of the Trustee * Identity proof of the Trustee * Board Resolution signed by the Trustee * Business registration proof * Trust Deed/Society/NGO Registration Certificate * Certificate of registration number issued by charity commissioner or registrar of cooperative society or any other competent authority * Letter of Intent/Authorisation (LOI)/(LOA) * Society Certificate * NGO Registration Certificate * [Line of business(LOB) specific documents](#upload-documents) *** ## Manage account ### Profile You can manage your account information and control overall activities in the **Profile** page. You can control basic account settings, configure two-factor authentication, monitor login history, and view your tax invoices. #### My information **My Information** displays the following information under **Personal Profile**: * **Name**: The registered name of your Cashfree Payments account. * **Email ID**: The registered email address of your Cashfree Payments account. * **Phone Number**: The registered phone number of your Cashfree Payments account. * **Customer Support Email**: Your customer support email address. * **Account Password**: Click **Set Password** to change your account password  ### Update information You can edit your details such as email ID, phone number, and customer support email ID using the features available on the dashboard. The **Edit** icon next to each information allows you to update the information after successful OTP authentication.
Why Aadhaar Validation?
To confirm your identity and prevent fraudulent activities, we require an aadhaar validation to update your contact information.
#### Update email ID
Follow the instructions below to update the email ID:
1. Click the **Edit** icon.
2. In the **Edit Email** popup, enter the aadhaar number in the respective field, and click **Verify**.
Correct Aadhaar Number
Ensure the aadhaar number used during the KYC process of your Cashfree Payments' account is used to initiate this change.
3. In the **Enter OTP** popup, enter the OTP received on your aadhaar registered mobile number and click **Confirm**.
4. Enter the new email address in the **Enter New Email** field, and click **Verify Email**.
5. Another OTP is sent to the newly entered email address. Enter the OTP in the **Verify Email** popup and click **Confirm**.
6. We will review the request and update the email ID for your account within 24-48 hours. You will be logged out of the session after email verification. Use your updated email address and the existing password to login.
#### Update phone number
Follow the instructions below to update phone number:
1. Click the **Edit** icon.
2. In the **Edit Phone Number** popup, enter the aadhaar number in the respective field, and click **Verify**.
3. In the **Enter OTP** popup, enter the OTP received on your aadhaar registered mobile number and click **Confirm**.
4. Enter the new phone number in the **Enter New Phone Number** field and click **Verify Phone**.
5. Another OTP is sent to your updated phone number. Enter the received OTP in the **Verify Phone Number** popup and click **Confirm**.
6. We will review the request and update the phone number for your account within 24-48 hours.
Validation Process
You only have to go through the aadhaar validation process once when you try to update both the email and phone number information.
#### Update customer support email ID
Follow the instructions below to update customer support email ID:
1. Click the **Edit** icon.
2. An OTP is sent to your registered phone number or email address. Enter the received OTP in the **Authenticate** popup and click **Confirm**.
3. The **Customer Support Email ID** field is now available to edit. Enter the new customer support email ID, and click **Verify Changes**.
4. The customer support email ID is updated for your account.
### 2FA Authentication
2FA Authentication is a method to confirm secure login to your Cashfree Payments account and authenticate specific operations that occur in your account. It combines two different factors: sign-in password and OTP to confirm user identity. You receive an OTP to your registered phone number via SMS by default. You can configure it to receive the OTP on your email as well. Once the OTP is validated, the session is valid for 15 minutes.
If you do not want to use the OTP-based authentication, click **Use this Method Instead** to configure your account authentication via Google's Authenticator app.
You can have another level of security to the login sequence for your Cashfree Payments account. Switch the toggle **Enable 2FA for Login** to enable two-factor authentication for every login attempt to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) for you and your team member account. This added layer of security reduces fraud and keeps your account secure.
### Communications
**Communications** lets you manage the notification preference for various events.
#### Create/edit preference
To set notification preference for new email or to edit the preference for existing email, follow the below instructions:
1. Click on **Manage Notifications** and select **Email Notifications**.
2. Enter the email address to set notification preferences and click **Next**.
3. Choose which notifications should be delivered to the entered email.
4. Click **Submit** to save the preference.
#### Providing consent to receive notifications
Whenever an email is configured to receive notifications for particular event, e.g., API Updates, a confirmation email is sent to the recipient's email address.
Recipient can click on **Confirm** button to provide their consent. Once consent is provided, recipient will start getting notifications about those particular events.
#### Checking recipient's consent status in dashboard
To check whether a recipient has provided their consent to receive notifications or not, follow these instructions:
1. Click on any particular category card
2. Hover over any particular email to see the status.
### Login history
**Login History** displays information regarding successful logins by users added to your Cashfree Payments account.
The search and filter options allow you to categorise and view specific login history by users as mentioned below. You can also filter the cards based on a specific period.
1. Use the follow filters to search for specific login history:
* **All Time**: Use this drop-down menu to set the date range.
* **Search & Filter**: Use this drop-down menu to set the search filter.
* **Search**: Use this drop-down menu to determine the search value and enter the value in the field. For example, if you choose **Email ID**, enter the specific email ID in the field.
2. Select **Apply**.
3. The results display in the form of a grid.
### Invoice
The monthly invoices generated for your Cashfree Payments account is available in the **[Invoice](https://merchant.cashfree.com/common/profile/invoice)** section. You can download the invoices for your future reference.
## Access management
### User management
To minimise risks and keep your system secure, you can assign the created role(s) to your users, or even enable specific permissions for a more granular approach.
#### Invite a user and assign a role
Follow the instructions below to invite a user and assign a default or custom role(s):
1. Log in to the dashboard using your credentials.
2. From the product selection screen, click **Settings** from the top navigation pane.
3. Click **Access Management** from the **General** card, and select **User Management**.
4. Click **Invite New User**.
5. Enter the following information in the **User details** section of the **Invite New User** popup:
* **Registered email address**: Enter the email address of the user.
6. Check the box of the role that you want to assign for the user in the **Assign role(s)** section. You can view the permissions enabled for the particular role in the **Permissions** section.
* **Custom**: You can create a [custom role in the **Role Management** screen](#create-role) and assign it to your users.
* **Default**: You can select a default role created by Cashfree Payments and assign it to your users. Find the list of default roles that are readily available for you below:
| Developer | Description |
| :--------- | :----------------------------------------------------------------------------------------------------------- |
| Developer | Develops and maintains integrations, access API secrets, webhooks and can access all API resources. |
| Operations | Manages daily payment processing, ensure payouts, refund payments, handle disputes and export data. |
| Manager | Manages overall business cash flow including settlements, payment methods, and reports. |
| Admin | Oversees all system functions and has access similar to account owner. |
| Support | Provides technical assistance to customers and has view only access to transactions, refunds, and transfers. |
Assigning multiple roles
You can assign multiple roles for the user by checking the respective boxes of the roles. The **Permissions** section displays the combined permissions of the selected roles.
6. Click **Invite New User**.
7. A user is invited successfully. You can view the invited user(s) in the **User Management > Invited Users** screen.
#### Invite a user and enable permissions without a specific role
You can also invite a user and enable specific permission without assigning a specific role. You can use this to provide temporary access to a specific dashboard without having to redefine the entire role within your organisation.
Follow the instructions below to invite a user and enable permission:
1. After you enter the required information of the user in the **User details** section of the **Invite New User** popup, scroll down to see **Direct Permission Assignment**.
2. Click **Enable permissions without a specific role**.
3. The **Select Account for Payouts/VRS** dropdown appears; use it to select the account(s) that the user can access.
4. Follow the instructions in the **Permissions** section, and click **Invite New User**:
* **Search for a permission**: Use this search bar to search for a permission.
* **Table**
* **Product**: Use the dropdown to navigate through each product's features.
* **View**: Use the toggle to enable or disable a permission that allows to only view the module or feature.
* **Manage**: Use the toggle to enable or disable a permission that allows to add, edit, download etc.
5. A user is invited successfully. You can view the invited user(s) in the **User Management > Invited Users** screen.
#### Manage users
Follow the instructions below to manage existing users:
1. The table in the **User Management** screen lists the created users.
* **Enable/Disable**: Use this toggle to enable or disable a user.
2. Click the ellipses icon of the user that you want to manage.
3. Select an option:
* **View details**: It allows you to view the user details.
* **Edit details**: It allows you to edit the user's permission/role in the **Update Details** popup. Click **Update User** when done.
* **Delete**: It allows you to delete the user.
### Role management
This dashboard feature allows you to create and define the access levels and permissions for different roles within the system. The cornerstone of this system is its enhanced flexibility and control through the creation of different roles with specific permissions for each role.
#### Create role
You can now create roles tailored to the exact needs of your team members. For example, you can define a role for a user that allows only to view Payment Gateway's orders and nothing beyond that.
Follow the instructions below to create a role:
1. Log in to the dashboard using your credentials.
2. From the product selection screen, click **Settings** from the top navigation pane.
3. Click **Access Management** from the **General** card, and click **Role Management**.
4. Click **New Role**.
5. Enter the following information in the **Create New Role** popup, and click **Create New Role**:
* **Role**: Enter the name of the role in this field.
* **Description**: Enter the description for the role.
* **Search for a permission**: Use this search bar to search for a permission.
* **Table**
* **Product**: Use the dropdown to navigate through each product's features.
* **View**: Use the toggle to enable or disable a permission that allows to only view the module or feature.
* **Manage**: Use the toggle to enable or disable a permission that allows to add, edit, download etc.
6. A role is successfully created. You can view the created role(s) in the **Role Management** screen.
#### Manage role
To maintain security and proper governance, we allows you to manage the created roles. Follow the instructions below to manage:
1. From the **Role Management** screen, click the ellipses icon of the role.
2. A dropdown box appears with the following options:
* **Edit role**: It allows you to edit the role. Click **Edit Role** > update the details > and click **Update Role**.
* **Delete**: It allows you to delete the role.
# Pricing FAQs
Source: https://www.cashfree.com/docs/help/account/pricing
posthog.capture('Accordion Clicked', { title: "What is TDR?" })}>
Transaction Discount Rate (TDR) is the fee that you pay for every transaction processed using a payment gateway. The rates may differ based on the payment mode used by the customer.
For example, when a customer pays via net banking, the TDR will be low, while for international credit card payments the TDR will be higher. We discussed in details, what is TDR and how it is split.
[Read here](https://www.cashfree.com/payment-gateway-charges/).
posthog.capture('Accordion Clicked', { title: "What is TDS?" })}>
TDS (Tax Deducted at Source) is a tax collected by the Government of India at the time income is generated, rather than at a later date. It applies to payments such as commissions, professional fees, interest, and rent.
In the context of Cashfree Payments, TDS may be applicable on the payouts or commissions paid to merchants. The deducted amount is deposited with the government, and a TDS certificate (Form 16A) is issued to the merchant as proof of the deduction.
You can use this certificate to claim credit while filing your income tax returns.
posthog.capture('Accordion Clicked', { title: "How do I submit a TDS claim?" })}>
To submit a TDS claim, follow these steps:
1. Submit this [support form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) using your Cashfree registered email address.
2. Attach the following documents:
posthog.capture('Accordion Clicked', { title: "What is Form 16A?" })}>
Form 16A is a TDS certificate issued for tax deducted on non-salary payments such as commissions, interest, rent, and professional fees. It contains details of the amount paid, the tax deducted at source (TDS), and the TDS payment deposited with the government.
posthog.capture('Accordion Clicked', { title: "Do you provide billing Invoices for transactions and services used?" })}>
For all the transactions processed, an invoice is raised and shows up on your Cashfree [Merchant Dashboard](https://merchant.cashfree.com/auth/login) on/after the 5th of the next month. You will be notified of the invoice generation on your registered email address provided to us.
If your account has availed Free Trial credits for the billing period and you don't have any charges or deductions, or if your account is on the surcharge model, an invoice will not be raised for you, since you have not been directly charged for the transactions.
Please follow the below steps to download the invoice:
1. `Login` to your [Cashfree account](https://merchant.cashfree.com/common/profile/invoice).
2. On the Home page, click the Profile/User icon on the top right corner and select `Profile` from the menu.
3. On the Profile page, click `Invoices`, select the month-year combination from the dropdown, and select `Download`
4. A new tab will open where your generated invoice(s) will be shown and you can download them
Cashfree Payments India Private Limited comes under the purview of e-Invoicing under GST, and it is mandatory for us to capture all required details of the merchants correctly to generate e-Invoices. Please check the invoice to ensure that your tax details are correct.
If you want to claim Input Tax Credits, we request you to send your latest GST registration details and the GST certificate at the earliest. Please ignore this if you have already registered your information with Cashfree and details are present on the generated invoice.
{" "}
posthog.capture('Accordion Clicked', { title: "What charges do I need to pay for using Cashfree products?" })}>
You can check out all Cashfree products and their pricing
[here](https://www.cashfree.com/payment-gateway-charges/). You can also talk
to our payments expert directly and know more about the product and pricing by
submitting this [form](https://www.cashfree.com/contact-sales).
{" "}
posthog.capture('Accordion Clicked', { title: "Do I need to pay any setup or integration cost?" })}>
Cashfree merchants need not pay any setup fee or integration charges. We offer
a wide range of powerful REST APIs built to help you automate payments and
achieve efficiency. We have also developed ready - to use integrations that
work seamlessly with a range of e-commerce platforms such as Shopify,
Woocommerce etc. You can check out our developers documents and available
integrations [here](https://www.cashfree.com/docs/payments/overview).
posthog.capture('Accordion Clicked', { title: "How is the billing done?" })}>
For all the transactions processed, an invoice is raised and shows up on your [Cashfree Merchant Dashboard](https://merchant.cashfree.com/common/profile/invoice) on the 5th of the next month, i.e for the services rendered for the period 1st Jan to 31st Jan, Cashfree raises the invoice by 5th of Feb. The invoice will have the total value of the transactions processed and respective [Transaction Discount Rate(TDR)](https://www.cashfree.com/docs/help/account/pricing#what-is-tdr) + GST as applicable.
# Terms & Conditions FAQs
Source: https://www.cashfree.com/docs/help/account/termsandcondition
posthog.capture('Accordion Clicked', { title: "Terms and Conditions for MobiKwik | Cashfree Payments Offer" })}>
MobiKwik Offer Details:
* Your customer can get upto Rs.100 cashback on payment via MobiKwik Wallet
* Minimum transaction value is Rs.100 to avail the offer
* User will get cashback from anywhere between Rs.5-100
* Minimum assured cashback of Rs.5
* Offer is valid for 1 month
* User must select MobiKwik Wallet option to complete the transaction
* Offer valid once per user per month during the campaign
* No cost is attached to this offer
General T\&Cs:
Cashback will be directly credited to your customer's MobiKwik Wallet within 24 hours. If the order is cancelled or undelivered at your end, you, i.e the merchant (not MobiKwik), will initiate a refund.
In case of partial refunds/cancellations, the refund amount will be adjusted with the cashback received on the initial payment, and full cashback will be rolled back in case of a full refund. After the refund is initiated, the amount will be credited back to the wallet within 7-10 working days.
All the merchants who have MobiKwik wallet enabled on their checkout page are eligible to be part of this offer. MobiKwik wallet is enabled for all. The offer is already integrated into the checkout page. Merchants/Businesses just need to promote it to the customers on the product catalogue page or on their website.
posthog.capture('Accordion Clicked', { title: "How do I get more information on Cashfree or its policies?" })}>
For further information on Cashfree Payments and its policies, or if you wish to reach out to us, please read our policies here:
Grievance Policy: [https://www.cashfree.com/grievance-redressal-policy/](https://www.cashfree.com/grievance-redressal-policy/)
Terms: [https://www.cashfree.com/tnc/](https://www.cashfree.com/tnc/)
Privacy Policy: [https://www.cashfree.com/privacypolicy/](https://www.cashfree.com/privacypolicy/)
Grievance Officer: Vaibhav Kaushal
Address: Cashfree Payments India Pvt Ltd
RMZ Eco world, Building 7
10th Floor, Devarabeesanahalli, Marathalli Outer Ring road,
Bangalore - 560103
E-Mail: [grievances@cashfree.com](mailto:grievances@cashfree.com)
NODAL OFFICER: Shaik Mohammed Aftab Alam
ADDRESS: Cashfree Payments India Pvt Ltd
RMZ Eco world, Building 7
10th Floor, Devarabeesanahalli, Marathalli Outer Ring road,
Bangalore - 560103
E-MAIL: [dispute@cashfree.com](mailto:dispute@cashfree.com)
# Easy Split FAQs
Source: https://www.cashfree.com/docs/help/easy-split/faqs/faqs
posthog.capture('Accordion Clicked', { title: "What features does Easy Split provide?" })}>
Some features our Easy Split provides:
* Faster settlement to your vendors (T + 2 settlement cycle).
* Unburden yourself from opening & managing a Nodal account.
* Route payment from each order to vendors easily.
* Individual commissions, simplify taxes & much more.
* Make on-demand adjustments (refunds/bonus) to vendor payouts.
* Works for non-PG or Cash on delivery orders as well.
* Access vendor ledger wherever you need using our APIs or our dashboard.
posthog.capture('Accordion Clicked', { title: "Why should I consider Easy Split?" })}>
Easy Split automates payment splitting, helping you manage vendors and transactions effortlessly. With Easy Split, you can:
* Onboard, manage, and pay vendors with ease.
* Split payments and handle refunds at the order level.
* Track settlements, refunds, and earnings through detailed reports.
**Key Benefits:**
* **Simplify Settlements:** Save your Finance team time with fewer banking tasks.
* **Streamline Accounting:** Accept only your earnings, making tax computation easier.
* **Clear Ledger Insights:** Access historical credits, debits, and earnings per order, vendor, or month.
**Go Global:**
* Onboard and support international merchants seamlessly.
* Automate payouts to their home bank accounts with a standard T+2 payment cycle.
Contact sales to learn [more](https://www.cashfree.com/contact-sales/)
posthog.capture('Accordion Clicked', { title: "Handling PG Refunds in Easy Split" })}>
Refunds are a feature on PG that allows you to return funds back to the payment source. If the PG on your account is linked to Easy Split, then you also need to factor out how vendors will bear the liability for a refund. By default, the balance of respective vendors is debited in the proportion of their commission for the order. For example, let's say there is an order of Rs.100 where Vendor 1 gets Rs. 60 and Vendor 2 gets Rs. 40. This order has a refund of Rs. 50 against it. In such a case, Vendor 1 will receive a debit of Rs. 30 on their balance, and Vendor 2 will have a debit of Rs. 20 against it. This will be adjusted in the next payout to the respective vendors. However, this feature can be turned off in your account if you want to handle the debits against the vendors yourself.
[Interested in Easy Split? Contact Sales for more information.](https://www.cashfree.com/contact-sales/)
posthog.capture('Accordion Clicked', { title: "How many hours do I have to spend every day to manage settlements?" })}>
Zero! Everything is automated—from receiving payments through Payment Gateway to settling funds in Vendor's bank account. Focus on growing your business while we handle the rest!
posthog.capture('Accordion Clicked', { title: "How can we add vendors at the platform for Settlement?" })}>
Vendors can be added manually from the dashboard. To add a new vendor,
Go to Payment Gateway Dashboard > Easy Split - Vendor > [Add Vendor](https://www.cashfree.com/docs/payments/split/vendor/add).
Enter the following details:
Vendor ID - ID of the vendor.
Phone Number - phone number of your vendor.
Email ID - Email address of your vendor.
Vendor Line of Business - Select your vendor’s line of business. Click here to know more.
Vendor Business Type - Select the business type of your vendor. Click here to know more.
Settlement Cycle - Select the schedule option through which you want to settle your vendors. Click here to know the available settlement cycles.
Once done, click Next.
Mention the Vendor Bank Account Details such as Account Holder Name, Account Number, and IFSC Code or UPI VPA to process payments to the vendor account.
We also support automated addition through the APIs.
The documentation for the APIs is available here. [Read more](https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/create#create-vendor).
posthog.capture('Accordion Clicked', { title: "What are the charges involved for Vendor payouts? Are these debited from the merchant\'s nodal account?" })}>
Charges will be communicated by your account manager. It is debited from the merchant's balance in the nodal account.
**Example:**
If a settlement of Rs 100 is done, Rs 100 + charges will be debited. Invoice for payout is available on the dashboard separate from payment gateway charges.
posthog.capture('Accordion Clicked', { title: "What are the different possible states a transaction goes through once it’s been added against a Vendor?" })}>
Only successful transactions get added to a Vendor's balance. The accrued balance gets settled.
The status can be:
* **SUCCESS**
* **FAILURE**
* **IN PROGRESS**
Read [more](https://www.cashfree.com/docs/payments/split/settlements/failure-reasons)
posthog.capture('Accordion Clicked', { title: "How is the invoice presented to the merchant for the charges incurred for the payout?" })}>
Charges will be communicated by your account manager. It is debited from the merchant's balance in the nodal account.
**Example:**
If a settlement of Rs 100 is done, Rs 100 + charges will be debited.
The invoice for the payout is available on the dashboard, separate from the payment gateway charges.
posthog.capture('Accordion Clicked', { title: "How many settlements do vendors receive per day?" })}>
One. Settlement of all the unsettled transactions are grouped together and sent as a single payout. We share the bank reference number for the transfers, that can be shared with the vendors for tracking purposes.
posthog.capture('Accordion Clicked', { title: "What is the Transfers option under the Vendor menu?" })}>
A transfer is a settlement to the vendor. The transaction is the payment that
a customer may have made, which was added to the Settlement account manually
or via API.
posthog.capture('Accordion Clicked', { title: "What exactly is Easy Split?" })}>
Easy Split automates payment splitting between you and your vendors. With Easy Split, you can:
* Onboard, manage and disburse payments to vendors.
* Perform splits at order level and manage refunds from vendors smoothly.
* Track all transactions through detailed reports covering:
* Settlements
* Refunds
Click the [link](https://www.cashfree.com/docs/payments/split/overview) to know more.
posthog.capture('Accordion Clicked', { title: "How is vendor settlement managed when there are multiple vendors linked to one transaction?" })}>
At the time of adding a transaction, you can assign the appropriate numeric
commission amount against each vendor that you add with Cashfree Payments.
posthog.capture('Accordion Clicked', { title: "How to add vendors in Easy Split?" })}>
Go to Payment Gateway Dashboard > Easy Split - Vendor > Add Vendor.
Enter the following details:
Vendor ID - ID of the vendor.
Phone Number - phone number of your vendor.
Email ID - Email address of your vendor.
Vendor Line of Business - Select your vendor’s line of business. Click here to know more.
Vendor Business Type - Select the business type of your vendor. Click here to know more.
Settlement Cycle - Select the schedule option through which you want to settle your vendors.
Click [here](https://www.cashfree.com/docs/payments/split/vendor/add#available-schedule-options) to know the available settlement cycles.
posthog.capture('Accordion Clicked', { title: "What are the different use cases of Easy Split?" })}>
Marketplace Aggregators – Split customer payments among vendors, manage commissions, and track transactions in real-time.
* **EdTech Platforms** – Collect student payments and distribute funds to instructors after deducting charges.
* **Franchise & Multi-Branch Outlets – Centrally manage payments and route funds to individual branches or stores.**
* **Investment & Insurance Marketplaces – Settle 100% of the order amount to AMCs or insurers with same-day reconciliation.**
* **Educational Institutes** – Automate payment splits for tuition, hostel, stationery, and other fees.
* **On-Demand Services** – Seamlessly split payments for cabs, flights, food delivery, and more.
Clicik [here](https://www.cashfree.com/docs/payments/split/use-cases) to know more
posthog.capture('Accordion Clicked', { title: "What are the top features of Easy Split?" })}>
* Add/Update Vendor: You can add or update your vendor details by providing basic information about the vendor and their account details.
* Split after payment success: This feature allows to initiation of split after successful confirmation of payment by the customer.
* Transfer Vendor Balance: You can initiate manual Credit/Debit of a configured vendor-configured settlement account.
* Refund before split: If the refund is initiated before the vendor split is shared, Cashfree Payments directly refunds the money to the customer payment instrument in the next settlement.
* Refund after split: If the refund is initiated after the vendor split is shared - The refund will be done from your & vendor’s settlement account according to the respective transaction split created.
* Deferred Settlement: This API allows you to assign a settlement eligibility date for an order and vendor combination.
For more information, refer [here](https://www.cashfree.com/docs/payments/split/features).
posthog.capture('Accordion Clicked', { title: "Can I edit vendor details once added in Easy Split?" })}>
While adding vendors, if you have specified incorrect vendor details or missed adding some information, you can modify it using the **Edit Vendor** feature on the product dashboard or use the [Update Merchant Details API](https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/update).
To edit the details of the vendor you have already added:
1. Go to **Payment Gateway Dashboard > Easy Split - Vendor**.
2. Click the ellipsis icon on the vendor you want to make changes to and select **Edit Vendor**.
**You can update the following details:**
**Vendor details:**
* Vendor phone number
* Vendor email ID
* Settlement cycle
* Dashboard access
**Vendor bank account details:**
* Account holder name
* Account number
* IFSC code
* UPI VPA
* Verify account details option
**KYC details:**
* Vendor type
* Business type
* Documents (Based on the vendor type and business type of your vendors)
Once done updating the changes, click on the **Update Vendor Details** option to save your changes.
**Delete Vendor**
You can delete the added vendors from the dashboard:
1. Click the ellipsis icon on the vendor you want to delete.
2. Select **Delete Vendor**.
3. Click **Delete** in the pop-up window.
posthog.capture('Accordion Clicked', { title: "Can I upload multiple vendors at once in Easy Split?" })}>
**Batch Upload**
Use the **Batch Upload** feature to add a large number of vendors at a time. Add all the required details in a single file as per the required format and upload the file. Download the sample file to know what details are required to be filled in the batch file.
**To upload a batch file:**
1. Go to **Payment Gateway Dashboard > EasySplit - Vendor** and click **Upload File**.
2. Click **Choose a file** to select the file you want to upload, and then click **Upload**.
**Key Points:**
* The maximum file size allowed is **8 MB**, and a maximum of **50 records** can be included in the file.
* The file must be in the suggested format. If there are errors in the uploaded file, resolve all errors and upload the file again.
After successful processing, all vendor details will be added, and you can start processing payments to these vendors.
You can view the vendors that are added successfully from the uploaded files in the **Easy Split - Vendor** screen. An error log (if any) will also get downloaded to view more details.
posthog.capture('Accordion Clicked', { title: "How does split payments work?" })}>
To split payments to your vendors using Easy Split, you must first ensure the feature is activated for your Payment Gateway account. Fill out the Support Form or contact your Account manager to enable it for you. The feature should be activated for your Test and Production environment.
To split payments to vendors;
Add Vendor
Create Order
Accept Payment
Split Payment
View Split Settlement Details
Manage Refunds using Refund Splits
Manage Adjustments
Click [here](https://www.cashfree.com/docs/api-reference/payments/latest/split/easy-split-overview) to view it graphically
posthog.capture('Accordion Clicked', { title: "What are the different types of vendor settlements I can choose from?" })}>
You can define the settlement cycles right when you add the vendor. You can settle your vendors through the following settlement modes:
* [Vendor Instant Settlement](https://www.cashfree.com/docs/payments/split/settlements/instant)
* [Vendor Standard Settlement](https://www.cashfree.com/docs/payments/split/settlements/standard)
* [Vendor On-Demand Settlement](https://www.cashfree.com/docs/payments/split/settlements/on-demand)
To view the settlements, go to [Payment Gateway Dashboard](https://www.cashfree.com) > Settlements > Vendor. Vendor settlement details such as date & time, settlement type, vendor ID, settlement ID, and settlement status are displayed.
Generate the settlement recon report for each vendor settlement to view all the transaction details associated with the settlement, including any adjustments/refunds. Provide the file name, choose the file format, and click Generate Report.
Once you generate the report, you will be automatically redirected to the Reports section.
posthog.capture('Accordion Clicked', { title: "Can I delay my settlements to vendors?" })}>
You can delay vendor settlements by enabling deferred settlements in your account. To do this, ensure the Split API is called within the scheduled interval; otherwise, the full transaction amount will be credited to you.
Delays can be added at two levels:
Order Split Delay Post Successful Payment – Delay settlements after a payment is completed.
Defer Settlement – Hold settlements for a specified period before processing.
Click [here](https://www.cashfree.com/docs/payments/split/settlements/delay/overview) to know more
posthog.capture('Accordion Clicked', { title: "What are the different reports I have to track vendor payments?" })}>
The vendor reconciliation report lists all the transactions, adjustments, settlements and refunds that are associated with vendors. This will help you reconcile all transactions from your vendors with their respective settlement ID, time, and UTR.
Cashfree Payments offers a wide range of reports such as:
Vendor Recon Report
Transaction Summary Report
Refunds Report
Vendor Split Settlement Report
To know to view these reports, click [here](https://www.cashfree.com/docs/payments/split/reports/recon)
posthog.capture('Accordion Clicked', { title: "How do refunds get handled?" })}>
Refunded amount gets adjusted during the next settlement cycle. It will be deducted from commission amount of vendors who received settlement on that transaction.
posthog.capture('Accordion Clicked', { title: "What reports are available to track vendor payments?" })}>
| Report Type | Description |
| ------------------------------ | ------------------------------------------ |
| Vendor Recon Report | Reconcile vendor transactions and payments |
| Transaction Summary Report | View an overview of all transactions |
| Refunds Report | Track refund statuses and adjustments |
| Vendor Split Settlement Report | Monitor vendor settlement details |
View reports by day, week, or custom date range. Filter, search, and download options are available.
posthog.capture('Accordion Clicked', { title: "How can I delay settlements to vendors?" })}>
| Delay Type | Description |
| ------------------ | ------------------------------------- |
| Order-Level Delay | Set delay for individual transactions |
| Vendor-Level Delay | Set delay for specific vendors |
Enable deferred settlements in your account settings. Ensure the Split API is called within the configured settlement interval.
posthog.capture('Accordion Clicked', { title: "What are the different types of vendor settlements?" })}>
| Settlement Type | Description |
| -------------------- | -------------------------------------- |
| Instant Settlement | Funds transferred immediately |
| Standard Settlement | Funds transferred on a scheduled cycle |
| On-Demand Settlement | Funds transferred manually |
View settlements at: Payment Gateway Dashboard > Settlements > Vendor.
posthog.capture('Accordion Clicked', { title: "How can I add multiple vendors at once?" })}>
Use the **Batch Upload** feature:
1. Download the sample file
2. Enter vendor details in the specified format
3. Upload the completed file
posthog.capture('Accordion Clicked', { title: "Can I edit vendor details after adding them?" })}>
| Edit Method | Access Path |
| ----------- | ------------------------------------------------------------- |
| Dashboard | Payment Gateway Dashboard > Easy Split - Vendor > Edit Vendor |
| API | Use the Update Merchant Details API |
posthog.capture('Accordion Clicked', { title: "What are the key use cases for Easy Split?" })}>
| Use Case | Description |
| -------------------------------- | ------------------------------------------------ |
| Marketplace Aggregators | Split payments with multiple product vendors |
| EdTech Platforms | Share fees with instructors or educators |
| Franchise & Multi-Branch | Route payments to individual stores or locations |
| Investment/Insurance Marketplace | Same-day settlement to AMC/insurer accounts |
| Educational Institutes | Allocate student payments across departments |
| E-Commerce | Manage sellers within a single order |
| Online Appointments | Share earnings with service providers |
posthog.capture('Accordion Clicked', { title: "What are the vendor limits per transaction?" })}>
You can split a single transaction among a maximum of **5 vendors**.
posthog.capture('Accordion Clicked', { title: "How are refunds handled?" })}>
Refund amounts are:
* Deducted from the merchant’s next settlement
* Adjusted from vendor commissions if configured
* Applied only to vendors who received the original settlement
posthog.capture('Accordion Clicked', { title: "How can vendors be added to Easy Split?" })}>
| Method | Description |
| ------ | ---------------------------------------- |
| Manual | Add vendors from the dashboard |
| API | Use the Create Vendor API for automation |
posthog.capture('Accordion Clicked', { title: "How many settlements do vendors receive daily?" })}>
Vendors receive **one settlement per day**:
* Includes all unsettled transactions.
* Bank reference number provided for each payout.
* Share the reference number with vendors for tracking.
# Disputes and Chargebacks FAQs
Source: https://www.cashfree.com/docs/help/end-customer/disputes-and-chargeback
posthog.capture('Accordion Clicked', { title: "How can I report a dispute with a bank?" })}>
A buyer if want's to officially raise a dispute on a card payment, may reach out to the issuing bank with details of the transaction including: order ID, UTR number and payment details as may be necessary. You can get these details from the payment confirmation email that Cashfree sends at the time of a successful payment. You can contact your home branch or any other brand to report the dispute.
posthog.capture('Accordion Clicked', { title: "How can I open a dispute or chargeback with a seller?" })}>
You can open a dispute by clicking [here](https://www.cashfree.com/en/report-issue/) within 30 days of making the payment.
A dispute request may be raised where
* Payment is made but the order is not delivered (we recommend that buyer waits for at least 7 days from the date of payment before raising the dispute request in this case)
* Order received but varies significantly as compared to what was shown on the seller's website.
Once a dispute request is received, Cashfree works with both buyer and seller and collects the necessary documents. If the buyers wins the dispute, a chargeback is initiated by the seller where the seller reverses the transaction and the customer receives her money back.
posthog.capture('Accordion Clicked', { title: "I made a purchase but there is an issue. I want to open a dispute with a seller. How can I do it?" })}>
To open a dispute, you can report the issue within 30 days of payment by filling the form(link). Our team will look into the transaction and work with you and the merchant to mitigate and resolve the issue.
* In general, in case of a dispute where item is not received, a buyer must wait at least 7 days from the date of payment to escalate a dispute.
* Where an item has not been received, please do ensure you have given the seller enough time before opening a dispute
* We recommend that you share all details related to the transaction when you are filling the form. This will help us resolve the issue at the earliest.
posthog.capture('Accordion Clicked', { title: "What is a chargeback and dispute and difference between them?" })}>
A dispute is a claim filed by either a cardholder or the issuing bank. There may be multiple stages involved in a dispute until a resolution is received. A chargeback is one stage in the dispute life cycle. If the dispute resolution is not reached during the inquiry stage, a chargeback is initiated by the seller where the seller reverses the transaction and the customer receives her money back.
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).\
2. Go to the **Profile** section.
3. Select **Edit** next to the display name field.
4. Enter the updated name and submit the request.
5. Verify the change using the **OTP sent to your Aadhaar-linked mobile number**.
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Go to the **Profile** section.
3. Select **Edit** next to the phone number field.
4. Enter the new phone number and submit the request.
5. Verify the change using the **OTP sent to your Aadhaar-linked mobile number**.
# Fraud Prevention FAQs
Source: https://www.cashfree.com/docs/help/end-customer/fraud-prevention
posthog.capture('Accordion Clicked', { title: "How can I identify a fraudulent transaction before making a payment?" })}>
Before you make a payment:
* Make sure the website or app uses `https://`.
* Verify the business provides contact information and refund policies.
* Review customer feedback on trusted platforms.
* Don’t proceed if something feels rushed or suspicious.
posthog.capture('Accordion Clicked', { title: "How do I check if a merchant is trustworthy?" })}>
To verify a merchant before making a payment:
* Look for complete business details on their website.
* Check reviews on platforms like Google or Trustpilot.
* Be cautious of high discounts or full advance payment requests.
* Avoid unsolicited links from social media or messaging apps.
posthog.capture('Accordion Clicked', { title: "What are the red flags to watch for before paying?" })}>
Watch for signs of fraud:
* Poorly designed websites with broken links or missing contact details.
* Requests for full payment without an invoice or confirmation.
* Urgent requests to pay via unknown QR codes or links.
posthog.capture('Accordion Clicked', { title: "How do I protect my card and bank information from fraud?" })}>
To secure your financial information:
* Don’t share your card number, CVV, OTP, or passwords.
* Avoid saving card details on untrusted websites or apps.
* Enable SMS or email alerts for all transactions.
* Use trusted payment gateways like Cashfree.
posthog.capture('Accordion Clicked', { title: "Does Cashfree verify merchants to prevent fraud?" })}>
Yes. Cashfree verifies merchants through a strict onboarding and compliance process before enabling payment acceptance. However, Cashfree doesn’t manage order fulfilment. Confirm a merchant’s legitimacy before you pay. If you suspect fraud, report it [here](https://www.cashfree.com/en/report-issue/).
# Order and Delivery FAQs
Source: https://www.cashfree.com/docs/help/end-customer/order-and-delivery
posthog.capture('Accordion Clicked', { title: "How do I check the status of my order?" })}>
When an order is placed and the transaction is successful, Cashfree sends you a payment confirmation email. Cashfree is a payment gateway that helps merchants accept online payments.
The orders are processed at the merchant's end. To check the status of your order, we suggest that you contact the merchant. If the merchant is not responsive, you can report [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "I have cancelled/returned my order and have not received the refund yet. Can you help me?" })}>
Refunds typically take 5 to 10 working days to be credited, depending on the merchant’s refund policy and payment modes:
UPI: Up to 5 working days
Cards: Up to 7 working days
Net Banking and others: 7 to 10 working days
Once a refund is initiated, you will receive an email from Cashfree with details such as refund status (‘Refund Initiated’ or ‘Refund Processed’), Order ID, Refund ID, Payment Method, Date of Initiation, Date of Processing, and ARN(Acquirer Reference Number). The ARN, a unique ID from Cashfree’s partner bank, helps track the transaction in the bank statement. If the refund is processed but not credited, contact your bank with the ARN. If you haven’t received a ‘Refund Initiated’ email, contact the merchant. If they are unresponsive, feel free to report the issue [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "I made payment using Cashfree, but the order is not showing on the seller website/app. How do I view my order?" })}>
When an order is placed and the transaction is successful, Cashfree sends you a payment confirmation email. Cashfree is a payment gateway that helps merchants accept online payments.
The orders are processed at the merchant's end. To check the status of your order, we suggest that you contact the merchant.
If you have not received the payment confirmation, you can raise a request with us [here](https://www.cashfree.com/en/report-issue/)
posthog.capture('Accordion Clicked', { title: "I did not receive the order confirmation email from the seller. What should I do?" })}>
The orders are processed at the merchant's end, when an order is placed successfully, the merchant sends order confirmation email.
If you haven't received the order confirmation email from the merchant, do double-check your promotions, updates folder, or SPAM inbox. If the order confirmation email is not found, we suggest that you contact the merchant. If the merchant is not able to resolve your issue, you can raise a request with us [here](https://www.cashfree.com/en/report-issue/)
posthog.capture('Accordion Clicked', { title: "I want to track my order, or I am unable to view my order on the seller\'s website/application. Can you help me?" })}>
The orders are processed at the merchant's end. Cashfree is a payment gateway that helps merchants accept online payments.
To know the status of your order, we suggest that you contact the merchant. If the merchant is not responsive, you can report the issue [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "I want to modify/exchange my order. Can you help me?" })}>
The orders are processed at the merchant's end. Cashfree is a payment gateway that helps merchants with accepting online payments only.
To modify or exchange your order, we suggest that you contact the merchant.If the merchant is not responsive, you can report the issue [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "My order has not been delivered yet. Can you help me?" })}>
The orders are processed at the merchant's end.
Cashfree is a payment gateway that helps merchants accept online payments.
To know the status of your order delivery, we suggest that you contact the merchant.
If the merchant is not responsive, you can report the issue[here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: " I paid for a service, but it hasn\'t been delivered. What should I do?" })}>
Cashfree is a payment gateway that helps merchants with accepting online payments only.
To get an update on the service fulfilment, we suggest that you contact the merchant.
If the merchant is not responsive, you can report the issue [here](https://www.cashfree.com/en/report-issue/).
# Payment FAQs
Source: https://www.cashfree.com/docs/help/end-customer/payment-related
posthog.capture('Accordion Clicked', { title: "I made a payment. My account has been debited but the transaction failed. What should I do?" })}>
If the payment has been deducted from your account but the transaction failed, your account will be auto-credited within 3-5 working days as per bank's timeline.
We suggest that you wait for at least 5 working days from the payment date and check your bank statement at the end of the 5 days. If you face an issue after 5 working days, you can report the same [here](https://www.cashfree.com/en/report-issue/). For fastest resolution, please mention the UTR and the payment date.
[What is UTR and where will I find it?](https://www.cashfree.com/docs/help/end-customer/payment-related#what-is-utr-and-where-can-i-find-it)
posthog.capture('Accordion Clicked', { title: "I made a payment. My account has been debited but the transaction is showing pending. What should I do?" })}>
In certain cases, when a payment is initiated, the payment transaction may show as pending on the payment platform. Until the payment transaction shows successful, the order will not be placed.
Bank may take up to 2-3 working days to share the final status update for pending transactions.
During this time, Cashfree will wait for the update from the bank, if the bank confirms the transaction as successful, the transaction status will change to successful and your amount will be auto-credited to your account within 5-7 working days from the date the bank confirms the status.
However, if the bank marks the transaction as failed, your amount will be auto-credited to your account within 5-7 working days. We suggest that you check you bank statement after 7 days of date of payment in case of such transactions.
If you face an issue after 7 working days, you can report the same [here](https://www.cashfree.com/en/report-issue/). For fastest resolution, please mention the UTR and the payment date.
[What is UTR and where will I find it?](https://www.cashfree.com/docs/help/end-customer/payment-related#what-is-utr-and-where-can-i-find-it)
posthog.capture('Accordion Clicked', { title: "How can I check my order payment status?" })}>
When an order is placed and the transaction is successful, you will receive a payment confirmation email from Cashfree. Cashfree is a payment gateway that helps merchants with accepting online payments.
If there is no payment confirmation, this may mean that the transaction failed. If the amount is debited from your account, it should get auto-credited within 3-5 working days.
If you still have an issue, you can report the same [here](https://www.cashfree.com/en/report-issue/). For fastest resolution, please mention the payment date and provide your order ID.
posthog.capture('Accordion Clicked', { title: "I have made the payment but did not get any payment confirmation. What should I do?" })}>
If the payment has been successful you would receive a payment confirmation email from Cashfree. If you do not see the email, do double check your promotions, updates folder, or SPAM inbox.
If there is no payment confirmation email, this may mean that the transaction failed. If the amount is debited from your account, it should get auto-credited within 3-5 working days.
If you still have an issue, you can report the same [here](https://www.cashfree.com/en/report-issue/). For fastest resolution, please mention the payment date and provide your order ID.
{" "}
posthog.capture('Accordion Clicked', { title: "What is UTR and where can I find it?" })}>
UTR number stands for Unique Transaction Reference number. It is used for
identifying a particular transaction. You will find UTR number in your bank
statement. Some payment platforms may show it as Transaction ID or ARN.
posthog.capture('Accordion Clicked', { title: "I made a payment but the amount has been deducted twice. What should I do now?" })}>
If the amount has been debited twice, you can report your issue [here](https://www.cashfree.com/en/report-issue/). For the fastest resolution please do mention the payment date and Order ID. In the message section on the form, you can add transaction UTRs.
[What is UTR and where will I find it?](https://www.cashfree.com/docs/help/end-customer/payment-related#what-is-utr-and-where-can-i-find-it)
posthog.capture('Accordion Clicked', { title: "I haven\'t received the OTP to make the payment. What should I do?" })}>
Cashfree is a payment gateway that helps merchants accept payments using multiple payment mode such as net banking, UPI, wallets etc. If you have initiated a payment using any payment platform (For example Paytm, PhonePe, Net banking etc) and the OTP is not received, we suggest that you reach out to the payment platform or the merchant.
If the merchant is not responsive, you can report the issue [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "I made a payment to a Cashfree UPI ID. I can\'t see it on seller website/app. What should I do?" })}>
You can report your issue [here](https://www.cashfree.com/en/report-issue/). For the fastest resolution please do mention the payment date and Order ID. In the message section on the form, you can add transaction UTR.
[What is UTR and where will I find it?](https://www.cashfree.com/docs/help/end-customer/payment-related#what-is-utr-and-where-can-i-find-it)
# Refunds FAQs
Source: https://www.cashfree.com/docs/help/end-customer/refunds
posthog.capture('Accordion Clicked', { title: "What is the status of my Refund/Reversal?" })}>
You can check the status of an initiated refund for a transaction from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
Navigate to: Payment Gateway Dashboard → Transactions → Refunds → Initiated Refunds
Enter the corresponding Order ID to view the refund status.
A refund goes through various states, they are listed below:
PENDING- This status indicates that the refund is currently being processed. You can view detailed remarks for pending refunds by navigating to:
Payment Gateway Dashboard → Transactions → Refunds → Initiated Refunds → Pending.
SUCCESS- This status means that the refund has been successfully processed on our end and approved. However, please note that the refunded amount may take additional time to reflect in the customer’s bank or payment account.
CANCELLED- This status indicates that the refund has been cancelled. The merchant has been notified of the cancellation via the email ID registered on the [Merchant Dashboard](https://merchant.cashfree.com/merchants).
ON HOLD- This status means that the refund has been temporarily put on hold due to insufficient funds.
The refund processing time depends on the payment mode:
UPI: Up to 5 working days
Cards: Up to 7 working days
Net Banking and Others: 7 to 10 working days
The Reversals are typically processed within 5 working days for all payment modes.
{" "}
posthog.capture('Accordion Clicked', { title: "What is an ARN number in refunds" })}>
The ARN, a unique ID from Cashfree’s partner bank, helps track the transaction
in the bank statement.
posthog.capture('Accordion Clicked', { title: "I have not received my refund even after 7 working days. Can you help me?" })}>
The refund processing time depends on the payment mode.
The reasons for delayed refunds:
1. Clearing and Settlement: Refunds pass through payment networks and banks, where data matching and settlement delays depend on network efficiency.
2. Fraud Checks: Identity verification and risk reviews for flagged transactions can extend refund timelines.
3. Non-Business Days: Refund processing is paused on weekends and holidays, resuming only during business hours, leading to additional delays.
If your refund hasn’t been received within 10 working days, kindly report it [here](https://www.cashfree.com/en/report-issue/) with the payment date and Order ID for a quicker resolution.\
If you haven’t received a refund initiation email, please reach out to the merchant first. If they’re unresponsive, feel free to report the issue [here](https://www.cashfree.com/en/report-issue/)
posthog.capture('Accordion Clicked', { title: "I have not received the refund for my cancelled order/failed transaction. What do I need to do?" })}>
Refunds typically take 5 to 10 working days to be credited, depending on the merchant's refund policy and payment modes:
* UPI: Up to 5 working days
* Cards: Up to 7 working days
* Net Banking and others: 7 to 10 working days
Once a refund is initiated, you will receive an email from Cashfree with details such as refund status ('Refund Initiated' or 'Refund Processed'), Order ID, Refund ID, Payment Method, Date of Initiation, Date of Processing, and ARN(Acquirer Reference Number).
The ARN, a unique ID from Cashfree’s partner bank, helps track the transaction in the bank statement.
If the refund is processed but not credited, contact your bank with the ARN. If you haven’t received a 'Refund Initiated' email, contact the merchant. If they are unresponsive, feel free to report the issue [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "If the status of on hold due to insufficient then how do I recharge my wallet" })}>
To add money to your Refund Wallet:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Select the **Settings** icon in the upper-right corner of the screen.
3. Under Payment Gateway, select **Wallets**.
4. In the Refund Wallet section, select **Add money**. The virtual bank account details linked to your Cashfree Refund Wallet will appear.
5. Transfer funds to the displayed bank account using NEFT, RTGS, or IMPS.
6. Once you recharge, the credits should appear in your Cashfree wallet within 30 mins. Your refund will then be auto-processed, following the usual timeline for your payment method.
# Report a Fraud FAQs
Source: https://www.cashfree.com/docs/help/end-customer/report-fraud
posthog.capture('Accordion Clicked', { title: "I see Cashfree on my statement, I donot remember making any payment to Cashfree directly. I want to know what is this debit for?" })}>
Cashfree is a payment gateway that helps merchants accept online payments. If you are seeing Cashfree name mentioned on a statement, it would be related to a payment made to a merchant using Cashfree.
In case of a successful payment you would have got a payment confirmation email that would show the transaction details as well as merchant details. You can use the merchant details and contact the merchant for any transaction related clarification.
If the merchant is unable to resolve your issue you can report [here](https://www.cashfree.com/en/report-issue/). For fastest resolution we recommend that you provide the payment date, Order ID and UTR
[What is UTR and where to find it?](https://www.cashfree.com/docs/help/end-customer/payment-related#what-is-utr-and-where-can-i-find-it)
posthog.capture('Accordion Clicked', { title: "I am trying to reach the merchant but the merchant is not responding. Can you help?" })}>
Orders are processed at the merchants end, if the merchant is unresponsive you can report [here](https://www.cashfree.com/en/report-issue/). For fastest resolution, please do mention the payment date and order ID along with your concern on the message box.
posthog.capture('Accordion Clicked', { title: "I did not receive my order even after 10 days. I want to report a fraud case." })}>
The orders are processed at the merchant's end. Cashfree is a payment gateway that helps merchants with accepting online payments. To get a status of your order delivery, we suggest that you contact the merchant.
In case the issue still remains unresolved, you can report [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "How do I report a suspicious transaction?" })}>
If you see any suspicious or unauthorized transaction, you can report your issue [here](https://www.cashfree.com/en/report-issue/). Do mention your UTR and payment date on the form for fastest resolution. We would also suggest that you make sure that the suspicious activity or unauthorized transaction has not been made by a family member using your card without your knowledge, or is related to a prior authorized auto-debit as in case of periodic subscription plans.
# Subscriptions FAQs
Source: https://www.cashfree.com/docs/help/end-customer/subscriptions
posthog.capture('Accordion Clicked', { title: "How can I cancel or make changes to my NACH mandate?" })}>
You can cancel, amend, or temporarily suspend your NACH mandate at any time. To make changes, click [here](https://www.cashfree.com/en/report-issue/) and submit a request. We’ll guide you through the process and ensure your request is handled smoothly.
# FlowWise FAQs
Source: https://www.cashfree.com/docs/help/flowwise/general-faqs
FlowWise related Frequently Asked Questions.
posthog.capture('Accordion Clicked', { title: "What is FlowWise?" })}>
FlowWise is a Payments Management System built for growing or large businesses to enable smarter, easier, and more efficient use of multiple payment gateways.
posthog.capture('Accordion Clicked', { title: "What payment gateways does FlowWise support?" })}>
FlowWise currently supports the following payment gateways:
* Cashfree
* Razorpay
* Paytm
* PayU
* Techprocess / Ingenico / Worldline
* PhonePe
* Plural (PineLabs)
* Easebuzz
* PineLabs
* Stripe
* Atom (WIP)
* PayG
* Billdesk (WIP)
* CCAvenue
posthog.capture('Accordion Clicked', { title: "What are the different payment modes does FlowWise support?" })}>
* Cards
* Netbanking
* UPI
* Wallets
* EMI or BNPL providers
posthog.capture('Accordion Clicked', { title: "How does FlowWise increase the success rate?" })}>
FlowWise monitors success rates across payment gateways for all payment modes. Whenever a dip in success rate is seen on one payment gateway, FlowWise automatically routes the transaction through the next preferred payment gateway.
posthog.capture('Accordion Clicked', { title: "How to process refunds in FlowWise?" })}>
FlowWise manages back end orchestration effortlessly. You can initiate refunds from Cashfree Payments dashboard without having to integrate with other aggregators.
posthog.capture('Accordion Clicked', { title: "What is payment gateway distribution?" })}>
When setting up a payment configuration, you can define the gateway distribution percentage to allocate transaction volume across multiple payment gateways or aggregators, such as PayU, Paytm, and Razorpay.
For example, you can distribute transactions based on percentage, volume, or specific networks like Visa or Mastercard to a designated payment gateway. You can also set a priority gateway, ensuring that most transactions are routed through it.
If there is any success rate (SR) fluctuation or downtime in the primary gateway, transactions are automatically redirected to the next preferred gateway based on the assigned priority.
posthog.capture('Accordion Clicked', { title: "Can I delete a rule in FlowWise?" })}>
No, you cannot delete a rule. You can only enable/disable a rule.
posthog.capture('Accordion Clicked', { title: "What are the options based on which we can create rules in FlowWise?" })}>
You can create rules based on:
* Order currency
* Amount
* Payment mode
* Card scheme
* Card country
* Card bin
* Issuing bank
posthog.capture('Accordion Clicked', { title: "How many rules can I create in FlowWise?" })}>
There is no limit on the number of rules you can create in FLowWise.
posthog.capture('Accordion Clicked', { title: "How to enable seamless option on FlowWise?" })}>
To use FlowWise, the Payment Gateway account you are choosing should have seamless option enabled. To activate seamless option write to your corresponding payment gateway relationship manager asking to enable seamless mode for your account. Mention that you are using Cashfree Payments as the technology company to handle sensitive card data.
# Onboarding Related FAQs
Source: https://www.cashfree.com/docs/help/onboarding-related/general-faqs
posthog.capture('Accordion Clicked', { title: "I want to use both Payment Gateway and Payouts. Do I need to create separate accounts?" })}>
You can use all Cashfree products in a single account. You can share your requirement at the time of the first call with the payment expert. Once started, if you want to activate other Cashfree products, you can talk to your Account Manager to activate the desired products on your account.
posthog.capture('Accordion Clicked', { title: "I have a dropshipping business. Can I use Cashfree to accept online payments?" })}>
As per Cashfree's policy, we do not support drop shipping-related businesses.
posthog.capture('Accordion Clicked', { title: "I have just signed up. What should I do next?" })}>
Once you create an account, you need to verify your email ID, update all the details, and upload the scanned copies of the required [documents](/help/onboarding-related/general-faqs#what-are-the-documents-needed-for-activating-my-cashfree-account)
Our payment expert will call you within 24 working hours of account creation to understand your requirements. Do make sure that you have updated the right contact details so that the payment expert can reach you.
Your account will be activated within 24-48 working hours once all documents are verified.
Using the Cashfree Test account
You can use the test account to familiarise yourself with the dashboard and try out products and features even before going live. If you would like to try out the available integrations, you can use our Test API keys. To get the Test API Keys, log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **select product > credentials > test credentials**.
Important- Before you start transacting, you must activate your account. Click [here](/help/account/overview#create-account) to know more about account activation.
posthog.capture('Accordion Clicked', { title: "Cashfree partner guide" })}>
Join the Cashfree Partner Program and offer your clients a powerful suite of online payment products. You can integrate Cashfree with your product or refer to earn rewards.
When you join Cashfree as a certified partner, you get the best in the industry commissions on every transaction your referred clients make.
TABLE OF CONTENTS
* Become a Cashfree Partner
* Complete Partner KYC to activate the account
* Refer or add merchants to the Cashfree partner account
1. Refer merchants using the Cashfree Partner badge
2. Refer merchants using the Cashfree Partner referral links
3. Add merchants directly on your partner dashboard
* Onboarding process of referred merchants
* Partner commissions
1. Calculating your commission
2. Commission settlement process
* Track your earnings
* KYC-details
1. Business details
2. Document checklist
Become a Cashfree Partner
Go to the Cashfree Partner Sign Up page, fill in all the required fields and click on `Register`
Once you sign up as a partner with Cashfree, you will get a `Partner welcome email`.
Complete Partner KYC to activate the account
Once you sign up as a Cashfree Partner, you will receive a `Partner welcome email`
You can reply to the same email with the required business details and documents to complete the KYC process. Cashfree team will verify all the details shared by you and complete your account's KYC to enable settlements within 48 hours of submitting all documents
Commission settlement will be made only for accounts for which KYC has been completed.
Refer merchants using the Cashfree Partner badge
* Login to your Partner Dashboard > Summary
* On the summary tab, click on 'Copy Code'
* Add this code to your website/App
You would be able to refer merchants conveniently using your 'unique partner referral link' added in the badge
Refer merchants using the Cashfree Partner referral links
* Log in to your Partner Dashboard > Merchants
* Copy your unique partner referral link and share it with your clients
Add merchants directly on your partner dashboard
1. Navigate to Partner Dashboard > Merchants
2. Click on 'Add merchants' and fill in all the required details
3. Alternatively, you can also add details of multiple merchants instantly through the `Bulk upload` option. For this
Download the sample CSV file by clicking on the 'Sample file' link
Upload the details of your merchants in the same format
After uploading the CSV, you would be able to see `number of entries`, `successfully added`, `failed` entries and also be able to download the result CSV to check the exact reason for failure
Onboarding process of referred merchants
Once you\`ve added the merchants, Cashfree will notify the merchant to accept the invite and verify their email ID. The merchant will be required to submit the business details and upload the required documents.
To make the merchant onboarding quicker, you can also submit business details of your merchants and upload the required documents on your merchants' behalf in these simple steps:
1. Click on the `Activate` option shown for your merchant entries in the partner dashboard
2. You would be directed to the merchant account activation page, where you can fill in all the required business details of your referred merchant and upload their business documents
3. In case the merchants don`t verify their mail IDs, you can also resend the verification email to them by clicking on `Resend verification email'
This `Activate` option will only be shown for those merchants who have verified their email address
Partner commissions
By becoming a Cashfree partner, you can offer your clients a complete suite of online payments related products to manage their entire payment lifecycle and earn lucrative commissions. There are two types of commission structures:
1. Flat rate
2. Percentage of the transaction value
Calculating your commission
Commission as a flat rate
Let`s assume that you`re an e-commerce automation platform and you help e-commerce businesses in converting COD orders to pre-paid. Let`s say one of your clients, ABC Ltd, collects ₹10,000 using Cashfree, and you have offered Cashfree`s payment gateway to your ABC Ltd. at a markup of ₹100 over Cashfree\`s base rate of 3% (Minimum amount that would go to Cashfree).
Transaction amount (A) Cashfree's charge (Base rate) (B) Your markup (C) GST (D) Total amount paid by your client
₹10,000
3% (10,000\*3%) =
₹300
₹100 (300+100)\*18% = ₹72
B+C+D = ₹472
Commission as a percentage of the transaction amount
Let`s assume you have offered Cashfree`s payment gateway to ABC Ltd. at a markup of 1% instead of INR 100 over Cashfree\`s base rate of 3% (Minimum amount that would go to Cashfree
Transaction amount (A) Cashfree's charge (Base rate) (B) Your markup (C) GST (D) Total amount paid by your client
₹10,000
3% (10,000\*3%) =
₹300
1% (10,000\*1%) =
₹100 (300+100)\*18% = ₹72
B+C+D = ₹472
Commission settlement process
In case of Payment Gateway collections, when any customer makes a transaction on your referred merchant\`s website/app and the amount is settled to Cashfree, the commission on that transaction is reflected on your partner dashboard.
In case of Payout disbursals, when your referred merchant makes a payout for vendor payments, processing refunds or disbursing loans, etc., using Cashfree, the commission on that transaction is reflected on your partner dashboard.
Here's how you can initiate your commission settlement process:
On the first day of every month, calculate and create an invoice for the commission amount receivable for the previous month. i.e on 1st June,2021, create an invoice for the commission receivable for May. You can obtain details of the commission from your partner dashboard
The invoice you create should have your company`s and Cashfree`s GSTN, and amount details
Send this invoice to [finance@cashfree.com](mailto:finance@cashfree.com) at the beginning of every month
You will be able to claim your commission only if your partner KYC is complete and the commission structure is configured on your Cashfree partner account.
In case the commission structure is not configured on your partner account, please reach out to [partners@cashfree.com](mailto:partners@cashfree.com).
Track your earnings
1. Navigate to Partner Dashboard > Summary to check total daily transactions and daily transaction volume
posthog.capture('Accordion Clicked', { title: "Are there any specific businesses that are not supported by Cashfree?" })}>
Any services or products which are purchased/ offered for sale by a user to third parties from time to time, using these services. Products shall not include those banned products and services that are listed below:
1. Adult goods and services, which include pornography and other sexually suggestive materials (including literature, imagery, and other media); escort or prostitution services.
2. Alcohol, which includes alcohol or alcoholic beverages such as beer, liquor, wine, or champagne.
3. Body parts, which include organs or other body parts.
4. Bulk marketing tools, which include email lists, software, or other products enabling unsolicited email messages (spam).
5. Cable descramblers and black boxes, which include devices intended to obtain cable and satellite signals for free.
6. Child pornography, which includes pornographic materials involving minors.
7. Copyright unlocking devices, which include mod chips or other devices designed to circumvent copyright protection.
8. Copyrighted media, which includes unauthorised copies of books, music, movies, and other licensed or protected materials.
9. Copyrighted software, which includes unauthorised copies of software, video games, and other licensed or protected materials, including OEM or bundled software.
10. Counterfeit and unauthorised goods, which include replicas or imitations of designer goods; items without a celebrity endorsement that would normally require such an association, fake autographs, counterfeit stamps, and other potentially unauthorised goods.
11. Cryptocurrency exchanges, platforms dealing in cryptocurrency trading.
12. Drugs and drug paraphernalia, which include illegal drugs and drug accessories, including herbal drugs like salvia and magic mushrooms.
13. Drug test circumvention aids, which include drug cleansing shakes, urine test additives, and related items.
14. Endangered species, which include plants, animals, or other organisms (including product derivatives) in danger of extinction.
15. Gaming/gambling, which includes lottery tickets, sports bets, memberships/enrollment in online gambling sites, and related content.
16. Government IDs or documents, which include fake IDs, passports, diplomas, and noble titles.
17. Hacking and cracking materials, which include manuals, how-to guides, information, or equipment enabling illegal access to software, servers, websites, or other protected property.
18. Illegal goods, which include materials, products, or information promoting illegal goods or enabling illegal acts.
19. Miracle cures, which include unsubstantiated cures, remedies, or other items marketed as quick health fixes.
20. Offensive goods, which include literature, products, or other materials that:a) Defame or slander any person or groups of people based on race, ethnicity, national origin, religion, sex, or other factorsb) Encourage or incite violent actsc) Promote intolerance or hatred.
21. Offensive goods, crime, which includes crime scene photos or items such as personal belongings associated with criminals.
22. Prescription drugs or herbal drugs, which include drugs or other products requiring a prescription by a licensed medical practitioner.
23. Pyrotechnic devices and hazardous materials, which include fireworks and related goods; toxic, flammable, and radioactive materials and substances.
24. Regulated goods, which include airbags; batteries containing mercury; Freon or similar substances/refrigerants; chemical/industrial solvents; government uniforms; car titles or logos; license plates; police badges and law enforcement equipment; lock-picking devices; pesticides; postage meters; recalled items; slot machines; surveillance equipment; goods regulated by government or other agency specifications.
25. Securities, which include stocks, bonds, or related financial products.
26. Tobacco and cigarettes, which include cigarettes, cigars, chewing tobacco, and related products.
27. Traffic devices, which include radar detectors/jammers, license plate covers, traffic signal changers, and related products.
28. Weapons, which include firearms, ammunition, knives, brass knuckles, gun parts, and other armaments.
29. Wholesale currency, which includes discounted currencies or currency exchanges.
30. Live animals or hides/skins/teeth, nails, and other parts etc. of animals.
31. Multi-level marketing collection fees.
32. Ponzi schemes, pyramid, and chain marketing.
33. Matrix sites or sites using a matrix scheme approach.
34. Drop-shipped merchandise.
35. Any product or service which is not in compliance with all applicable laws and regulations, whether federal, state, local, or international, including the laws of India.
36. The Merchant shall not sell, purchase, provide, or exchange a cardholder’s name or MasterCard/Visa account number information in any form obtained by reason of a MasterCard/Visa Card transaction to any third party other than its MasterCard/Visa acquiring Member – Citrus Pay, or pursuant to a government/statutory or competent body’s request.
37. Pyrotechnic devices, combustibles, corrosives, and hazardous materials, which include explosives, fireworks and related goods; toxic, flammable, and radioactive materials and substances.
posthog.capture('Accordion Clicked', { title: "Is GSTIN mandatory for account activation?" })}>
The GSTIN is not mandatory for account activation, but we would recommend you to add the GST details so that you can avail of the GST benefits.
posthog.capture('Accordion Clicked', { title: "Do I need to make any changes to my website to make it compliant for account activation?" })}>
When you create an account on Cashfree, our team does a business background check including your website and app audit and verifies the details shared by you. On being satisfied, we activate your Cashfree merchant account within 24-48 hours.
To speed up the account activation, please ensure that your website is live and all the following details are mentioned on the website.
(Mandatory details)
1. Terms and conditions
2. About us
3. Contact us (one email ID and at least one valid phone number)
4. Privacy Policy
5. Registered name of the business as
(Other details - based on your business model)
1. Refund/return policy
2. Shipping & delivery policy
3. Product/services
4. Pricing
In case the Cashfree Payment Gateway has been activated and later it is found that the website does not comply with the terms and conditions, the account shall be deactivated at Cashfree's discretion.
posthog.capture('Accordion Clicked', { title: "What are the mandatory documents required for onboarding?" })}>
To complete onboarding, you must provide essential details and upload mandatory documents. The required documents may vary based on your business type but generally include:
Contact Information
Business PAN
Business Owner PAN
Business Details and Registration Documents
Website Details or App Details
Bank Account Details
Business Owner KYC
Declaration of Beneficial Ownership
Signed Service Agreement
Click [here](https://www.cashfree.com/docs/help/account/overview#create-account) to know more about each document"
posthog.capture('Accordion Clicked', { title: "What documents need to be uploaded based on business type?" })}>
The required documents vary by business type. Below are the key documents needed for verification:
-Individual- All of the following
PAN
Aadhar Card
Bank Account details
* Proprietor (with and without GSTIN) – Any one of the following:
Registration Certificate from the Registrar of Companies
Certificate/License under the Shops and Establishment Act or other applicable Acts
Sales Tax or Income Tax Return
* Partnership – Any one of the following:
Partnership Deed
Registration Certificate from the Registrar of Firms
* Society/Trust/NGO – Any one of the following:
Trust Deed
Society/NGO Registration Certificate
-PVT LTD- All of the following
LLP Corporation
Certificate of incorporation"
posthog.capture('Accordion Clicked', { title: "What additional documents do I need to upload based on the line of business (LOB)?" })}>
The required documents vary based on your business category and sub-category. Below are some key requirements:
* **SaaS (Software as a Service)**: AOC for PCI-DSS compliance
* **Food, Health and Beauty Supplements**: FSSAI License
* **Education (Schools, Colleges, Training Institutes, etc.)**: UGC/ICSE/CBSE/AICTE Certificate
* **Finance (Forex, Stock Brokerage, Payment Services, etc.)**: Relevant regulatory approvals (e.g., FEMA Registration, SEBI Certificate, PA/PG License)
* **Jewellery Business**: BIS Certificate / 916 or 925 Hallmark
* **Online Gaming**: RNG Certificate (if applicable), Legal Opinion
* **Pharmacy and Drug Stores**: Pharmacy License, Drug License, and compliance declarations
* **Government and Utilities**: BBPS Certificate, Registration based on sub-category
* **Travel and Hospitality**: IATA Certificate / IRCTC Agency Certificate
posthog.capture('Accordion Clicked', { title: "Do I need a website or an app for account activation?" })}>
Generally, you must have either a website or an app hosted on the App Store or the Play Store.
posthog.capture('Accordion Clicked', { title: "Does my business need to be registered in India?" })}>
Yes, your business must be registered in India to use Cashfree’s services.
posthog.capture('Accordion Clicked', { title: "What if my business is not registered? How can I proceed with account activation?" })}>
You can sign up as an Individual. Once your business is registered, you can create a new account and register under Proprietorship or another applicable business type.
posthog.capture('Accordion Clicked', { title: "Is it mandatory to have Aadhaar linked with a phone number for account activation?" })}>
Yes, Aadhaar must be linked to your phone number. You can update your linked number via the [UIDAI portal](https://uidai.gov.in).
posthog.capture('Accordion Clicked', { title: "Can I activate my account if I don\'t have a PAN?" })}>
No, PAN is mandatory. You can register as an Individual and provide your personal PAN for account activation.
posthog.capture('Accordion Clicked', { title: "Can I use the same email for multiple businesses?" })}>
No, each business must have a separate email ID for registration and account activation.
posthog.capture('Accordion Clicked', { title: "How much time does it take to complete the onboarding form?" })}>
Ideally, if you have all the documents ready, it takes you less than 5 minutes to fully finish the onboarding form.
posthog.capture('Accordion Clicked', { title: "What products does Cashfree offer?" })}>
A Quick Overview
* We help businesses collect and disburse payments with our wide range of innovative payment solutions
* You can start with one product or multiple products (for example, you can use Payment Gateway to accept payments on your website and use Payouts for making bulk payments.
* You get a dedicated account manager who becomes your single point of contact.
* You can add any number of users. Our multi-user module lets you track user actions and control access rights.
Cashfree offers a wide range of payment and banking solutions, including:
Payment Gateway: Accept payments through 180+ modes, including UPI, cards, wallets, and EMI.
Payouts: Send bulk payments instantly via bank transfers, UPI, wallets, and cards.
Buy Now Pay Later (BNPL) Suite: Includes Cardless EMI, Debit Card EMI, Credit Card EMI, and Pay Later options.
Subscription Payments: Automate recurring payments with UPI AutoPay and eNACH.
Marketplace Settlement: Automatically split payments and settle vendor commissions.
Secure ID: Instantly verify bank, UPI, PAN, Aadhaar, IFSC and GSTIN from a single dashboard tab.
Cross Border: This product helps Merchants/Payment Aggregators/Market Places who are based outside India to collect payment from customers based in India.
One Click Checkout: Enable one-click checkout with OTP auto-fill, smart address pre-fill, and 25% faster completion.
Cashgram: Accept payments without a website via shareable links or custom forms.
softPOS: Turn smartphones into POS terminals to accept card payments.
RiskShield: Prevent fraud with machine learning-based anomaly detection.
posthog.capture('Accordion Clicked', { title: "What are all the supported document types for KYC verification?" })}>
During the merchant onboarding process, you may need to upload various types of documents based on your business type and line of business. The documents are categorised as follows:
**Business Proof Documents:**
* Shop and Establishment Certificate/Licence
* Government-issued registration proof
* Municipal certificate
* Udyog Aadhaar
* Sales tax and income tax return
* ROC registration certificate
* Customer agreement and platform confirmation
**Entity Proof Documents:**
* Partnership deed
* Trust deed
* Society certificate
* HUF deed
* LLP documents
**Line of Business Proof Documents:**
* Non-profit: 80G/12A certificates or FCRA
* Travel: IATA/IRCTC certificates
* Food: FSSAI licence
* Gaming: RNG certificate and legal opinion
* Pharmacy: Drug licence and compliance declarations
* Financial services: SEBI, FEMA, NBFC licences
* Education: UGC/CBSE/ICSE/AICTE certificates
**Other Documents:**
* Bank statement
* Certificate of incorporation
* Board resolution
* GST certificate
* Beneficial owner ID proofs
For the complete list of supported document types and their technical parameters, see [supported document types](/api-reference/platforms/latest/merchant-onboarding/upload-documents#supported-document-types).
posthog.capture('Accordion Clicked', { title: "What specific documents are required for Society, Trust, and NGO businesses?" })}>
If your business is registered as a Society, Trust, or NGO, you need to provide the following documents for account verification:
**Required Documents:**
* **Trust Deed/Society/NGO Registration Certificate**: Primary registration document
* **FORM 80G/12A**: Tax exemption certificates for charitable organisations
* **Trust PAN and bank**: PAN details and bank account information specific to the trust
**Note:** The exact documents required may vary based on your organisation type and activities. Contact your account manager for the specific requirements during the onboarding process.
For detailed information about all document requirements, visit our [account activation guide](/help/account/overview#upload-documents).
# Cashfree Payments FAQs
Source: https://www.cashfree.com/docs/help/overview
Welcome to the Cashfree Payments FAQs—your resource for quick and clear answers about Cashfree products and services. Whether you're just starting with Cashfree or looking for advanced guidance, you'll find the answers you need here.
## Browse FAQs by category
The FAQs are organised into intuitive categories to make it easy for you to find answers. You can explore FAQs for the following products:
Account
Onboarding
Payment Gateway
Payment Links
Payment Forms
Easy Split
Subscriptions
FlowWise
softPOS
Payouts
Secure ID
End Customer
## Additional support
If you didn't find what you're looking for, you can:
* Contact the [support team](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for personalised assistance.
* Join the Cashfree Payments [Discord Server](https://discord.gg/ed9VWDnrh7) for developer support.
# Payment Forms FAQs
Source: https://www.cashfree.com/docs/help/payment-forms/faqs/faqs
posthog.capture('Accordion Clicked', { title: "What is a Payment Form and how does it work?" })}>
Payment Forms let you collect online payments via 120+ methods like UPI and net banking—no payment gateway needed! Customize the form, accept domestic and international payments, and collect customer details. Set a fixed or flexible amount and share the form via SMS, email, WhatsApp, or your website to start receiving payments instantly.
Click [here](https://www.cashfree.com/docs/payments/no-code/payment-forms/overview#creating-a-payment-form) to see how
posthog.capture('Accordion Clicked', { title: "How do I create a Payment Form?" })}>
To create a payment form:
1. Go to **Payment Gateway Dashboard** > **Payment Forms** > click **Create Payment Form**.
2. In the **Payment For** field, explain the purpose of payment to the customer. Keep this text short and precise. This information is necessary for customers to understand the purpose of payment.
3. Configure amount fields. You can specify a single or multiple amounts.
4. Personalize the URL to include your brand name for easy identification.
5. Specify the payment form validity time. (Validity time supported: 1, 2, 7, 14, 30 days, or set as No Expiry to keep it active always).
**Add Payment Details**
**Add Customer Details**
**Add Business Details**
Save and create the payment form. The payment form created will be active to collect payments. Share the payment form URL with your customers and start collecting payments instantly.
All the payment forms created will be visible in the **Payment Forms** screen. You can edit, cancel, activate a cancelled payment form, and also share the payment form details with your customers after you create it. You can see and track the payment statuses in the **Orders** section.
posthog.capture('Accordion Clicked', { title: "Can I generate a report for all payment form transactions?" })}>
Yes, you can generate a report for all Payment Form transactions.
The payment form report has the list and details of orders and payments made against the payment forms in the period selected. Order details, customer details, transaction amount, payment method, card details, and more are available in this report.
To generate the payment form report,
1. Go to Payment Gateway Dashboard > Reports.
2. In the Search & Filter field, select Payment Form, and click Generate.
3. Select the date range for which you want to view the report, and click Generate.
4. The report will be generated based on the criteria you have filtered. You can download the report after it has been generated.
posthog.capture('Accordion Clicked', { title: "How do I know when a payment is made via a Payment Form?" })}>
You will be notified about the payments made using the payment form via webhooks.
The Payment Form webhook will be triggered when your customers make a complete payment using the payment form you shared.
To start receiving webhook event notifications:
1. Go to **Payment Gateway Dashboard** > click **Developers** in the left navigation.
2. Select **Webhooks** in the **Payment Gateway** section.
3. Click **Add Webhook URL** and select the event you want to be notified about.
4. Enter the URL where you want to receive the webhook notifications, and click **Add**.
You will start to receive webhook event notifications on the URLs you have specified. You can use one URL to handle several different event types at once or specify individual URLs for specific events.
posthog.capture('Accordion Clicked', { title: "Can I use the same Payment Form for multiple products or services?" })}>
Yes, the same form can be set up to take in different product information and pricing. The customer can select and pay for the product/service he/she is interested in.
# Payment Links FAQs
Source: https://www.cashfree.com/docs/help/payment-links/faqs/faqs
export const link_id_0 = undefined
posthog.capture('Accordion Clicked', { title: "How do I start using Payment Links with Cashfree?" })}>
Simply sign up for a Payment Links account, and Cashfree Payment Gateway will be automatically activated for your account. The Payment Links feature will be available inside the **Payment Gateway** product.\
All payments collected via the payment links are automatically updated in the **Reports** and **Transactions** module in Cashfree Payment Gateway.
Know more in the documentation [here](https://www.cashfree.com/docs/payments/no-code/payment-link).
{" "}
posthog.capture('Accordion Clicked', { title: " Can I create a payment link for a restricted time period?" })}>
Yes, you can create a payment link in the Cashfree Payment Gateway Dashboard with an expiry limit to ensure you get paid within a specific timeframe.
posthog.capture('Accordion Clicked', { title: "What information do I need to provide to create Payment Links?" })}>
Enter the customer’s phone or email, amount, and purpose, then share the link. You can also enable SMS & Email notifications, set an expiry date, and allow partial payments for added flexibility.
Click [here](https://www.cashfree.com/docs/payments/no-code/payment-link#payment-link) to know more
posthog.capture('Accordion Clicked', { title: "Can I create Payment Links in bulk?" })}>
Yes, you can create Payment Links in bulk using the Batch feature. Simply fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) with your business requirements, and we’ll verify and activate it for your account. Meanwhile, you can test the flow in the sandbox.
Once activated, upload a file with the required details in the Batch section. Download the sample file to check the format.
posthog.capture('Accordion Clicked', { title: "Can my customers make multiple partial payments on Payment Links?" })}>
Yes, you can enable **Partial Payments** and provide the minimum amount you
wish to collect for a Payment Link. The customer can choose to make multiple
payments, between the minimum amount and the link amount. Cashfree will notify
you of all partial payments done.
posthog.capture('Accordion Clicked', { title: "Are international payments supported on Payment Link?" })}>
Yes, it is possible to enable international payments on Cashfree Payment
Links. Talk to us and help us understand your business for quick activation.
If you have a **Paypal** account, connect **Paypal** to Cashfree and start
offering Paypal as a checkout option on the payment page instantly.
posthog.capture('Accordion Clicked', { title: "What are Orders?" })}>
Each time your customer opens a payment Link and attempts payment, a new
Order is created against that link. This gives you the information on how
many times the customer has visited the link before completely paying the full
amount. You can follow up with such customers and try to improve your
conversion rate.
posthog.capture('Accordion Clicked', { title: "What are Cashfree Payment Links and why should I use them?" })}>
Payment Links by Cashfree is the easiest way to receive payments from your customers for any goods or services, without taking them to any app or website.
Payment Link can be shared with the customer via different channels like WhatsApp, SMS, email, etc., and upon clicking the link, your customers can pay using all available payment methods. Cashfree Payments will notify you when payment(s) are made using the link.
Payment Links are a **no-code solution** that are used to accept online payments without any payment gateway integration required. Any business can create a payment link and collect online payments. No website required.
posthog.capture('Accordion Clicked', { title: "How can I create payment links for my business?" })}>
1. Go to **Payment Gateway Dashboard** > **Payment links** > **Create Payment Link**
2. List the reason, the amount and the customer details.
3. You can also select an expiry time for the link, a custom thank you message, add a note in the more section.
4. Click create and all set!
posthog.capture('Accordion Clicked', { title: "How can I create UPI payment links for my business?" })}>
Create and share UPI payment links with your customers to accept payments via UPI applications. To create a UPI payment link, you first need to add your product and customer details. You can share the payment link via SMS, email, WhatsApp, or any other platform. To make payments, customers must click the URL that you have sent, and a list of UPI apps installed on their mobile will be displayed. Customers can select any UPI app and complete the payment. A maximum amount of rupees 1 Lakh can be collected using the UPI payment link.
To create a UPI payment link:
1. Go to **Payment Gateway Dashboard** > **Payment Links** > click **Create Payment Link**.
2. Select the option **Create UPI Link**.
3. In the **Payment For** field, explain what the customer is making the payment for. Keep this text short and clear. This information is important for customers to understand the purpose of payment. Partial payments are not allowed for the UPI payment method.
4. Set the **Link Expiry** limit.
5. Enter the customer details (phone number and email ID) to send the payment link.
6. Select the option **Send Auto Reminders** to send payment reminders automatically to your customers.
7. Enable **Send Auto Reminders** option to notify your customers about the payment. Click [here](/payments/no-code/payment-link) to know more.
8. You can add the **Link ID** and additional description for your reference. This will not be visible to your customers.
posthog.capture('Accordion Clicked', { title: "What information is required to create a Payment Link?" })}>
To quickly request payment from your customer via Payment Link, you simply need to provide the customer’s phone or email information, and the amount and purpose for the link. Once the details are entered, the link can be shared with the customer.
While creating a Payment Link, you can:
* Enable the **Send SMS** and **Email** checkboxes, and Cashfree will send the link to the customer on the provided contact information.
* Set the **expiry** for the link.
* Enable **partial payments** if you want the customer to make payments in parts.
posthog.capture('Accordion Clicked', { title: "Can I generate a report of all payment link transactions?" })}>
Yes, you can generate a report of all payment link transactions.\
The payment link orders report provides the list and details of orders and payments made against all payment links within the selected period. This includes order details, customer details, transaction amount, payment method, transaction status, settlement UTR (if the settlement is complete), and more.
To generate the payment link orders report:
1. Go to **Payment Gateway Dashboard** > **Reports**.
2. In the **Report Type** field, select **Payment Link Transactions**, and click **Generate**.
3. Select the date range for which you want to view the report, and click **Generate**.
The report will be generated based on your selected criteria. You can download the report after it has been generated.
posthog.capture('Accordion Clicked', { title: "Do I get notified when a payment is made on a payment link?" })}>
Yes, you can use webhooks to get notified about different events such as orders, payments, and settlements.
The **Payment Link webhook** will be triggered when your customer makes a complete or partial payment using the payment link you shared. You will also be notified via the same webhook when the payment link gets cancelled or expired.
posthog.capture('Accordion Clicked', { title: "How to cancel or delete a payment link?" })}>
You can’t permanently delete a payment link, but you can cancel it to stop receiving payments.
From the [Merchant Dashboard](https://merchant.cashfree.com/auth/login), click the **ellipsis (⋮)** icon next to the link and select **Cancel**.
From API: Use POST /links/{link_id_0}/cancel (works only for ACTIVE links).
Once cancelled, no further payments can be made.
Click [here](/payments/no-code/customize/cancel-payment-link) to know more.
posthog.capture('Accordion Clicked', { title: "Can I create a payment link for a restricted time period?" })}>
Yes, you can create a payment link in the Cashfree payment gateway dashboard, with an expiry limit to make sure you get paid within a specific timeframe.
posthog.capture('Accordion Clicked', { title: "How to share a Payment Link?" })}>
The payment link can be shared via SMS, email, Whatsapp or any other platform.
# Integrations
Source: https://www.cashfree.com/docs/help/payments/integrations/integrations
posthog.capture('Accordion Clicked', { title: "How do I integrate Cashfree with my website or mobile app?" })}>
**Cashfree offers multiple integration APIs for:**
* Website integration
* Mobile SDK integration
* Predefined plugins for major e-commerce platforms like:
* [Shopify](https://www.shopify.com)
* [Magento](https://magento.com)
* [Woo-Commerce](https://woocommerce.com)
* [OpenCart](https://www.opencart.com)
* [WHMCS](https://www.whmcs.com)
* [PrestaShop](https://www.prestashop.com)
You can make use of these APIs to set up Cashfree payment gateway with your website or mobile app and start accepting payments.
posthog.capture('Accordion Clicked', { title: "What are the different ways I can set up the payment gateway for my business?" })}>
Cashfree lets you integrate your [website](https://www.cashfree.com/payment-gateway-india/) or [mobile app](https://www.cashfree.com/payment-gateway-india/) with our payment gateway to accept payments. Over and above this, we also offer [plugins](https://www.cashfree.com/payment-gateway-india/) to major ecommerce sites like [Shopify](https://www.shopify.com), [Magento](https://magento.com), [Woo-commerce](https://woocommerce.com), [OpenCart](https://www.opencart.com), [PrestaShop](https://www.prestashop.com), [WHMCS](https://www.whmcs.com).
[Click here to know more](/payments/plugins/others#whmcs).
posthog.capture('Accordion Clicked', { title: "What are the different web integrations possible with Cashfree?" })}>
There are three types of web integrations possible with Cashfree:
1. [**Popup**](/payments/online/web/redirect#3-open-cashfree-checkout)
2. [**Cashfree Hosted**](/payments/online/web/redirect)
3. [**Element**](payments/online/element/overview)
You can instantly set up any of these based on your requirements.
posthog.capture('Accordion Clicked', { title: "What are the different mobile SDK integrations possible with Cashfree?" })}>
Cashfree offers a wide range of mobile SDK integrations such as:
* [Android SDK](/payments/online/mobile/android)
* [iOS SDK](/payments/online/mobile/ios)
* [React Native SDK](/payments/online/mobile/react-native)
* [Flutter SDK](/payments/online/mobile/flutter)
* [Cordova SDK](/payments/online/mobile/cordova)
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my Shopify website?" })}>
Yes, we do provide a predefined [plugin for WHMCS](/payments/plugins/others#whmcs) that helps you set up Cashfree payment gateway with your [Shopify](https://www.shopify.com) account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my Magento website?" })}>
Yes, we provide a predefined [plugin for Magento](/payments/plugins/magento#magento-payment-plugin) that helps you set up Cashfree payment gateway with your [Shopify](https://www.shopify.com) account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my Woo-Commerce website?" })}>
Yes, we provide a predefined plugin for [**Woo-Commerce**](/payments/checkout/woocommerce) that
helps you set up Cashfree payment gateway with your Woo-Commerce account in no
time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my OpenCart website?" })}>
Yes, we provide a predefined plugin for [**OpenCart**](/payments/plugins/others#opencart) that helps
you set up Cashfree payment gateway with your OpenCart account in no time, and
with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my PrestaShop website?" })}>
Yes, we do provide a predefined plugin for [**PrestaShop**](/payments/plugins/others#prestashop) that
helps you set up Cashfree payment gateway with your PrestaShop account in no
time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my WHMCS website?" })}>
Yes, we do provide a predefined plugin for [WHMCS](/payments/plugins/others#whmcs) that helps you set up Cashfree payment gateway with your Shopify account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree with Shiprocket?" })}>
No. Cashfree does not currently support integration with Shiprocket. Integrations with other major e-commerce and platform partners are supported.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to Paytm?" })}>
Follow these steps to show Paytm as a payment option on your checkout page. You need to create a Paytm business account and connect Paytm with Cashfree. The process takes **24–48 hours**, after which Paytm will be available as a payment option for your customers.
1. **Create a Paytm Business Account:**
* Go to [Paytm Business](https://business.paytm.com/) and create a test account.
2. **Receive Test Credentials:**
1. After creating the test account, Paytm will send you an email with your *Merchant Staging Credentials*.
2. Forward this email to the Cashfree team.
3. Alternatively, you can find these details in your Paytm dashboard under the **Test API Details** tab.
3. **Share Test Credentials:**
1. Share your test credentials with your Cashfree Account Manager.
2. To activate your production account, Cashfree will place **three test orders** on Paytm.
3. Your account manager will share the status of these orders, which you need to forward to Paytm.
4. **Receive Production Credentials:**
* After verifying the test orders, Paytm will generate the following production credentials for your merchant account:
* Website (for web)
* Merchant ID
* Merchant Key
* Industry Type ID
* Channel ID (for web)
* Production Server URL
5. **Activate Paytm on Cashfree:**
* Share your production credentials with your Cashfree Account Manager.
* Once this is done, the Paytm payment option will be activated on your account.
For any queries, contact your Account Manager or submit a [Support Form](https://merchant.cashfree.com/auth/login).
posthog.capture('Accordion Clicked', { title: "Can we fetch the list of installed apps for mobile web integration?" })}>
No, it's not possible to fetch the list of installed apps from a mobile web environment. However, you can display the default UPI apps such as Google Pay, PhonePe, and Paytm on both Android and iOS devices.
# Offers
Source: https://www.cashfree.com/docs/help/payments/offers/offers
posthog.capture('Accordion Clicked', { title: "What is the Offers Section in [Merchant Dashboard](https://merchant.cashfree.com/merchants)?" })}>
Boost Sales with Discounts & Cashback! Attract customers, increase AOV, and drive conversions with easy-to-set-up offers.
Cashfree Payments lets you create discounts & cashback deals across multiple payment methods for a seamless shopping experience.
Click [here](https://www.cashfree.com/docs/payments/checkout/coupons#overview-of-offers) to know more
posthog.capture('Accordion Clicked', { title: "How can I create and show offers to my customers on checkout?" })}>
Offer discounts and cashback to attract customers and improve sales when they make payments on your website or apps. You can specify different offers on various payment methods and give your customers the flexibility to pay from the payment method they choose.
When you create the offers, you can:
* Specify the offer code and offer type (Discount or Cashback).
* Select the payment methods on which the offers should be applicable.
* Reduce the total amount a customer pays by a percentage or a flat amount.
* Specify the maximum number of transactions allowed per payment method.
* Define the offer validity period.
* View a consolidated report for each offer you created.
Offers will automatically be applicable for businesses using Cashfree Payments hosted checkout pages and plugins, and no additional integration effort is required. You can create Offers using our Payment Gateway Dashboard.
**Create Offers**
**To create an offer:**
1. Go to **Payment Gateway Dashboard > Offers > Create New Offer**.
2. Specify the offer details:
* Enter a title for the offer that the customers can relate to.
* Add an offer code and an offer description. These details will be visible to customers on your checkout page or plugin during payment.
3. Specify the offer's start and end dates and its terms and conditions:
* You can link your business's terms and conditions or add a short description.
4. Select the offer category that applies to your business:
* Provide discounts, cashback, or both to your customers.
5. Select the discount type:
* Provide discounts at a flat rate or as a percentage.
* Specify the maximum discount amount or discount percentage for the selected type.
6. Select the payment modes for which the offers apply:
* Choose all or specific payment modes.
* Optionally, specify the banks and card types relevant to the offer.
* Click **Create**.
The offer is now active and available in the **Offers** section. You can activate or deactivate the offer at any time.
**Offers Shown to Customers**
When customers initiate a payment, all available offers are listed on your checkout page. Offer details like the description and code will be visible to customers, so ensure you clearly explain your offer's context using these fields.
Customers can select an offer and proceed with the payment. The reduced amount is displayed on the checkout page, and the customer completes the payment with the final amount.
posthog.capture('Accordion Clicked', { title: "How to create No Cost EMI offer on Cashfree?" })}>
Log in to **Cashfree Payments** > **Offers** > **Create No-Cost EMI**
Enter Details – Add a title, offer code, and description.
Set Timeline – Define start and end dates.
Choose EMI Options – Select credit/debit card EMI, banks, and duration (3, 6, 9 months).
Set Limits – Control how many times the offer can be used.
Activate – Ensure the offer is live for customers.
{" "}
posthog.capture('Accordion Clicked', { title: "Can I deactivate a running offer anytime?" })}>
Yes, you can deactivate an offer at any point in time. To change the status of
an offer, select the toggle button in the **Status** (Active/Inactive). Click
on a particular offer to view the offer details. You can **Deactivate** the
ongoing offer, and if you want to create a similar offer, select the
**Duplicate** option.
posthog.capture('Accordion Clicked', { title: "Do I need any additional integration to use offers?" })}>
Offers will automatically be applicable for businesses using Cashfree Payments hosted checkout pages and plugins, and no additional integration effort is required. You can create Offers using our Payment Gateway Dashboard. Merchants who are using the upfront TDR model will not be allowed to create offers.
# Orders and Payments
Source: https://www.cashfree.com/docs/help/payments/orders-and-payments/orders-and-payments
posthog.capture('Accordion Clicked', { title: " Can I receive payments from my customers without integrating Cashfree to my website?" })}>
You can use the Cashfree Payment Gateway Dashboard to create orders and accept payments using
[payment link](https://www.cashfree.com/docs/payments/no-code/payment-link#payment-link). These links can be sent to your customers via email or SMS, without the need to integrate Cashfree to your website.
{" "}
posthog.capture('Accordion Clicked', { title: " Can I create a payment link for a restricted time period?" })}>
Yes, you can create a payment link in the Cashfree payment gateway dashboard.
With an expiry limit to make sure you get paid within a specific timeframe.
posthog.capture('Accordion Clicked', { title: "I run an NGO. How can I use Cashfree to accept donations?" })}>
Cashfree provides you with the flexibility to create **PayMe links**, a specially crafted payment link that your customers can use to pay any amount of their choice to your account.
Here's how you can set up PayMe links to help receive donations for a cause:
1. Go to **PG Dashboard > PayMe > Add PayMe Link**.
2. Enter a **PayMe Identifier** and **PayMe Description**:
* **PayME Identifier**: The URL identifier after `https://www.cashfree.com/donation/{identifier}` which will be shared with customers. (Example: covid-relief-fund).
* **PayME Description**: Title of the campaign. (Example: India Needs Oxygen and Vaccines!).
3. Enter the phone number on which you want to be notified when your customers make the payments. You can also add a secondary phone number.
4. Click **Create A PayMe Link**.
5. Go to **PG Dashboard > PayMe > PayMe Details**.
6. Click **ADD FORM / EDIT FORM**.
7. In the subsequent form edit screen, add the following fields:
1. Small Input for **Donor PAN** (if you want to collect donor PAN details):
* Field Label - Donor PAN.
* Field Options - Required (enable if you want to keep PAN mandatory).
2. Large Input for **Donor Residential Address** (if you want to collect donor address details):
* Field Label - Residential Address.
* Field Options - Required (enable if you want to make the address mandatory).
3. Use multiple **Section Breaks** to add the static text content to show beside the form.
* **Field Label** is shown as a section title on the website (Example: Contact Us).
* **Field Description** is shown as section text content on the website.
* To add new lines in the **Field Description** text, use \
in the text, and the content after that will be in a new line. Do not use the Enter key for this purpose (Example: the text "[care@cashfree.com](mailto:care@cashfree.com)\
+9199999xxxxx\
Address" will be shown as follows, with content after \
shown in a new line).
* You can use the following content (one section break for each section) as a reference to create a complete donation page:
1. **Donation Cause**:
* Mention how the donated funds will help Covid-19 patients and if you have partnered with any other donation agency.
* Example: Our hospitals are going through dire situations, we urgently need more oxygen cylinders, concentrators and vaccine doses to save as many lives as possible. \
This campaign started as a self-funded mission to help hospitals across the country get immediate access to 100 oxygen concentrators and fund 5000 vaccine doses. 2. **Tax Exemption Details**: * If your organisation is eligible to give 80G certificates, clearly mention your registration number and PAN details. * Example: Your contribution has an exemption of 50% under Section 80G of the IT Act. An 80G certificate will be provided within a few days if a valid PAN and residential address are provided by the payer. Compulsory for donations above Rs. 50,000. \
Registration No: XX \
PAN: XX. 3. **Contact Us**: * Provide your valid contact details so donors can reach out to you. * Example: [youremailid@yourdomain.com](mailto:youremailid@yourdomain.com)\
+9199999xxxxx\
Your Registered Address. 4. **Terms & Conditions**: * Mention any terms and conditions if applicable to donors. * Example: Donations using this link can be made by Indian citizens only (residents and non-residents). We accept cards issued outside India. 8. Click **Save Form** to save the changes. 9. You can check the link on `https://www.cashfree.com/donation/{identifier}`. This is different from the usual PayMe address - `https://cashfree.com/payme/{identifier}`. 10. If you follow all the above-mentioned steps correctly, the final output would be similar to the image below:
Now, go ahead and start collecting funds for a cause that's dear to you!
{" "}
posthog.capture('Accordion Clicked', { title: "I want to accept international payments. Can I use Cashfree to accept payments in other currencies?" })}>
Yes, you can use Cashfree to accept international payments in other currencies. Here are the key points:
Cashfree offers a Global Collections feature that allows you to accept international payments from customers.
You can accept payments in more than 17 currencies from over 180 countries. Click [here](https://www.cashfree.com/docs/payments/international-payments/global-collections/collection-accounts#supported-currencies) to see the currencies we accept.
posthog.capture('Accordion Clicked', { title: " Can I receive international payments via PayPal using Cashfree?" })}>
If your business deals with customers who want to pay using PayPal, you can link your existing PayPal account to your Payment Gateway and accept payments from those customers. You can accept payments from international customers using this account.
USD will be the default currency. You must complete your KYC to receive payments in INR.
{" "}
posthog.capture('Accordion Clicked', { title: "I am an existing PayPal user. How do I connect my PayPal account with Cashfree?" })}>
Yes, if you already have an account with PayPal, you need to authorise
Cashfree to collect payments.
{" "}
posthog.capture('Accordion Clicked', { title: "When will the payment gateway charges be deducted for my transactions?" })}>
For every transaction that your customers make through Cashfree, TDR will be deducted from the total amount and the remaining amount will be settled to your bank account. However, we have a postpaid model as well. Click [here](https://www.cashfree.com/docs/payments/split/billing/configuration#billing-configuration) to know more.
posthog.capture('Accordion Clicked', { title: "How do I initiate refunds in Cashfree?" })}>
You can initiate refunds either using our APIs or from within the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
Steps: Navigate to **Payment Gateway Dashboard → Transactions → Payments**.
Search for the transaction you want to initiate a refund for, and click Initiate Refund.
By default, the entire amount is refunded. If you issue a partial refund, ensure the partial refund option is selected and enter the desired value in INR.
{" "}
posthog.capture('Accordion Clicked', { title: " Can I initiate bulk refunds in Cashfree?" })}>
Yes, use the Batch Refunds feature to initiate refunds for a large number of payments at a time.
Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **Payment Gateway > Transactions > Refunds > Batch Refunds > Upload File**. Add all the required refund details in a single file as per the required format and upload the file.
posthog.capture('Accordion Clicked', { title: "How long does it take to process refunds?" })}>
You can check the status of an initiated refund for a transaction from the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **Payment Gateway > Transactions > Refunds > Initiated Refunds**, and enter the corresponding Order ID.
The refund processing time depends on the payment mode:
* UPI: Up to 5 working days.
* Cards: Up to 7 working days.
* Net Banking and others: 7 to 10 working days.
posthog.capture('Accordion Clicked', { title: "What should I do before updating or displaying the status of a transaction or order to the customer?" })}>
Before you update or display the status of a transaction or order to the customer, complete the following steps to ensure that the status is accurate:
1. Check the status manually in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
Sign in to the [Cashfree Merchant Dashboard](https://merchant.cashfree.com/auth/login) to view the current status of the transaction or order. Use this method for one-time checks or if API or webhook integration isn't set up.
2. Use the return URL flow to confirm the final status.
After the payment reaches a final state (such as SUCCESS or FAILED), Cashfree redirects the customer to the return URL you provided. At this point, call the Get Order/Transaction Status API to confirm and display the transaction status to the customer.
3. Handle redirection failures and delayed status changes with webhooks.
If the return URL redirection fails or if the transaction moves from an intermediate state (such as PENDING) to a final state later, use webhook notifications to receive real-time updates. This helps ensure your system remains accurate even without redirection.
4. Use the API to retrieve the latest status.
To programmatically check the current status of an order, call the Get Payment Status for an Order API. Use this method to confirm the status before updating it on your system or displaying it to the customer.
# Product Walkthrough
Source: https://www.cashfree.com/docs/help/payments/product-walkthrough/product-walkthrough
posthog.capture('Accordion Clicked', { title: "Cashfree Payment Gateway - New Dashboard" })}>
Cashfree Payment Gateway helps businesses accept domestic and international payments, with a wide range of payment options. You can easily collect payments from your customers using our pre-built checkout integrations or customize the payment flow (Seamless Basic and Seamless Pro) for your customers in line with your business needs.
**Accessing Your Cashfree Payment Gateway Dashboard**
* **Login** to your Cashfree Account.
* Navigate to **Payment Gateway** → Click on the **Access** option to proceed.
**Dashboard Overview**
The **All-New Cashfree Payment Gateway Dashboard** is divided into the following parts:
**Summary**
The Summary section gives an overview of key metrics in the payment gateway dashboard, including daily and weekly transaction insights.
Here, you can check the summary of:
* **Recent Settlements**
* **Disputed Transactions**
* **Suspicious Transactions**
* Total number of **Transactions & Refunds**
Use the **Date Filter** to view details for a specific period. The **Business Metrics** provided help with informed decision-making.
**Transactions**
Under **Transactions**, you can see details of all payments at different stages: refunds, disputes, and suspicious transactions.
**Payments**
* View all received payments and their status against created orders.
* Click on a transaction to view **Customer Details** such as Name, Email, and Contact Number.
* Use filters like **Status**, **Payment Methods**, and **Order Amount** to search for transactions.
* To initiate a refund:
* Click **Initiate Refund** for successful transactions.
* For partial refunds, specify the amount and confirm.
* Refunds are processed within 5 working days.
**Refunds (New!)**
* Use the Refunds tab to view all initiated refunds.
* To check refund status, click on the transaction and view details.
**Disputes**
The Disputes tab lists transactions marked as disputed.
* Disputed transactions arise when a customer questions the validity of a transaction.
* Merchants can upload documents to validate transactions by clicking **Respond**.
* The transaction status will be marked as **Dispute Opened** until resolved, after which it is either **Dispute Closed** or refunded to the customer.
* Common dispute reasons include unauthorized transactions, billing errors, or dissatisfaction with goods/services.
**Suspicious Transactions**
* High-risk transactions are marked as **Suspicious**.
* Details of suspicious transactions are available by clicking on the transaction.
**Settlements**
The Settlements tab allows you to view all settlements for customer payments.
* Use filters to find specific transactions.
* Download settlement reports using the **Download** button.
**Instant Settlements (New!)**
* Gain immediate access to funds for better cash flow management.
* To enable instant settlements, fill out the provided form.
**Payment Links**
Under **Payment Links**, view payments as **Received**, **Awaited**, or **Expired**.
**Creation**
* Create a payment link by clicking **Create Payments Link** → Enter details → Set order expiry time → Click **Create & Send**.
**Details**
* View transaction details, including Name, Email, and Number of the customer.
* Track the status of the payment link on this page.
* Reshare or edit payment links if the payment is awaiting.
**Batch Payment Links**
* Generate payment links for multiple transactions under the **Batch** tab.
* Download the sample file, upload transactions, and click **Upload File**.
**Reports**
Cashfree offers a variety of reports for better understanding and reconciliation, such as:
* **Transactions**, **Settlements**, **Refunds**, and **Ledger Reports**.
**Downloading Reports**
* Select **Report Type**, specify the period and filters, then click **Generate Report**.
* Reports can be downloaded in CSV format.
**API Keys**
* Generate API keys by clicking **Generate Key** and authenticate via OTP.
* View or reset keys through the dashboard.
**Settings**
* **Branding**: Customize your logo and brand colors.
* **Payment Methods**: View and manage activated payment methods.
* **Merchant Notifications**: Configure notifications for payments, refunds, and risk alerts.
* **Bank Accounts**: View active and inactive settlement bank accounts.
For testing, switch to the **Test Environment**. For queries, fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
# Instant Settlement
Source: https://www.cashfree.com/docs/help/payments/settlements/instant-settlements
posthog.capture('Accordion Clicked', { title: "What is an instant settlement?" })}>
Cashfree’s instant settlements enable businesses to receive funds almost instantly, with cycles starting from 15 minutes, reducing the standard T+1 or T+2 settlement periods. Eligibility requires meeting specific criteria. For more information, fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
Instant Settlement is an advanced payment gateway feature offered by Cashfree that lets you access your funds within 15 minutes of payment capture from the customer. This will help you to respond faster to new business opportunities, and get complete control over your working capital.
posthog.capture('Accordion Clicked', { title: "How Instant Settlements will help you grow your businesses?" })}>
* Manage your working capital better: With instant access to your funds, you can plan your business expenditure better and drive your business towards growth. This can also help avoid the dependency on costly short-term loans to meet business needs.
* Make fool-proof projections: You can now plan your short-term business goals better without the need to assume the revenue you are yet to receive. You can take calculated risks based on your liquidity and not shoot in the dark.
* Handle refunds and chargebacks better: The uncertainty around the usual settlement cycles often affect transactions where the customer has requested for a refund or a chargeback immediately. With instant settlements, you get instant access to those funds and in case of refunds or chargebacks, you can happily reverse the payments instantly, without the need to incur any loss for those transactions.
posthog.capture('Accordion Clicked', { title: "Are there any processing fees for Instant Settlements?" })}>
Yes, a nominal fee is applied for processing instant settlements.
posthog.capture('Accordion Clicked', { title: "Is there any limit on Instant Settlements?" })}>
Yes, We have introduced limits on Instant Settlements to streamline the settlement process and meet your daily needs. With limits, you can:
* Settle a specified amount up to the assigned limit until the next working day.
* Benefit from faster and higher success rates throughout the working day.
For any queries, fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)
posthog.capture('Accordion Clicked', { title: " How do I enable instant settlements?" })}>
To activate instant settlements (IS) for your account, please follow the steps below:
* Your account already comes with a ₹50,000/- settlement limit auto-activated for instant settlements.
* If you want to increase this limit, you can request it by [clicking here](https://merchant.cashfree.com/merchants/pg/settlements/standard). This will take you to the Merchant Dashboard, where you can request activation of instant settlements for your account.
* Once the request is submitted, your account will be reviewed and, if eligible, instant settlements will be enabled for you.
If you have any further queries, please reach out to us through the 24/7 [Chatbot](https://merchant.cashfree.com/common/settings?open=chat) on the Merchant Dashboard.
# Settlements
Source: https://www.cashfree.com/docs/help/payments/settlements/settlements
Cashfree Settlements
posthog.capture('Accordion Clicked', { title: "What are settlements?" })}>
Settlements refer to the process of transferring funds to your (merchant) bank account after aggregating the transaction amount and deducting our applicable charges and adjustments (Refunds, Chargebacks, etc).[Read more](https://www.cashfree.com/docs/payments/manage/settlements#settlements) about this
posthog.capture('Accordion Clicked', { title: " What are the different types of settlements?" })}>
The different types of settlements are as follows:
1. **Standard settlements (Default)**: Standard settlements are processed on a T+1 or T+2 basis, depending on your configured settlement cycle:
* T+1: The amount is settled on the next business day after the transaction.
* T+2: The amount is settled two business days after the transaction.
Business days exclude weekends and bank holidays. If the scheduled settlement day falls on a non-working day, the settlement will occur on the next working day.
For example:
* If a transaction occurs on Friday, June 3:
* For T+1 settlement, funds will be settled on Monday, June 6, as Saturday and Sunday are non-working days.
* For T+2 settlement, funds will be settled on Tuesday, June 7.
2. **Instant settlements**: Instant Settlements enable you to access your funds within 15 minutes, significantly faster than the standard T+2 settlement cycle.
3. **On-demand settlements**: On-demand settlements allow instant fund transfers to your bank 24x7, including holidays, for a small fee. Activation is required, as the default cycle is T+2 days.
posthog.capture('Accordion Clicked', { title: "How do I check settlements in my bank account?" })}>
Each settlement includes a Unique Transaction Reference (UTR) provided by our banking partners. You can view this number in the settlement section by clicking on a specific settlement ID. Additionally, Settlement Reports can be downloaded from the Reports section to access the UTR, which serves as a unique reference across banks for tracking specific settlements in your bank account.
posthog.capture('Accordion Clicked', { title: "Which account receives the settlement amount, and how can I view it?" })}>
Settlements are credited to the bank account you add when you set up your merchant account. Settlements include the total transaction value minus any applicable charges and adjustments.
To view or manage your settlement bank account, go to **[Payment Gateway Dashboard](https://merchant.cashfree.com/merchants/pg/settings/bank-accounts?env=prod) > Settings > Bank Accounts** in your .
posthog.capture('Accordion Clicked', { title: "My Settlement isn't credited yet, what do I do?" })}>
If your settlement is scheduled for today, please wait until the end of the day (EOD).
In the rare case of a delay from the bank’s side (such as due to network issues or public holidays), we’ll keep you informed and share updates as soon as possible.
posthog.capture('Accordion Clicked', { title: "If my settlement failed previously, can it be attempted again?" })}>
If your settlement fails, it will automatically be reattempted during your next settlement cycle.
The settlement will reinitiate only if you are an active transacting merchant, which means you must have at least one successful transaction during that cycle.
posthog.capture('Accordion Clicked', { title: "The status of my settlement shows as failed on the Dashboard. What do I do?" })}>
Based on the settlement’s failure reason, take the corrective actions and this will get settled in the next settlement cycle.
posthog.capture('Accordion Clicked', { title: "How does on-demand settlement work, and what are the steps to activate it?" })}>
With on-demand settlements, you can request settlements to your bank account on any day and at any time 24x7, including holidays.
You can specify the amount you want to withdraw as per your requirement. A small fee is applicable to process these settlements. On-demand settlements enable you to receive the unsettled amount to your bank account instantly 24x7 including holidays.
By default, the settlement cycle is t+2\* days, where 't' is the day of the transaction. To use on-demand settlements, the feature must be enabled.
On-Demand Settlement Flow
### Activate on-demand settlements
To enable instant settlement from the Cashfree Payments dashboard:
1. Go to the Payment Gateway Dashboard.
2. Navigate to the Settlements section.
3.Look for the On-Demand Settlements option.
If you're eligible, you'll see options to configure On-Demand settlements.
After activation, you can request settlements instantly 24x7 including holidays.
posthog.capture('Accordion Clicked', { title: "How to initiate On-Demand Settlements?" })}>
1. Go to Payment Gateway Dashboard > Settlements > On-Demand.
2. In the On-Demand settlement screen, click Request Activation. The feature activation request will be sent to your Cashfree Payments account manager, and they will enable it for you. You will receive an email after the feature has been activated.
After activation, you can request settlements instantly 24x7 including holidays.
### Initiate on-demand settlement
To initiate an on-demand settlement, you must first get the feature activated. After activation, you can request settlements instantly 24x7 including holidays.
To initiate on-demand settlement,
1. Go to Payment Gateway Dashboard > Settlements > On-Demand > click Settle Now.
2. In the On-Demand Settlement screen, specify the amount you want to withdraw and click Confirm. You will see the amount you are allowed to withdraw and the additional charges applicable is also shown.
Settlement Amount
You will see a success screen as shown below:
Settlement Success
You will see all the settlements received in the Settlements > On-Demand screen. You can click the individual settlements to know more details.
Settlement cycle is subject to bank approval and can vary based on transaction type, business category/model, risk parameters and other factors.
posthog.capture('Accordion Clicked', { title: "Is there a bank holidays list I can refer to for settlement purpose?" })}>
At Cashfree, we follow the RBI's bank holiday list for Mumbai. You can refer to the list [here](https://www.rbi.org.in/Scripts/HolidayMatrixDisplay.aspx). There can be other holidays that banks may observe which may vary bank to bank and state to state. We send regular updates related to settlements, to receive the emails, you can get your email ID for settlement notifications using your Cashfree Dashboard.
posthog.capture('Accordion Clicked', { title: " How are settlements processed?" })}>
Cashfree offers you the fastest settlement cycle. By default the settlement cycle will be T+2\* days, which means a payment captured on Monday, will be credited to your account on Wednesday i.e three working days.
The settlements aren't processed on banking holidays. You can refer to the RBI's bank holiday list [here](https://www.rbi.org.in/Scripts/HolidayMatrixDisplay.aspx).
posthog.capture('Accordion Clicked', { title: "What is an instant settlement?" })}>
Cashfree’s instant settlements enable businesses to receive funds almost instantly, with cycles starting from 15 minutes, reducing the standard T+1 or T+2 settlement periods. Eligibility requires meeting specific criteria. For more information, fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
Instant settlement is an advanced payment gateway feature offered by Cashfree that lets you access your funds within 15 minutes of payment capture from the customer. This will help you to respond faster to new business opportunities, and get complete control over your working capital.
posthog.capture('Accordion Clicked', { title: "How instant settlements will help you grow your businesses?" })}>
* Manage your working capital better: With instant access to your funds, you can plan your business expenditure better and drive your business towards growth. This can also help avoid the dependency on costly short-term loans to meet business needs.
- Make fool-proof projections: You can now plan your short-term business goals better without the need to assume the revenue you are yet to receive. You can take calculated risks based on your liquidity and not shoot in the dark.
- Handle refunds and chargebacks better: The uncertainty around the usual settlement cycles often affect transactions where the customer has requested for a refund or a chargeback immediately. With instant settlements, you get instant access to those funds and in case of refunds or chargebacks, you can happily reverse the payments instantly, without the need to incur any loss for those transactions.
posthog.capture('Accordion Clicked', { title: "Are there any processing fees for instant settlements?" })}>
Yes, a nominal fee is applied for processing instant settlements.
posthog.capture('Accordion Clicked', { title: "Is there any limit on instant settlements?" })}>
Yes, we've introduced limits on instant settlements to streamline the settlement process and meet your daily needs. With limits, you can:
* Settle a specified amount up to the assigned limit until the next working day.
* Benefit from faster and higher success rates throughout the working day.
For any queries, fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)
posthog.capture('Accordion Clicked', { title: " How do I enable instant settlements?" })}>
To activate instant settlements (IS) for your account, please follow the steps below:
* Your account already comes with a ₹50,000/- settlement limit auto-activated for instant settlements.
* If you want to increase this limit, you can request it by [clicking here](https://merchant.cashfree.com/merchants/pg/settlements/standard). This will take you to the Merchant Dashboard, where you can request activation of instant settlements for your account.
* Once the request is submitted, your account will be reviewed and, if eligible, instant settlements will be enabled for you.
If you have any further queries, please reach out to us through the 24/7 [Chatbot](https://merchant.cashfree.com/common/settings?open=chat) on the Merchant Dashboard.
posthog.capture('Accordion Clicked', { title: "What are the eligibility criteria and activation requirements for instant settlements?" })}>
To be eligible for instant settlements, the following conditions must be met:
* Your merchant account must be fully onboarded and KYC-verified (business details, bank account, etc).
* Your transaction history, business category, risk profile and bank approval must satisfy the criteria for instant settlements.
* The feature is subject to the account being configured and the merchant being deemed eligible; once your request is submitted, it will be reviewed and enabled where applicable.
Once enabled, you'll see the instant settlement limits and usage in **Merchant Dashboard → Payment Gateway → Settlements → Online**.
After activation or limit-increase, you will be able to use instant settlements (funds credited within \~15 minutes) instead of the standard T+1/T+2 settlement cycle.
posthog.capture('Accordion Clicked', { title: "How do I check unsettled amount?" })}>
You can check the unsettled amount from the **Summary and Settlement** sections of the Merchant Dashboard.
1. Log in to your account on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Navigate to the **Summary** section on the Payment Gateway module. This section displays:
* The total transaction amount for the day.
* The amount to be settled (unsettled amount).
3. For a detailed view:
1. Navigate to the **Settlement** section.
2. Select the Standard option.
The unsettled amount will be displayed on the screen.
# Transaction Reports
Source: https://www.cashfree.com/docs/help/payments/transaction-reports/transaction-reports
posthog.capture('Accordion Clicked', { title: "What are the different transaction status in Cashfree?" })}>
When customers initiate a payment, there are various states that the transaction may go through before reaching your account. After the customer initiates a payment, the transaction can go to either of the following:
* **SUCCESS**
* **FAILURE**
* **VOID**
* **INCOMPLETE**
* **PENDING**
* **FLAGGED**
* **CANCELLED**
* **USER\_DROPPED**
Click [here](https://www.cashfree.com/docs/payments/online/resources/payment-lifecycle) to know more about each of these states.
posthog.capture('Accordion Clicked', { title: "How do I track my transactions?" })}>
As soon as you log in to your Cashfree account, the Summary section in the payment gateway dashboard will give you instant context as to what is the amount of transaction that has happened on that particular day, and the settlement amount that you’re yet to receive. Besides this, Cashfree also provides a wide range of reports to analyze your business finances. The different reports that Cashfree provides you are,
* Transactions Report
* Settlement Reconciliation Report
* Settlement Summary
* Refunds Report
* Ledger Report
* Monthly Invoices
posthog.capture('Accordion Clicked', { title: "Can I track the amount of daily transactions in Cashfree?" })}>
Yes. With Cashfree Payments, you can receive specific reports such as **Transaction reports**, **Settlements**, and **Adjustment reports** directly into your own SFTP servers or Cashfree Payments' SFTP servers at a set frequency every day.
If you'd like Cashfree Payments to push out the reports to your own SFTP servers, please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
posthog.capture('Accordion Clicked', { title: "Can Cashfree Payments send reports to my own SFTP servers?" })}>
Yes. With Cashfree Payments, you can receive specific reports such as **Transaction reports**, **Settlements**, and **Adjustment reports** directly into your own SFTP servers or Cashfree Payments' SFTP servers at a set frequency every day.
If you'd like Cashfree Payments to push out the reports to your own SFTP servers, please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
# General FAQs
Source: https://www.cashfree.com/docs/help/payments/transactions/generalfaqs
posthog.capture('Accordion Clicked', { title: "Is Cashfree PCI DSS compliant?" })}>
The **Payment Card Industry Data Security Standard (PCI DSS)** is an information security standard for organisations that handle branded credit cards from major card schemes.
The PCI Standard is mandated by the card brands and administered by the **Payment Card Industry Security Standards Council**. The standard was created to increase controls around cardholder data to reduce credit card fraud.
**Cashfree** is PCI DSS compliant. The certificate can be accessed [here](https://cashfreelogo.cashfree.com/website/pdf/Cashfree-PCI-DSS-COC.pdf).
While PCI DSS compliance is a pre-requisite for payment acceptance, we have gone a step further and incorporated a very robust **Risk Management System** developed with help from **PayPal**.
posthog.capture('Accordion Clicked', { title: "What are the different payment methods supported by Cashfree\'s Payment Gateway?" })}>
**Cashfree Payment Gateway** supports multiple payment methods, giving greater flexibility to your customers to complete payments using the payment method of their choice.
**Supported Payment Methods**
* Credit/Debit Card/Prepaid
* UPI
* Netbanking
* Wallets
* PayPal
* EMI
* Pay Later
**Customise Payment Methods**
With Cashfree Payment Gateway, you can choose to display only the payment methods relevant to your business.\
Fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) to add or remove any payment methods.\
[Click here](/payments/global-collections/collection-accounts#supported-currencies) to see all the currencies supported.
**Payment Response**
You will receive responses for every payment made by your customers. These details can be viewed in the **dashboard** against each transaction.\
[Click here](https://www.cashfree.com/docs/payments/manage/payment-methods#learn-about-payment-methods) to view all possible payment response statuses.
**Payment Modes**
Below is a detailed list of all supported payment modes and their respective codes:
| Code | Description |
| ----------------- | ------------------- |
| DEBIT\_CARD | Debit Card |
| CREDIT\_CARD | Credit Card |
| PREPAID\_CARD | Prepaid Card |
| CREDIT\_CARD\_EMI | Credit Card EMI |
| NET\_BANKING | Internet Banking |
| UPI | UPI |
| PayPal | PayPal |
| PhonePe | PhonePe |
| Paytm | Paytm |
| AmazonPay | Amazon Pay |
| AIRTEL\_MONEY | Airtel Money Wallet |
| FreeCharge | Freecharge Wallet |
| MobiKwik | MobiKwik Wallet |
| OLA | Ola Wallet |
| JioMoney | JioMoney Wallet |
| ZestMoney | ZestMoney |
| Instacred | Instacred |
| LazyPay | LazyPay |
| OlaPostpaid | Ola Postpaid |
posthog.capture('Accordion Clicked', { title: "What are the different payment response statuses for the payment?" })}>
There are various states that the payment goes through. The various states help you understand the status of the payment made by your customers.
* **SUCCESS**
* **FAILED**
* **PENDING**
* **CANCELLED**
* **FLAGGED**
* **INCOMPLETE**
* **VOID**
* **USER\_DROPPED**
### Payment Response Status
Cashfree send responses against the payments made by your customers. The response against these payments made could contain one of the following statuses.
| Case | Event Name | Event Status |
| :--------------------------------------------------------------------------------------------------------------------- | :---------------- | :------------ |
| Successful Payment | PAYMENT\_RESPONSE | SUCCESS |
| Payment Failed | PAYMENT\_RESPONSE | FAILED |
| Pending Payment | PAYMENT\_RESPONSE | PENDING |
| Payment cancelled by the user | PAYMENT\_RESPONSE | CANCELLED |
| Payment successful but kept on hold by risk system | PAYMENT\_RESPONSE | FLAGGED |
| Transactions are marked as Incomplete, which later changes to other states based on the responses from other entities. | PAYMENT\_RESPONSE | INCOMPLETE |
| When we do not want to capture the transaction amount (pre-authorized transactions). | PAYMENT\_RESPONSE | VOID |
| When customers drop out of the payment flow without completing the transaction. | PAYMENT\_RESPONSE | USER\_DROPPED |
| Invalid inputs | VALIDATION\_ERROR | |
posthog.capture('Accordion Clicked', { title: "What is the checkout experience offered by Cashfree\'s PG like?" })}>
A seamless checkout is key to customer trust. Redirects and pop-ups? They create confusion and hurt conversions. Big brands offer smooth payments, but not everyone has their resources.\
That’s where Cashfree comes in! We provide easy integrations for a fast, hassle-free checkout—built for businesses of all sizes. Cashfree offers a seamless checkout experience with:
No Redirects – Customer experiences checkout flow on your website without navigating to any third-party page
Custom UI – You own the look and feel of the checkout flow or you can also use our ready-made beautiful UI components
One-Click Checkout – Enable fast, hassle-free payments with a single click.
[Sign-Up](https://merchant.cashfree.com/auth/login) to see our payment gateway in action!
posthog.capture('Accordion Clicked', { title: "What is a Chargeback?" })}>
Businesses accepting payments via cards may face a situation where a **chargeback request** is raised for a refund to the customer.
**What is a chargeback?**
A chargeback is a request for the return of funds to a consumer, initiated by the consumer's card-issuing bank.
It serves as a form of consumer protection against fraudulent activities committed by both merchants and individuals.
It is best to avoid chargebacks as banks and card networks can label your business as high-risk. A high number of chargebacks may lead to banks holding remittances or banning your business's online payment services.
**Key Parties Involved in a Chargeback**
* **Cardholder:** The owner of the card involved in the transaction.
* **Merchant:** The party who sold the goods or services being disputed.
* **Issuer:** The bank that issued the card to the cardholder.
* **Acquirer:** The bank tasked with acquiring payment on the merchant’s behalf.
* **Card Association/Scheme:** The card brands (e.g., Visa, Mastercard) overseeing the process.
* **Payment Gateway:** The payment gateway facilitating the payment.
**Reasons for a Chargeback Request**
A chargeback request may be raised for various reasons, such as:
* Service or product not received.
* The product doesn’t match the description or is damaged.
**How Does the Chargeback Process Work?**
1. The **cardholder** (Ms. X) disputes a transaction by contacting the **card issuer** (e.g., SBI).
* The issuer contacts the **acquirer** (e.g., HDFC Bank) via the same network used for the transaction.
* The acquirer reaches out to the **payment gateway** (e.g., Cashfree), which then contacts the **merchant** (e.g., merchant.com) for details.
2. The merchant is given a **turnaround time** to respond.
* If no response is provided, the chargeback will be ruled in favor of the cardholder.
3. After submitting proof, banks take **21 to 45 days** (representation time) to conclude.
4. The cardholder has **90-120 days** to raise a chargeback request.
5. If a chargeback occurs, the disputed amount will be **blocked** from the merchant's unsettled funds and will be released or refunded based on the outcome.
**Chargeback Scenarios**
**Scenario 1: The merchant decides to respond**
The merchant must provide evidence related to the transaction, such as:
* Email conversations
* Invoices
This proof is passed to the **issuer (e.g., SBI)** for review.
1. **If the issuer accepts the proof:**
* The chargeback request is declined, but the cardholder can still raise a **Second Presentment, Second Chargeback (Mastercard)** or **Pre-Arbitration (Visa)**.
2. **If the issuer rejects the proof:**
* The chargeback is ruled valid, and funds are reversed to the cardholder’s account.
**Scenario 2: The merchant decides not to respond**
* The chargeback is automatically ruled in favor of the cardholder, and the amount is reversed.
**Second Presentment, Second Chargeback, or Pre-Arbitration**
If the initial chargeback is won by the merchant, the customer can raise the dispute again.
* The **merchant must respond** with all possible evidence.
* **If the merchant does not respond:** The chargeback will favor the cardholder, and funds will be reversed.
**Documents Required to Dispute a Chargeback**
Merchants should keep the following documents ready to tackle any chargeback:
* **Proof of delivery:** Tracking numbers, shipping receipts, etc.
Prepare these documents from day one to efficiently handle potential chargebacks.
**Invoice copy**: This should include your company name, price, and description of the product, date, customer’s name and address, date.
**Order confirmation email**: This email provides customers with post-purchase reassurance. It should mandatorily include confirmation of your customer’s request (booking, registration, subscription and order) and the order summary.
**Tracking details**: Shipment tracking details provided by the courier delivery company (Not applicable for all).
Finally, we are near the end of the chargeback process. The **issuer reviews the chargeback claim** and the merchant's evidence. Each card network requires specific information to prove or disprove a dispute. This information is typically listed in the network’s rules and regulations.
Let’s say the merchant wins a chargeback. The cardholder could still dispute the outcome. This takes on various names depending on the card network. For example, Visa calls this **Pre-Arbitration**, while Mastercard calls it a **Second Chargeback**. However, the process is essentially the same, as detailed below:
**Level 1/Phase 1: Chargeback**\
The initial phase where the cardholder disputes the transaction.
**Level 2/Phase 2: Second Presentment, Second Chargeback, or Pre-Arbitration**\
This gives the acquirer and the issuer a second chance to resolve the dispute. An issuer may issue pre-arbitration for several reasons, including:
* A reason code change.
* The cardholder offers new information.
* The issuer believes the acquirer’s evidence does not disprove the dispute.
* Terms and Conditions or Return Policies were not properly disclosed during the transaction.
**Level 3/Phase 3: Arbitration**\
Explicit time limits exist for issuers and acquirers to file for and respond to arbitration chargebacks. For example, Mastercard gives issuers and acquirers **45 days** to file. However, documents must be submitted well in advance to allow for thorough review.
For more information on arbitration rates, refer to the [link](https://chargebacks911.com/arbitration-chargeback/).
There are **151 reason codes** used to categorize chargebacks across Visa, Mastercard, and American Express.
Reason codes can be grouped into five main categories:
* **Fraud/No Authorization**
* **Cancel Recurring Billing**
* **Products/Services**
* **Liability Shift**
* **Others**
Fraud/No Authorization chargebacks account for the largest percentage of disputes, followed by Cancel Recurring Billing and Products/Services disputes. Liability Shift and Other chargebacks represent a smaller percentage.
For a detailed breakdown, refer to the [link](https://chargeback.com/5-chargeback-reason-code-categories/).
**As a business, how can I avoid chargebacks?**
* Cardholders often have an advantage as banks and credit card companies prioritize consumer protection.
* Always maintain proof/evidence to challenge disputes. Store these documents in an easily accessible location, like a desktop folder or Google Drive.
* Respond promptly to disputes and chargebacks. If you miss the stipulated time frame, banks automatically process the chargeback.
* Be prepared with an action plan to handle chargebacks efficiently.
**Questions?**\
We're always happy to help with any questions you might have. Search our documentation, [contact support](https://www.cashfree.com/en/report-issue/), or [connect with our sales team](https://www.cashfree.com/contact-sales/). You can also chat with our team via chat for real-time support.
posthog.capture('Accordion Clicked', { title: "How do I check, if I am eligible for accepting payments from Rupay credit cards on UPI payments?" })}>
Almost all businesses are by default eligible to receive payments via Rupay credit card.
Merchants with MCCs such as mutual fund providers, stock brokers, loan
repayment, etc., are not eligible to accept credit payments.
posthog.capture('Accordion Clicked', { title: "What is Pre Authorization?" })}>
Pre-Authorization lets you block a customer’s funds and capture the payment only after fulfilling the order.
Supported Cards – Works with Mastercard & Visa credit/debit cards.
Flexible Captures – Capture the full or partial amount later.
Void Transactions – Release blocked funds if the order isn’t processed.
Easy Control – Manage captures & voids manually via the [Merchant Dashboard](https://merchant.cashfree.com/merchants).
A smarter way to handle payments with more control!
Interested in the Pre-Authorization feature?
[Contact sales](https://www.cashfree.com/contact-sales/)
posthog.capture('Accordion Clicked', { title: "How to fix Failed to Verify Credentials?" })}>
If you are getting this error, it usually means you are using Production credentials on the Cashfree Test server or Test credentials on the Production server. To fix this, do the following:
* Go to the page where you get API credentials: [https://merchant.cashfree.com/merchant/pg#api-key](https://merchant.cashfree.com/merchant/pg#api-key)
* Ensure that you get the appropriate set of credentials (Test or Production). Also, verify that there are no typos in the `appId`/`secretKey`.
* Ensure that in your integration type, you are selecting the correct server (Test or Production) of Cashfree.
posthog.capture('Accordion Clicked', { title: "What are the different ways I can set up the payment gateway for my business?" })}>
Cashfree lets you integrate your [website](/flowwise/integrating-with-cashfree-payments#web-integrations) or [mobile app](/payments/online/mobile/android) with our payment gateway to accept payments. Over and above this, we also offer [plugins](https://www.cashfree.com/docs/payment-gateway/pre-integrated-plugins) to major e-commerce sites like [Shopify](https://apps.shopify.com/cashfree-payments), [Magento](https://marketplace.magento.com/cashfree-magento2-payment.html), [WooCommerce](https://wordpress.org/plugins/cashfree/), [OpenCart](https://www.opencart.com/index.php?route=marketplace/extension/info\&extension_id=37574), [PrestaShop](https://addons.prestashop.com/en/payment-card-wallet/50547-cashfree.html), and [WHMCS](https://marketplace.whmcs.com/product/5045-cashfree-payment-gateway). [Click here](/payments/online/web/redirect) to know more.
posthog.capture('Accordion Clicked', { title: "What are the different web integrations possible with Cashfree?" })}>
There are three types of web integrations possible with Cashfree:
* [Checkout Forms](https://www.cashfree.com/docs/payment-gateway/checkout-forms)
* [Seamless Basic](https://www.cashfree.com/docs/payment-gateway/seamless-basic)
* [Seamless Pro](https://www.cashfree.com/docs/payment-gateway/seamless-pro)
You can instantly set up any of these based on your requirements.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my Shopify website?" })}>
Yes, we provide a predefined plugin for [Shopify](https://www.cashfree.com/docs/payments/shopify/payments) that helps you set up the Cashfree payment gateway with your Shopify account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my Magento website?" })}>
Yes, we provide a predefined plugin for [Magento](https://www.cashfree.com/docs/plugins/magento) that helps you set up the Cashfree payment gateway with your Magento account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my Woo-Commerce website?" })}>
Yes, we provide a predefined plugin for [WooCommerce](https://www.cashfree.com/docs/payments/plugins/woocommerce#woocommerce-payment-plugin) that helps you set up the Cashfree payment gateway with your WooCommerce account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my OpenCart website?" })}>
Yes, we provide a predefined plugin for [OpenCart](https://www.cashfree.com/docs/plugins/opencart) that helps you set up the Cashfree payment gateway with your OpenCart account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my PrestaShop website?" })}>
Yes, we do provide a predefined plugin for [PrestaShop](https://www.cashfree.com/docs/plugins/prestashop) that helps you set up the Cashfree payment gateway with your PrestaShop account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I integrate Cashfree payment gateway to my WHMCS website?" })}>
Yes, we do provide a predefined plugin for [WHMCS](https://www.cashfree.com/docs/plugins/whmcs) that helps you set up the Cashfree payment gateway with your WHMCS account in no time, and with absolutely no code.
posthog.capture('Accordion Clicked', { title: "Can I receive payments from my customers without integrating Cashfree to my website?" })}>
You can use the [Cashfree Payment Gateway Dashboard](https://www.cashfree.com) to create orders and accept payments using a **payment link**. These links can be sent to your customers via email or SMS, without the need to integrate Cashfree into your website.
posthog.capture('Accordion Clicked', { title: "What documents to be submitted as a proof of delivery?" })}>
**Invoice copy:** Every invoice should include your company name, price, and description of the product, date, customer’s name, and address, contact information (Email and/or phone), and transaction date.
**Order confirmation email:** Confirmation emails provide customers with the feeling of post-purchase reassurance. It should mandatorily include confirmation of your customer request (booking, registration, subscription, and order) and the order summary.
**Tracking details:** Shipment tracking details provided by the courier delivery company. (Please note that this may not be applicable for all).
The above mentioned supporting documents are the general proofs that we request. Depending upon the nature of business/line of business (LOB), we may ask for other details such as:
* **Customer signed Proof of Delivery:** Customer signed copy of proof of delivery.
* **Confirmation email from a customer:** An email from the customer confirming the delivery of the product or the service provided.
* **Customer signed copy of invoice:** A signed copy of the invoice from a customer.
**Questions?**
We're always happy to help you with any questions that you might have. You can search our FAQs, documentation, contact our support team, connect with our sales team from [here](https://www.cashfree.com), or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1). You could also chat with our team via Intercom for real-time support.
posthog.capture('Accordion Clicked', { title: "I run an NGO. How can I use Cashfree to accept donations?" })}>
Cashfree provides you with the flexibility to create **PayMe links**, a specially crafted payment link that your customers can use to pay any amount of their choice to your account.
posthog.capture('Accordion Clicked', { title: "I want to accept international payments. Can I use Cashfree to accept payments in other currencies?" })}>
Yes, Cashfree supports a wide range of international payment options via credit cards and also PayPal.
posthog.capture('Accordion Clicked', { title: "I am an existing PayPal user. How do I connect my Paypal account with Cashfree?" })}>
Yes, if you already have an account with PayPal, you need to authorize Cashfree to collect payments. [Click here](https://www.cashfree.com) to know more.
posthog.capture('Accordion Clicked', { title: "When will the payment gateway charges be deducted for my transactions?" })}>
For every transaction processed through Cashfree Payments, either of the following charges applies:
1. Upfront TDR–A fixed charge collected at a predefined frequency.
OR
2. Non-Upfront TDR–A charge deducted as a percentage (TDR%) or a flat fee from the transaction amount, with the remaining balance settled to your bank account.
For every transaction that your customers make through Cashfree, TDR will be deducted from the total amount and the remaining amount will be settled to your bank account.
posthog.capture('Accordion Clicked', { title: "How long does it take to process refunds?" })}>
You can initiate a refund for a transaction from the payment gateway dashboard by going to **PG Dashboard** > **Refunds** > **NEW REFUND** and providing the corresponding transaction ID or order iD. Once the refund is initiated, it will take 5-7 business days for the amount to be credited to your account.
posthog.capture('Accordion Clicked', { title: "What documents to be submitted as a proof of delivery?" })}>
**Invoice copy:** Every invoice should include your company name, price, and description of the product, date, customer’s name, and address, contact information (Email and/or phone), and transaction date.
**Order confirmation email:** Confirmation emails provide customers with the feeling of post-purchase reassurance. It should mandatorily include confirmation of your customer request (booking, registration, subscription, and order) and the order summary.
**Tracking details:** Shipment tracking details provided by the courier delivery company. (Please note that this may not be applicable for all).
The above-mentioned supporting documents are the general proofs that we request. Depending upon the nature of business/line of business (LOB), we may ask for other details such as:
* **Customer signed Proof of Delivery:** Customer signed copy of proof of delivery.
* **Confirmation email from a customer:** An email from the customer confirming the delivery of the product or the service provided.
* **Customer signed copy of invoice:** A signed copy of the invoice from a customer.
**Questions?**\
We're always happy to help you with any questions that you might have. You can search our FAQs, documentation, contact our support team, connect with our sales team from [here](https://www.cashfree.com), or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1). You could also chat with our team via Intercom for real-time support.
posthog.capture('Accordion Clicked', { title: "What are terms and conditions for activating Payment Gateway" })}>
Before we activate Cashfree Payment Gateway on a website or mobile app, we need a few prerequisites in place.
1. Your website should be live in the public domain.
2. Your website should have:
3. \[Contact Us] section showing a valid `` and a ``
4. \[Privacy Policy] section
5. \[Refund Policy] section
6. \[Terms & Conditions] section.
7. Dealing in banned items.
At Cashfree, we do not support businesses that deal in certain prohibited items. If your business deals in any such items, Cashfree Payment Gateway Account will not be activated in such a scenario.
* Drop-shipped merchandise.
* Adult goods and services which includes pornography and other sexually suggestive materials (including literature, imagery, and other media); escort or prostitution services.
* Alcohol which includes alcoholic beverages such as beer, liquor, wine, or champagne.
* Body parts which includes organs or other body parts.
* Bulk marketing tools which includes email lists, software, or other products enabling unsolicited email messages (spam).
* Cable descramblers and black boxes which includes devices intended to obtain cable and satellite signals for free.
* Child pornography which includes pornographic materials involving minors.
* Copyright unlocking devices which includes Mod chips or other devices designed to circumvent copyright protection.
* Copyrighted media which includes unauthorized copies of books, music, movies, and other licensed or protected materials.
* Copyrighted software which includes unauthorized copies of software, video games, and other licensed or protected materials, including OEM or bundled software.
* Counterfeit and unauthorized goods which includes replicas or imitations of designer goods; items without a celebrity endorsement that would normally require such an association, fake autographs, counterfeit stamps, and other potentially unauthorized goods.
* Drugs and drug paraphernalia which includes illegal drugs and drug accessories, including herbal drugs like salvia and magic mushrooms.
* Drug test circumvention aids which include drug cleansing shakes, urine test additives, and related items.
* Endangered species which include plants, animals, or other organisms (including product derivatives) in danger of extinction.
* Gaming/gambling which includes lottery tickets, sports bets, memberships/enrolment in online gambling sites, and related content.
* Government IDs or documents which includes fake IDs, passports, diplomas, and noble titles.
* Hacking and cracking materials which includes manuals, how-to guides, information, or equipment enabling illegal access to software, servers, websites, or other protected property.
* Illegal goods which includes materials, products, or information promoting illegal goods or enabling illegal acts.
* Miracle cures which includes unsubstantiated cures, remedies, or other items marketed as quick health fixes.
* Offensive goods which includes literature, products or other materials that:\
a) Defame or slander any person or groups of people based on race, ethnicity, national origin, religion, sex, or other factors\
b) Encourage or incite violent acts\
c) Promote intolerance or hatred.
* Offensive goods, a crime which includes crime scene photos or items, such as personal belongings, associated with criminals.
* Prescription drugs or herbal drugs or any kind of online pharmacies which includes drugs or other products requiring a prescription by a licensed medical practitioner.
* Pyrotechnic devices and hazardous materials which include fireworks and related goods; toxic, flammable, and radioactive materials and substances.
* Regulated goods which include airbags; batteries containing mercury; Freon or similar substances/refrigerants, chemical/industrial solvents, government uniforms, car titles or logos, license plates, police badges, and law enforcement equipment, lock-picking devices, pesticides; postage meters, recalled items, slot machines, surveillance equipment; goods regulated by government or other agency specifications.
* Securities, which include stocks, bonds, or related financial products.
* Tobacco and cigarettes which includes cigarettes, cigars, chewing tobacco, and related products.
* Traffic devices which include radar detectors/jammers, license plate covers, traffic signal changers, and related products.
* Weapons include firearms, ammunition, knives, brass knuckles, gun parts, and other armaments.
* Wholesale currency which includes discounted currencies or currency exchanges.
* Live animals or hides/skins/teeth, nails, and other parts, etc. of animals.
* Multi-Level Marketing collection fees.
* Matrix sites or sites using a matrix scheme approach.
* Work-at-home information.
* Any product or service which is not in compliance with all applicable laws and regulations whether federal, state, local, or international including the laws of India.
* The Merchant shall not sell, purchase, provide or exchange a cardholder’s name or MasterCard/Visa account number information in any form obtained by reason of a MasterCard/Visa Card transaction to any third party other than its MasterCard/Visa acquiring Member-Citrus Pay, or pursuant to a government/statutory or competent body’s request.
* Pyrotechnic devices, combustibles, corrosives, and hazardous materials which includes explosives, fireworks and related goods; toxic, flammable, and radioactive materials and substances.
* Regulated goods which include airbags; batteries containing mercury; Freon or similar substances/refrigerants; chemical/industrial solvents; government uniforms; car titles; license plates; police badges and law enforcement equipment; lock-picking devices; pesticides; postage meters; recalled items; slot machines; surveillance equipment; goods regulated by government or other agency specifications.
In case the Cashfree Payment Gateway has been activated and later it is found that the business or the website does not comply with the terms and conditions, the account shall be deactivated at Cashfree's discretion.
posthog.capture('Accordion Clicked', { title: "What are High Risk Transactions & High Risk Merchants" })}>
**What are high-risk transactions?**
A particular transaction that may have the potential to attract a customer dispute or chargeback is identified by Cashfree as well as banking partners and marked as a high-risk transaction. The payment to the merchant against such a transaction is put on hold until the issue is resolved.
**Who are high-risk merchants?**\
As a payment gateway, Cashfree generally settles the collected amount within T+1\* or T+2\* days. However, some merchants may not qualify for the traditional payment processing agreements due to the inherent risk based on the nature of the business.
In addition to the line of business, there may be instances where Cashfree receives frequent escalations from consumers or banks about the genuineness of transactions or financial credibility, based on risk analysis. In such cases, Cashfree may mark the business as a high-risk merchant and temporarily suspend the traditional payment settlement process.
**High-risk merchants at the time of onboarding**\
If the nature of the business is seen as risky, to protect the interest of the paying consumer, Cashfree monitors the merchant for a certain period after onboarding. During this period, all settlements by the high-risk merchant shall be subject to the submission of Proof of Delivery. Once the proofs are submitted, the settlements are processed. The time frame of monitoring may vary from merchant to merchant and scenario to scenario, and will be decided by Cashfree at the time of onboarding.
**What are the documents required to prove delivery?**\
As proof of delivery, you can share ANY ONE of the following supporting documents:
1. **Invoice Copy**: Every invoice should include your company name, price, and description of the product, date, customer’s name and address, and transaction date.
2. **Order Confirmation Email**: Confirmation emails provide customers with post-purchase reassurance. It should mandatorily include confirmation of your customer request (booking, registration, subscription, and order) and the order summary.
3. **Tracking Details**: Shipment tracking details provided by the courier delivery company. (Please note that this may not be applicable for all).
The above-mentioned supporting documents are general proofs we request. Depending on your business/line of business (LOB), we may ask for other details such as:
* **Customer Signed Proof of Delivery**: A customer-signed copy of proof of delivery.
* **Confirmation Email from a Customer**: An email from the customer confirming the delivery of the product or service.
* **Customer-Signed Copy of Invoice**: A signed copy of the invoice from the customer.
**Questions?**\
We're always happy to help you with any questions that you might have. You can search our FAQs, documentation, contact our support team, connect with our sales team from [here](https://www.cashfree.com/contact-sales/), or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1). You could also chat with our team via Intercom for real-time support.
**Note**: Settlement cycle is subject to bank approval and can vary based on transaction type, business category/model, risk parameters, and other factors.
posthog.capture('Accordion Clicked', { title: "What is the checkout experience offered by Cashfree\'s PG like?" })}>
It is quite critical for a payment gateway to offer a **seamless experience** to the customers. Multiple redirects and ugly pop-ups lead to a confusing checkout experience and end up eroding the customer's confidence. A lot of websites do offer a beautiful checkout experience, but this lot is limited to big technology houses with abundant manpower.
We at Cashfree have carefully tried to solve this problem. We offer multiple ways to integrate our payment gateway and render a seamless checkout experience to customers. Two basic aspects of our UI integration are:
* **No Redirects**\
Customer experiences the checkout flow on your website without navigating to any third-party page.
* **Custom UI**\
You own the look and feel of the checkout flow, or you can also use our ready-made beautiful UI components.
[Sign-Up to see our PG in action](https://merchant.cashfree.com/merchants/signup)
posthog.capture('Accordion Clicked', { title: "How does Subscription work?" })}>
Cashfree enables businesses to automate recurring payment collection from customers. Our system streamlines the payment process while providing flexibility in payment schedules and methods.
Subscriptions help you to accept repeat online payments:
1.Create custom plans for your customers and activate them with ease.
2\. Merchant add customer's payment details and subscribe to a plan.
3\. Customers have the ability to put it on hold/cancel subscription at any time.
[Read more](https://www.cashfree.com/docs/payments/subscription/overview)
[Sign up from here](https://merchant.cashfree.com/auth/login)
posthog.capture('Accordion Clicked', { title: "What is Third-Party Validation Feature for BFSI Sector Businesses?" })}>
**What is Third Party Validation? Why is it important?**
Merchants in securities, broking, and mutual funds operating in the BFSI (Banking, Financial Services, and Insurance) sector are prone to cybercrimes, asset appropriation, identity thefts, money laundering, accounting frauds, etc. To reduce the risk, the Securities and Exchange Board of India (SEBI) has laid out guidelines for these merchants.
As per the SEBI guidelines, all payments to such businesses must be made by their customers exclusively from pre-registered bank accounts. A pre-registered bank account is the one the customer shared during enrollment for schemes offered by businesses in these sectors.
**Introducing Third-Party Validation feature by Cashfree**\
Cashfree now supports Third-Party Validation on Payment Gateway. Using Cashfree’s Third-Party Validation feature, businesses can comply with the SEBI guidelines by ensuring that payments are made only from customers' registered bank accounts.
Some of the primary use cases of Third-Party Validation feature include:
* **BFSI sector**: Brokers and other online businesses can now sign up for Cashfree services and securely transact with customers in real-time.
* **Loan repayments**: Merchants in the loan repayment sector can use Third-Party Validation to prevent discrepancies in payments and dispute cases.
**Features**\
When a customer transacts with the Cashfree Payment Gateway (with the TVP feature enabled), their bank account number or CRN (Customer Relationship Number) is mapped to lock the transaction, ensuring the payment is processed only from their registered bank account.
**Advantages**
* TPV is compliant with SEBI guidelines.
* It serves as a one-stop solution for merchants in the BFSI sector to meet compliance requirements and start transacting securely with their customers.
**Benefits**\
When you enable the TVP feature on your Cashfree Payment Gateway, Cashfree matches the account number provided by the customer during registration against the account used for the transaction. If a non-registered account number is used, Cashfree marks the transaction as FAILED and provides an appropriate failure reason.
To know more about the feature and how it can help your business, contact your Cashfree Account manager. If you are new to Cashfree, please [contact us here](https://merchant.cashfree.com/merchants/signup). We would love to talk to you.
posthog.capture('Accordion Clicked', { title: "What is Rupay Credit Card on UPI payments mean for my business?" })}>
Your customers can now make payments using their Rupay credit cards via UPI apps like BHIM, PhonePe, and Google Pay. This enables seamless, fast, and convenient transactions directly through UPI.
posthog.capture('Accordion Clicked', { title: "What card subtypes are available in the webhook and API responses?" })}>
The available card subtypes are:
* P – Premium
* E – Elite
* C – Corporate
* R – Retail
posthog.capture('Accordion Clicked', { title: "How a customer can make payments via Rupay credit card on UPI Apps?" })}>
Steps to Make a Payment Using a RuPay Credit Card on UPI:
1. Scan the merchant’s UPI QR Code OR Enter the UPI ID using any UPI-enabled app.
2. Enter the payment amount.
3. Select the linked RuPay credit card account as the payment method.
4. Enter the UPI PIN to authorize the transaction.
5. Receive payment confirmation upon successful transaction.
posthog.capture('Accordion Clicked', { title: "What is Exclusive Zero% 3 months EMI Offer | Cashfree + ZestMoney?" })}>
**ZestMoney: Instant Cardless EMI Payment Service**
ZestMoney is one of India’s leading instant cardless EMI payment services that allows users to buy products or avail services and pay the amount later in easy installments.
**Benefits of ZestMoney**
* ZestMoney offers EMI without the need for a credit card, debit card, or credit score, letting customers buy now and pay later in easy installments.
* Online loan approval in less than 10 minutes during checkout.
* Great payment option for high-value transactions.
**Exclusive Offer: No Cost, Interest-Free 3 Months Offer on ZestMoney for Cashfree Merchants**
We are glad to share that merchants using Cashfree Payment Gateway can add ZestMoney as a payment mode on their checkout page and offer their customers the option to opt for a 3-month tenure EMI option at 0% interest using ZestMoney.
**Details of the offer:**
1. The offer is valid only for transactions made through the ZestMoney EMI payment option for a 3-month tenure.
2. Interest will be charged from the customer on no-cost EMI and will be processed back as cashback. Cashback will be credited to the customer’s bank account within 7 working days after each on-time EMI payment.
3. In case of either partial or full cancellation of the order leading to a refund, the refunded amount will be reduced from the outstanding loan amount of the customer with ZestMoney. Any amount deducted before the refund will continue to be under loan amount. If Zero Cost EMI was applicable at the time of order, it will continue to apply to the remaining outstanding amount.
4. Customers can visit [www.zestmoney.in](https://www.zestmoney.in) to sign up for ZestMoney, check the credit limit, or give a missed call on 08047193665. For cashback-related issues, customers can reach out at [help@zestmoney.in](mailto:help@zestmoney.in) or contact +919343422556.
5. ZestMoney reserves the right to use reasonable technological and other methods to prevent abuse of the offer terms. ZestMoney’s decisions to take certain actions, including limiting access to the offer, placing holds, or imposing reserves, may be based on confidential criteria essential for managing risk, ensuring the security of users’ accounts, complying with applicable laws, and protecting the ZestMoney system. ZestMoney is under no obligation to disclose details of its risk management or security procedures.
6. All queries related to discounts or cashback will be resolved within 10-15 working days by the ZestMoney team.
For further details on ZestMoney’s terms and conditions, please visit [ZestMoney Terms and Conditions](https://www.zestmoney.in/terms-and-conditions/).
**How do I avail it?**
ZestMoney’s No Cost, 0% Interest 3 Months EMI offer is available for all Cashfree Payment Gateway users. If you are an existing Cashfree merchant and want to enable ZestMoney as a checkout mode, please contact your Cashfree Account Manager or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1), and we’ll get in touch with you.
If you're not an existing Cashfree merchant, [sign up](https://www.cashfree.com) now to enable ZestMoney and other 120+ payment modes including net banking, debit cards, Paytm, UPI, and others.
ZestMoney as a payment mode is only available on request. It is not enabled by default. Raise a request with your Account Manager to enable this feature.
**P.S.** Reach out to your Cashfree Account Manager to know how you can provide your customers with 6, 9, or 12-month EMI options.
**Other Buy Now Pay Later Options on Cashfree**\
With Cashfree Payment Gateway, you can offer your customers a range of Buy Now Pay Later options, including card and cardless EMI options like ZestMoney. Some of the popular Buy Now Pay Later options supported on Cashfree checkout include ZestMoney, Olamoney, and e-PayLater, among others.
posthog.capture('Accordion Clicked', { title: "What is PayPal Exclusive Offer | PayPal Express Checkout on Cashfree Payment Gateway?" })}>
PayPal is one of the world’s most popular payment modes used by 350+ mn users across 200+ countries worldwide.
Cashfree has integrated directly with PayPal to enable seamless merchant onboarding with PayPal and to allow a faster checkout experience using PayPal Express Checkout integration.
Cashfree Payment Gateway merchants can now add the PayPal Express Checkout button on their website or mobile app.
**Benefits of PayPal Express Checkout**
* Accept payments from international customers in 100 currencies using PayPal.
* Faster customer payment checkout with PayPal Express Checkout button.
* 24/7 transaction monitoring, fraud prevention, and seller protection that help you keep your business PCI compliant.
* Easy integration. Enable PayPal on your Cashfree Checkout in just a few steps \[refer to PayPal API integration steps here]. No separate integration required.
**Exclusive Offer: No Transaction Fee on International Transactions via PayPal for Cashfree Merchants**
**Offer Terms and Conditions:**
1. The offer is valid only for Cashfree merchants in India with a valid and active existing or new PayPal India business account. The merchant must connect their PayPal business account to their Cashfree account during the offer period (1st March 2021 to 31st March 2021).
2. The offer is valid only for the first 1000 transacting Cashfree merchants.
3. The offer is valid only for international transactions made through the PayPal option.
4. Eligible merchants will get a rebate on the PayPal transaction fee on international/cross-border payments up to INR 10,000 (USD 135) against payments received during the offer period.
5. The rebate is only applicable on the PayPal transaction fees. Fixed fee, currency conversion (FX), and taxes charged on the transactions will not be rebated.
6. Partially or fully canceled/refunded transactions will not be eligible for this offer.
7. The applicable rebate amount will be credited to the linked INR Bank account under which the initial transaction was settled by 30th April 2021. In exceptional scenarios, if the rebate is delayed, please write to [channelpartners@paypal.com](mailto:channelpartners@paypal.com).
8. The fee rebate will be non-transferable to other PayPal accounts.
9. PayPal reserves the right to employ reasonable technological methods and take actions, including limiting access to your offer, placing holds, or imposing reserves, based on confidential criteria essential to managing risk and complying with applicable laws.
10. PayPal is under no obligation to disclose the details of its risk management or security procedures to the merchants.
11. In cases of fraudulent or suspicious transactions, PayPal reserves the right to revoke the offer or not award the fee rebate at all.
12. PayPal reserves the right to amend, change, pause, or stop this offer without any notice.
13. This offer is subject to the merchant's general Terms of Use.
14. Indian laws govern these terms and conditions. All disputes are subject to the Dispute Resolution clause of the User Agreement between PayPal and the merchant.
15. All queries related to discounts or cashback will be resolved by the PayPal team.
**How do I integrate PayPal with my Cashfree account and avail the offer?**
PayPal’s exclusive offer is available for all Cashfree Payment Gateway merchants.
* If you are an existing Cashfree Payment Gateway merchant and want to enable PayPal Express Checkout as a checkout mode, follow the \[PayPal API integration steps here]. For any queries related to integration or the offer, contact your Cashfree Account Manager or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1), and we’ll get in touch with you.
* If you’re not an existing Cashfree merchant, [sign up](https://www.cashfree.com) now to enable PayPal and other 120+ payment modes including net banking, debit cards, Paytm, UPI, and start collecting online payments.
**Please note**: PayPal is a payment mode and is only available on request. It is not enabled by default. Raise a request with your Account Manager to enable this feature.
**Other International Payment Options on Cashfree**\
With Cashfree Payment Gateway, you can offer your customers a range of international checkout options, including PayPal and international cards such as Visa, Mastercard, American Express, and Diners Club.
posthog.capture('Accordion Clicked', { title: "Is there any limit to the number of Aadhaar cards that can be verified in a day?" })}>
No, there is no limit to the number of Aadhaar cards that can be verified in a day.
posthog.capture('Accordion Clicked', { title: "How do I check, if I am eligible for accepting payments from Rupay credit cards on UPI payments?" })}>
All most all businesses are by default eligible to receive payments via Rupay credit card.
Except for the merchant MCCs such as mutual fund providers, stock brokers, loan repayment etc, are not eligible to accept credit payments.
posthog.capture('Accordion Clicked', { title: "What is Rupay Credit Card on UPI payments mean for my business?" })}>
Your customers now will be able to make payments from their Rupay credit cards of the issuing banks which are live on via their preferred UPI apps like BHIM, PhonePe and Google Pay.
posthog.capture('Accordion Clicked', { title: "How a customer can make payments via Rupay credit card on UPI Apps?" })}>
**To make the payment with RuPay Credit Card on UPI, a customer must follow these steps:**
1. Scan the merchant UPI QR code.
2. Enter the amount and select the credit account.
3. Select the RuPay credit card account followed by the UPI PIN to authorize the payment.
4. Transaction successful.
posthog.capture('Accordion Clicked', { title: "How to link RuPay Credit Card on UPI apps?" })}>
**To link RuPay Credit Card on UPI App, follow these steps:**
1. Open your preferred UPI app (currently supported on BHIM, PhonePe, and Google Pay).
2. Navigate to the option to **Add Bank Account** or **Add Payment Method**.
3. Select **Credit Card** as the account type.
4. Choose your credit card issuer bank.
5. Select your RuPay Credit Card.
6. Confirm the card details.
7. Set a UPI PIN for the card.
Your RuPay Credit Card is now successfully linked to your UPI app.
posthog.capture('Accordion Clicked', { title: "How can this feature be enabled?" })}>
This is a request-based feature, available only to PCI-DSS-compliant merchants. To enable it, reach out to your account manager or submit a [Support Form](https://merchant.cashfree.com/auth/login).
posthog.capture('Accordion Clicked', { title: "How can checkout merchants build this functionality?" })}>
Cashfree-hosted Checkout merchants use Cashfree’s [offer engine](https://www.cashfree.com/docs/payments/checkout/coupons) to run offers. To set up risk checks, merchants leverage Cashfree’s [RiskShield](https://www.cashfree.com/docs/payments/risk-shield/overview) solution. Both offerings allow merchants to set up offer targeting strategies and risk rules through a self-serve flow on the Cashfree dashboard, making implementation easy and effective.
posthog.capture('Accordion Clicked', { title: "What is a capture call in Pre-Authorization?" })}>
Capture call is performed after authorization. It is a merchant-initiated request (via API) to collect the previously authorized funds. This step debits the amount from the customer.
posthog.capture('Accordion Clicked', { title: "What is the validity of capture?" })}>
If not captured within 7 days, the authorization expires, and the funds are released back to the customer.
posthog.capture('Accordion Clicked', { title: "Can a merchant capture a partial amount?" })}>
Yes, merchants can capture a partial amount of the authorized funds.
posthog.capture('Accordion Clicked', { title: "Is MDR charged on the authorized or captured amount?" })}>
MDR is always applied only on the captured amount.
posthog.capture('Accordion Clicked', { title: "Which cards support pre-authorization?" })}>
All Visa and Mastercard credit and debit cards support pre-authorization.
posthog.capture('Accordion Clicked', { title: "What is void in Pre-Authorization?" })}>
A void call cancels the authorization before capture, releasing the hold on funds.
posthog.capture('Accordion Clicked', { title: "Can a merchant void a partial amount?" })}>
No, voiding must be for the entire authorized amount.
posthog.capture('Accordion Clicked', { title: "What are some common use cases for Pre-Authorization?" })}>
Here are some common use cases:
posthog.capture('Accordion Clicked', { title: "How does settlement occur in a pre-authorization transaction?" })}>
Settlement occurs when the merchant finalizes a pre-authorized transaction by capturing the funds.
posthog.capture('Accordion Clicked', { title: "When does the merchant receive the funds in a pre-authorization transaction?" })}>
Merchants typically receive funds from pre-authorized transactions as per their normal settlement cycle, i.e., T+x days after a successful capture.
posthog.capture('Accordion Clicked', { title: "What happens if a customer disputes a settled transaction?" })}>
A dispute may result in a chargeback, requiring the merchant to provide proof of authorization and service fulfillment.
posthog.capture('Accordion Clicked', { title: "Does Cashfree support EMI recommendations?" })}>
Cashfree allows merchants to configure EMI options for their customers. However, we currently do not provide a built-in EMI recommendation engine.
If you want to suggest EMI plans to your users, you can implement your own recommendation logic externally, based on factors such as tenure, interest rate, and total payable amount.
posthog.capture('Accordion Clicked', { title: "How does Cashfree handle chargebacks?" })}>
The chargeback process is as follows:
1. The customer raises a dispute with their issuing bank.
2. The issuing bank communicates with the acquiring bank via the card network.
3. The acquiring bank notifies Cashfree.
4. Cashfree contacts the merchant for supporting documentation.
5. The merchant must respond within the stipulated time.
**Merchant response options:**
* **Accept the dispute:** The amount is refunded, and the dispute is marked as *Closed (Merchant Accepted)*.
* **Contest the dispute:** The merchant provides evidence, such as invoices, delivery proof, or communication logs.
**Best practices:**
* Maintain comprehensive transaction records.
* Respond to chargebacks within the required timelines.
* Clearly communicate refund and cancellation policies on your website.
The final resolution may take 21–45 days depending on the banks involved.
posthog.capture('Accordion Clicked', { title: "What are the transaction limits on Cashfree?" })}>
Cashfree applies transaction limits based on your account activation stage:
* **Partial activation:** ₹50,000 per month
* **Full activation:** Limits are set by your bank and are not controlled by Cashfree.
posthog.capture('Accordion Clicked', { title: "Does Cashfree share success rate and SLA data?" })}>
Yes. We share PG-wise success rate (SR) data periodically. Please note that this data includes only a subset of payment modes and gateways and may not represent the entire system’s performance.
posthog.capture('Accordion Clicked', { title: "Which billing and ERP systems does Cashfree support?" })}>
Cashfree supports a wide range of integrations, including:
**E-commerce platforms:**
* Shopify
* WooCommerce
* Magento
* OpenCart
* PrestaShop
* WHMCS
* WIX
* Zoho
* StoreHippo
* CScart
**ERP and SaaS platforms:**
* Education, travel, restaurant, and hospitality ERPs
* Accounting software
* Lending, checkout, and POS SaaS products
* CRMs and financial service platforms
posthog.capture('Accordion Clicked', { title: 'How to withdraw funds from Cashfree?' })}>
Cashfree supports fund withdrawals through different products. The process varies depending on whether you're using Payments (PG), Payouts, or SecureID.
**Payments (PG)**
To initiate an on-demand withdrawal from Payments Gateway:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. In the left navigation panel, go to Settlements.
3. Select On-demand from the dropdown.
4. Click **Withdraw Now** next to the available balance.
5. A list of previously initiated withdrawals is also displayed on this screen.
**Payouts**
To initiate withdrawal funds from your Cashfree Payouts wallet:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Navigate to Fund Sources > Cashfree Wallet.
3. Under the Overview section, click Withdraw next to Last Withdrawal.
4. Enter the withdrawal Amount and Remarks, then click **Withdraw**.
**SecureID**
To withdraw funds from your SecureID account:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. In the left navigation panel, go to Accounts.
3. A summary of your account transactions will be displayed.
4. Click **Withdraw** to initiate the fund withdrawal.
**Withdrawal guidelines:**
* Maximum 3 withdrawals allowed per day.
* Funds are credited only to your registered business bank account.
* Processing time is between 8:00 AM and 6:45 PM, Monday to Saturday except 2nd and 4th Saturdays.
* Withdrawals are non-reversible once submitted.
* It may take 30 minutes to a few hours for the credit to reflect.
# Transactions
Source: https://www.cashfree.com/docs/help/payments/transactions/transactions
posthog.capture('Accordion Clicked', { title: "How do I initiate refunds in Cashfree?" })}>
You can initiate refunds through our [APIs](https://www.cashfree.com/docs/api-reference/payments/latest/refunds/create#create-refund) or directly from the [Merchant Dashboard](https://merchant.cashfree.com/merchants).
To initiate a refund from the dashboard:
Navigate to Payment Gateway Dashboard → Transactions → Payments.
Select the specific transaction you want to refund.
If you have the Transaction ID or Order ID, you can search and initiate the refund directly from the dashboard.
Refunds can only be processed for successful transactions.
posthog.capture('Accordion Clicked', { title: "How do I check the status of a transaction?" })}>
As soon as you log in to your Cashfree account, the Summary section in the payment gateway dashboard will give
you instant context as to what is the amount of transaction that has happened on that particular day, and the
settlement amount that you’re yet to receive. Besides this, Cashfree also provides a wide range of reports to
analyze your business finances. The different reports that Cashfree provides you are,
* Transactions Report
* Settlement Reconciliation Report
* Settlement Summary
* Refunds Report
* Ledger Report
* Monthly Invoices
posthog.capture('Accordion Clicked', { title: "Can I track the amount of daily transactions in Cashfree?" })}>
The Cashfree Payments Dashboard provides a real-time overview of your daily transactions and finances. You can instantly track the total transactions for the day and the unsettled amount pending from Cashfree.
[Click here to learn more](https://merchant.cashfree.com/merchants/pg/summary/overview)
posthog.capture('Accordion Clicked', { title: "Can Cashfree Payments send reports to my own SFTP servers?" })}>
Yes. With Cashfree Payments, you can receive specific reports such as Transaction reports, Settlements and
Adjustment reports, directly into your own SFTP servers or Cashfree Payments' SFTP servers at a set frequency
everyday.
If you'd like Cashfree Payments to push out the reports to your own SFTP servers, please fill out this
[Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) with your requirements.
posthog.capture('Accordion Clicked', { title: "What is a dispute?" })}>
A dispute arises when there is a disagreement over a transaction, initiated by your customer with their issuing bank or directly with Cashfree Payments. Customers may also report fraudulent transactions to cyber cells, while suspicious transaction disputes are often raised directly by banks.
As a merchant, you have the option to either defend the dispute by providing sufficient evidence or accept the dispute if you agree with the claim. If you accept the dispute, the amount will be refunded to the customer.
[Read more on disputes](https://www.cashfree.com/docs/payments/manage/disputes/overview).
1. Product Quality Issues – The delivered product is defective, damaged, or does not match the description.
2. Incorrect Product – The customer received a different item than what was ordered.
3. Unauthorized Charges – Additional fees were applied without the customer’s consent.
4. Non-Delivery – The product or service was not delivered as promised.
5. Billing Errors – Mistakes in the amount charged, duplicate transactions, or incorrect billing details.
6. Fraudulent Transactions – The customer did not authorize the transaction (potential fraud or misuse).
posthog.capture('Accordion Clicked', { title: "Why am I debited for a dispute and When will I get the amount back?" })}>
When a dispute is raised, the disputed amount is debited from the merchant’s account, as banks debit Cashfree Payments to provide provisional credit to the customer.
The final refund depends on the dispute outcome:
If the dispute is resolved in your favor, the amount will be credited back to your account.
If the dispute is ruled in the customer’s favor, the amount will remain with the customer.
posthog.capture('Accordion Clicked', { title: "What is a POD QR Code and how does the TTL (Time to Live) feature work?" })}>
A POD (Pay on Demand) QR code allows merchants to generate payment QR codes that remain valid for an extended period of up to 30 days. This Time to Live (TTL) duration is configured via the PG Config settings, and it gives customers the flexibility to complete the payment at any time within the configured TTL window.
For example, a merchant may print a POD QR code on a physical receipt and hand it to a customer. The customer can scan and pay later, within the 30-day TTL.
During the TTL period:
-The payment status will not be marked as “Failed” even if payment hasn't been received. It will be marked as incomplete
-The system waits for a successful payment until TTL expires.
-If no payment is made after 30 days, the transaction is marked as USER\_DROPPED.
This ensures better control over delayed payment flows while reducing refund-related complications.
posthog.capture('Accordion Clicked', { title: "How will I be notified if my customer has raised a dispute?" })}>
Email notifications can be configured from the [Merchant Dashboard](https://merchant.cashfree.com/merchants). Emails on which the merchant wants to receive these notifications can be configured from the [Merchant Dashboard](https://merchant.cashfree.com/merchants) by following the below steps:
Go to Payment Gateway Dashboard > Settings > Email Notifications > Dispute Emails.
Emails are triggered on following events:
New Dispute Created – Get notified when a customer raises a dispute.
1. Dispute Phase/Type Change – Receive updates when the dispute moves between phases like Pre-arbitration or Arbitration.
2. State Change – Stay informed when the dispute transitions between states, e.g., Action Required → Under Review.
3. Comment Updated – Get alerts when a new comment is added to the dispute.
4. Reminder Email – Receive a notification when the dispute deadline approaches.
posthog.capture('Accordion Clicked', { title: "What are the various types of dispute?" })}>
In Cashfree Payments, Disputes can be of the following types:
**Dispute**
Raised for end-customer complaints, fraudulent, or suspicious transactions reported by law enforcement or banks.
**Retrieval**
Soft chargebacks initiated when the customer queries a transaction with their issuing bank before an actual chargeback occurs.
**Chargeback**
Raised when a customer disputes a transaction due to non-delivery of services or transaction issues, following a retrieval request.
**Pre-Arbitration**
The second level of chargeback, where the customer decides whether to pursue further dispute based on the evidence provided.
**Arbitration**
The final stage of the chargeback, where both parties submit evidence, and the card network or NPCI makes the final decision.
posthog.capture('Accordion Clicked', { title: "What are the deadlines for various disputes?" })}>
Following are the representation deadlines given to merchants depending on the type of dispute:
* **Disputes:** 3 calendar days. In certain cases, such as real-time fraudulent transactions, a 1-day deadline may apply.
* **Retrieval:** 3 calendar days.
* **Chargeback:** 3 calendar days.
* **Pre-arbitration:** 2 calendar days.
* **Arbitration:** 1 calendar day.
posthog.capture('Accordion Clicked', { title: "Why did a transaction marked as Failed later show as Success?" })}>
In rare cases, a transaction initially marked as "Failed" may later move to "Success" status during the bank reconciliation process. This typically happens when the bank confirms the settlement of funds after the initial failure was recorded.
# Cashgram FAQs
Source: https://www.cashfree.com/docs/help/payouts/Cashgram
posthog.capture('Accordion Clicked', { title: "How to assign approver to verify bulk Cashgrams?" })}>
When you create a large number of Cashgrams using the `Bulk Cashgram` feature, you may want approval from the approver in your company before sending it to the customers. An approver can verify and approve the Cashgrams, and then send them to the customers.
One of the users in your company can add all the customer details in the file and upload the file and later another user can approve the Cashgrams. The approver has the option to accept or reject the Cashgrams. After approval, the Cashgrams are sent to customers, and you can view the status of the Cashgram in the Payout Dashboard.
The option to create multiple users and assign permissions can be done from the Payout Dashboard. Click[here](https://docs.cashfree.com/docs/approve-cashgrams)for more information. Fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1), if you want to use the Approve Bulk Cashgrams feature.
posthog.capture('Accordion Clicked', { title: "What happens if the customer enters an incorrect bank account while redeeming a Cashgram?" })}>
If the customer enters an invalid bank account number or IFSC code we will notify him on the web page. But if the customer enters a valid but incorrect account number the money will be transferred to that bank account.
posthog.capture('Accordion Clicked', { title: "What is a Cashgram?" })}>
Cashgram is an instant payout link used by businesses to send money to their customers, vendors, or partners, even if you do not know their bank account details. Users can access the payment link sent via WhatsApp, email, or SMS, provide their details, and choose a payment method to receive the amount.
Merchants can create a single Cashgram or create a larger number of Cashgrams at a time using the dashboard.
posthog.capture('Accordion Clicked', { title: "Detailed Walkthrough of the new Cashgram changes" })}>
Cashgram helps businesses to instantly send money to users when bank account details are not known. With Cashgram, you can pay your vendors, partners, customers, or others instantly when you only know their mobile number or email address.
What changes in the new Cashgram?
Creating a Cashgram
With this new upgrade, you can now specify the type of disbursal you are doing with the Payout Type field (Example - refunds, reimbursements, rewards) and a brief note on why the disbursal is being made in the Payout Reason field.
Customizing your Cashgram checkout page:
You can now customize your checkout page with logos and colors that reflect your brand. Here’s how you do it,
Login to the Cashgram dashboard
Click on Settings > General > Branding
Once in, you can upload your logo, add your brand color to customize your Cashgrams, and enhance the experience for the end-user
Here\`s how the checkout experience will look like for your end-users:
posthog.capture('Accordion Clicked', { title: "How to generate a Cashgram?" })}>
You can create Cashgrams via the Payouts Dashboard or APIs. Ensure your Payouts account has sufficient balance, as funds are deducted from it to send money to beneficiaries.
Steps to create a Cashgram:
Navigate to:
Payouts Dashboard > Cashgram > Create Cashgram.
Fill in the details:
Cashgram ID: A unique identifier to track the Cashgram.
Payout Type: Select from Refunds, Reimbursements, Rewards, or add custom types.
Beneficiary Details: Name, Phone Number, Email, and Transfer Amount.
Validity: Set the expiry date for the Cashgram link.
Reason & Remarks: Remarks will appear in the beneficiary’s bank statement if supported.
Notification Mode: Choose Email, SMS, or WhatsApp to notify the beneficiary.
Click "Create":
The Cashgram link is sent to the beneficiary. They can click the link, provide details, and receive the funds.
posthog.capture('Accordion Clicked', { title: "How to generate bulk Cashgrams?" })}>
When you have to create and send Cashgrams to a large number of customers you can use the ‘Bulk Cashgram’ feature. You can upload the file with the details using the ‘Upload File’ button in the Payouts Dashboard.
You can view the status of the uploaded files and also download them to view further details.
To upload a batch file:
1. Go to Payouts Dashboard > Cashgram > Batch > click Upload File.
2. Click Choose a File to select the file you want to upload and then click Upload. The uploaded file will be visible in the Batch section.
3. Click on the file to view the individual Cashgram details uploaded in the file.
**Note**- Maximum file size allowed is 5 MB, and a maximum of 10000 records can be included in the file.
posthog.capture('Accordion Clicked', { title: "How secure is Cashgram?" })}>
Cashgram is a secure way to transfer money to your customers. Once you create a Cashgram for a user only that user with the provided phone number can use that Cashgram. Cashgram is also active only for a limited amount of time, you can control the expiry time of each Cashgram. Post expiry, no one will be able to view/redeem the Cashgram.
Once a Cashgram has been redeemed or expired, the customer will not be able to view it again.
posthog.capture('Accordion Clicked', { title: "How do I let a user know that I have generated a Cashgram for them?" })}>
You can use the dashboard to notify the user about their Cashgram. We will notify the customer over email or SMS.
posthog.capture('Accordion Clicked', { title: "Is it possible to edit or deactivate an active Cashgram?" })}>
You can't edit an active Cashgram. However, you can deactivate it at any time.
posthog.capture('Accordion Clicked', { title: "Why is a customer’s Cashgram status showing as pending?" })}>
Once the customer submits their bank details to redeem a Cashgram we will initiate a bank transfer from Merchant’s account to the customer’s bank account.When the transfer status is yet to be confirmed, the Cashgram is in the Pending state. At this point, the partner bank could be processing the payout, and no further action is required from your end.
The Pending state can transition into:
* Redeemed state, if the Cashgram is successfully redeemed.
* Failed state, if the Cashgram could not be redeemed.
posthog.capture('Accordion Clicked', { title: "What happens if the user fails to get money using Cashgram?" })}>
If a beneficiary fails to redeem a Cashgram, it will appear as Failed on your dashboard. The Failed state is final and cannot transition to any other state.
Common reasons for failure include:
1. Incorrect beneficiary account details.
2. Insufficient balance in your Payouts account. Enable Low Balance Alerts to get notified when your balance falls below a set threshold.
3. Downtime or issues with partner or beneficiary bank servers.
4. Most failures occur due to exceeding OTP limits. Ensure accurate details and sufficient balance to minimize such occurrences.
posthog.capture('Accordion Clicked', { title: "What are Payout links?" })}>
A Payout Links is a way to instantly send money to your beneficiaries without knowing their bank account details. You can simply create a payout link from the Cashfree Payments dashboard, and send it to your vendors/ customers on their email id or mobile number.
posthog.capture('Accordion Clicked', { title: "Will I be notified if the Cashgram I generated is used?" })}>
Once the customer redeems a Cashgram its status changes from ACTIVE to REDEEMED instantly. You will be able to view this on the dashboard. You will also be notified over email once a Cashgram has been successfully redeemed, if merchant has opted for the email notification.
posthog.capture('Accordion Clicked', { title: "How do I use a Cashgram?" })}>
To use a Cashgram you need to have a Cashfree account. From your Cashfree dashboard, you can create a new Cashgram for a customer. The typical process is listed below-
The merchant creates a Cashgram filling in the customer’s phone number.
The customer receives SMS and email notification about this Cashgram generated by the Merchant.
The customer visits the Cashgram link, authenticates, and enters their bank details.
The money is instantly transferred from Merchant’s account to the customer’s bank account.
posthog.capture('Accordion Clicked', { title: "How can I start using Cashgram?" })}>
To start using Cashgram you will need to sign-up with Cashfree. If you already have a Payout account you can instantly start using Cashgram using the dashboard. Click on the “Cashgram” tab in the Payout dashboard.
posthog.capture('Accordion Clicked', { title: "My Cashgram link is not working. What do I do?" })}>
A Cashgram link may not work if it is in an Expired, Failed, or Reversed state. Cashgrams remain Active for up to 30 days or the specified duration and can transition to states like Redeemed, Expired, Failed, or Reversed.
Check the Cashgram status on the Payouts Dashboard. If the Cashgram link sent to you has expired. Please get in touch with the merchant to get a new Cashgram.
posthog.capture('Accordion Clicked', { title: "Can the customer view and redeem a Cashgram any time?" })}>
Yes, the Cashgram recipient will be able to view and redeem their Cashgram at any time.
posthog.capture('Accordion Clicked', { title: "What happens if the Cashgram is never used?" })}>
Every Cashgram has an expiry date. If the Cashgram is not redeemed before this expiry date, the Cashgram will become inactive. No one will be able to view/redeem such an inactive Cashgram.
posthog.capture('Accordion Clicked', { title: "How will you verify user identity for Cashgram?" })}>
We authenticate users using OTP so that only authorized users can view/redeem a Cashgram. Without a valid OTP, nobody can view/redeem a particular Cashgram.
posthog.capture('Accordion Clicked', { title: "Can customers also redeem money to their UPI account?" })}>
If you have UPI enabled in your Smart Payout account your customers will be able to redeem a Cashgram to their UPI account.
posthog.capture('Accordion Clicked', { title: "Can customers also redeem money to their PayTM account?" })}>
If you have PayTM enabled in your Smart Payout account your customers will be able to redeem a Cashgram to their PayTM account.
posthog.capture('Accordion Clicked', { title: "What are the advantages of using a Cashgram?" })}>
Cashgram simplifies money transfers by removing the need for bank details or manual processing. Users are notified via WhatsApp, email, or SMS and can redeem payments anytime using a secure link.\
**Key Benefits:**
* Instant refunds for COD payments, cash prizes, and security deposits.
* No need to collect bank details; users choose from multiple payment methods.
* Saves time with automated payment processing.
* Supports single or bulk Cashgram creation via the dashboard.
posthog.capture('Accordion Clicked', { title: "Is Cashgram different from Payout links?" })}>
Cashgram is a payout link with many additional features. You can customize your Cashgram links with your company logo and color to reflect your brand. You can also set up a link expiry time and verify the beneficiary's name before sending out the money.
posthog.capture('Accordion Clicked', { title: "I am not able to receive the OTP." })}>
Please verify your mobile number with the merchant. You can receive the OTP via SMS or WhatsApp. If one method does not work, we recommend trying the alternative. In case you are still not receiving the OTP, Please reach out to us from [here](https://www.cashfree.com/en/report-issue/).
posthog.capture('Accordion Clicked', { title: "What is a Payout link?" })}>
A Payout Link is a way to instantly send money to your beneficiaries without knowing their bank account details. You can simply create a payout link from the Cashfree Payments dashboard, and send it to your vendors/ customers on their email id or mobile number.
posthog.capture('Accordion Clicked', { title: "I received a Cashgram on email but the mobile number mentioned on the Cashgram is incorrect. How do I proceed?" })}>
It seems that the Merchant entered a different mobile number while generating the Cashgram. Please reach out to the merchant to get this changed.
posthog.capture('Accordion Clicked', { title: "My Cashgram transfer is showing successful but I have not received the money in my account?" })}>
The money should be transferred into your account in some time. If you do not receive the amount within one hour please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1). Do mention your email id, phone number, Cashgram Id, and merchant name in your email.
posthog.capture('Accordion Clicked', { title: "My Cashgram transfer failed, what do I do now?" })}>
A Cashgram can fail due to:
1. Incorrect beneficiary account details.
2. Insufficient balance in your Payouts account. To avoid this, set a Low Balance Alert to receive notifications when the balance falls below a specified amount.
3. Downtime in partner or beneficiary bank servers.\
Please reach out to the merchant so that they can generate a new Cashgram for you.
posthog.capture('Accordion Clicked', { title: "What all details do I need to redeem a Cashgram?" })}>
Cashgram can be redeemed to your bank account, UPI VPA, or PayTM. If any of the above modes is not enabled for you, please get in touch with the merchant.
posthog.capture('Accordion Clicked', { title: "My Cashgram transfer is pending, when will the money be credited into my account?" })}>
When the transfer status is yet to be confirmed, the Cashgram is in the Pending state. At this point, the partner bank could be processing the payout, and no further action is required from your end.
The Pending state can transition into:
1. Redeemed state, if the Cashgram is successfully redeemed.
2. Failed state, if the Cashgram could not be redeemed.
Please wait for 24 hours, if you still have not received the money in your account, reach us by filling out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1). Do mention your email id, phone number, Cashgram Id, and merchant name in the support form.
posthog.capture('Accordion Clicked', { title: "My Cashgram is not showing PayTM or UPI?" })}>
If any of the above modes is not enabled for you, please get in touch with the merchant.
# Payouts: General FAQs
Source: https://www.cashfree.com/docs/help/payouts/general-faqs
posthog.capture('Accordion Clicked', { title: "Transaction is successful, but the amount is not received by the customer" })}>
In this case, the amount may get reversed to your payouts account within 24 hours from the transfer status has changed to successful, if the customer's account details are incorrect or if the beneficiary bank has any technical issues.
If the status has not changed to reversed post the above-mentioned time, fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)
posthog.capture('Accordion Clicked', { title: "What is Payouts and its key features?" })}>
It is a comprehensive payment disbursal solution that allows businesses to efficiently send and manage payments for various use cases, including vendor payouts, customer refunds, and salary distributions. It eliminates the need for complex Excel uploads to corporate banking portals for bulk transfers.
Key Features:
1. Multiple Payout Methods: Supports IMPS, NEFT, RTGS, UPI, Mastercard (MoneySend), Visa (Visa Direct), and digital wallets (Amazon Pay, Paytm).
2. Do instant payouts, 24x7, even on bank holidays.
3. Add or delete any number of beneficiary accounts.
4. Do bulk payments instantly (up to 10,000 transactions in a minute).
5. Track each account separately using the dashboard.
6. Automatic reconciliations.
Click [here](https://www.cashfree.com/docs/payouts/payouts/introduction) to know more about how you can use Payouts efficiently for your business.
{" "}
posthog.capture('Accordion Clicked', { title: "Why is my transaction showing as Pending?" })}>
A transaction can show as Pending if it's still being processed by either the Partner Bank or the Beneficiary Bank (your customer’s bank). This means the transfer has been initiated, but we’re waiting for the bank to confirm it.
Please wait up to 72 hours from the time the transfer was started to see the final status.
Here’s how long transfers typically take based on the payout mode:
UPI – 99% are completed within 15 minutes
IMPS – 99% are completed within 15 minutes
RTGS – 99% are completed within 1–2 hours
NEFT – 99% are completed within 6 hours
If the status is still pending after 72 hours, you can reach out for support.
posthog.capture('Accordion Clicked', { title: "How to generate new API Keys and remove existing ones?" })}>
You can add or delete API keys and IP addresses under the 'Developers' tab.
Select API Keys or IP Whitelist as per your need.
Steps: Go to [Merchant Dashboard](https://merchant.cashfree.com/auth/login) - Developers tab - API Keys - Generate API Keys
You can generate and use up to 3 API Keys at any point in time.
Know more:
posthog.capture('Accordion Clicked', { title: "How does Payouts by Cashfree Payments work?" })}>
Step 1: Link banks to the account.
Sign up on Cashfree Payments and initiate Payouts Account activation through the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). Once activated, link your bank account(s) with your Payouts Account. Click here to know more about linking your bank account with Payouts.
Step 2: Add beneficiary.
Add beneficiary to your Payout account(s) using our Dashboard or APIs. Cashfree Payments allows you to instantly validate the account details. Know more about beneficiary addition here.
Step 3: Start paying out
Start paying out to your beneficiaries. Cashfree Payments supports multiple payment modes: IMPS, NEFT, UPI VPA, and digital wallets(Amazon Pay and Paytm). Know more about making a payout to your beneficiaries here.
Step 4: Get notified and automate reconciliation.
Get event notifications via email or webhooks. You can also use your [Merchant Dashboard](https://merchant.cashfree.com/auth/login) to view detailed reports.
posthog.capture('Accordion Clicked', { title: "Important Update | Paytm Policy change. Steps to continue Paytm Payouts via Cashfree." })}>
This document is for Cashfree Payouts and Cashgram merchants who use Paytm as a payment mode.
As per new policies adopted by Paytm, Payouts and Cashgram merchants will be required to have a Paytm business account to do payments to Paytm wallets. Here is how you can set up your Paytm business account and continue doing payments to Paytm wallets via Cashfree.
1. Create a [Paytm business account](https://dashboard.paytm.com/login/) (if you already do not have one), enter your business details, and upload the scanned copies of [documents](https://business.paytm.com/document-requirements) based on your business type.
2. Once your Paytm account has been created, you will get User Acceptance Testing (UAT) credentials that can be used to do test transactions in a staging environment before going live.
3. You can share the UAT credentials with Cashfree at [Support team](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) along with your merchant ID. Cashfree will do test transactions on your behalf and reply to your email with the test transactions’ details.
4. Share the test transactions’ details with Paytm. Paytm will generate production credentials for your account.
5. Share the production credentials with Cashfree. On receiving the production credentials, Cashfree will enable Payouts/Cashgram payments to Paytm wallets for your account.
Maintaining funds in your Paytm wallet.
Your Cashfree Dashboard will show the available Paytm wallet balance separately. In order to add funds to your Paytm wallet, you will have to log in to your Paytm business account and recharge your wallet. Once recharged, you can come back to your Cashfree dashboard and carry out transactions.
Pricing
As applicable to your Paytm business account. No additional charges.
Alternative to maintaining a Paytm business account.
* If you would prefer not to maintain a Paytm business account, you can:
* Use alternative payment modes such as bank transfer, card, UPI or AmazonPay
* If you are a Payouts user and do not have recipients’ payment details, you can use Cashgram payout links to transfer money to your users without having to collect their payment details. Know more about Cashgram [here](/payouts/cashgram/cashgram). Cashgram is activated by default for Payout users.
Here is a quick video to show how Cashgram works.
If you have any questions, please contact your Account Manager, or you can fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1). Thank you for using Cashfree.
posthog.capture('Accordion Clicked', { title: "What is the difference in making a payout using a Recharge account and Payouts Direct?" })}>
The primary difference between a Payouts recharge account and Payouts Direct is that a Payouts recharge account gives merchants the flexibility to make payments to their customers using any method that they are comfortable with, namely bank, card, UPI, and wallet payments.
Payouts Direct allows you to make instant and automated payments directly from your bank account. Cashfree’s Payouts Direct integrates directly with your bank account, eliminating the need to maintain funds in the Recharge account. The balance in your account is available to make the payments. However, payout methods such as cards, UPI, and wallet payments will not be available for disbursals.
posthog.capture('Accordion Clicked', { title: "How can I start using Payouts?" })}>
Steps to activate your Payouts account and start using Payouts to do single or bulk transfers:
Step 1: Sign up on [Cashfree Payments](https://www.cashfree.com/) and complete your KYC
Step 2: Once your account is activated, you will get an account activation success email.
Step 3: Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and start transferring money using the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). You can use a sample Excel file to do bulk transfers or use [API](/api-reference/payouts/overview).
Watch - How to use Payouts by Cashfree Payments:
posthog.capture('Accordion Clicked', { title: "How can I recharge my Payouts account?" })}>
Here is how you can add funds to your Cashfree Payout wallet:
Step 1: Log in to your Cashfree Dashboard.
Step 2: Click on Payouts.
Step 3: Click on "Fund Sources" and then select the fund source that you wish to recharge.
Step 4: Scroll down and you should be able to see virtual bank accounts that you can use to recharge your Cashfree payout account.
Step 5: Add any of them as a beneficiary from your Net Banking portal and initiate a bank transfer. Please add them as "Other Bank" and not "Same Bank", even if your account is with the same bank.
Please note that all the recharges must be initiated from the whitelisted bank accounts.
Recommendation: - Please add both of these virtual bank accounts as a beneficiary at your end so that, if there is a downtime with one of these banks, you can send the funds to the other virtual bank account.
Once you've done this, the amount will be added to your account.
Know more about 'Accounts':
{" "}
posthog.capture('Accordion Clicked', { title: "Why is my Payouts transfer in Pending or Initiated state?" })}>
If the beneficiary bank doesn’t provide a transfer acknowledgement in real-time, the transaction is marked as **Pending/Initiated**. The final status (Success or Failure) is typically updated within 3 working days. If there’s no update after this period, kindly reach out to the merchant for support.
posthog.capture('Accordion Clicked', { title: "How many banks can Cashfree Payments send payouts to? Can payouts be processed on holidays?" })}>
For Payouts, we support transfers to 160+ banks in India.
Payouts can be processed 24\*7 even on bank holidays with all leading banks. For the rest, the transfer will get settled on the next working day.
{" "}
posthog.capture('Accordion Clicked', { title: " Does the payout transfer happen instantly?" })}>
Payouts happen instantly for small amounts (up to a few lakhs) and can take
1-2 hours for higher amounts. Sometimes banks face downtime with their
platforms. Payouts are queued and dispatched once it's up and running again.
posthog.capture('Accordion Clicked', { title: "How to view the current webhook endpoint?" })}>
Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payouts > Developers > Webhooks > Add Webhook URL**
Know more:
posthog.capture('Accordion Clicked', { title: " Can I use more than one Payouts account?" })}>
Cashfree Payments supports multiple payout accounts to support your business use cases.
For example, If there are two distinct use cases for Payouts, such as in the case of Swiggy where they need to process payouts for both restaurants and delivery partners, they may require two separate accounts to manage these transactions efficiently then Cashfree Payments will create an additional Payout account.
Talk to your account manager or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) to know more. You can switch between the accounts by selecting 'SWITCH ACCOUNTS' in the Payouts Dashboard.
Know more about 'Accounts':
posthog.capture('Accordion Clicked', { title: "How can I add a beneficiary?" })}>
You can add your customers, vendors, or partners as beneficiaries using their bank account details or UPIs to make instant and automated payments. You can also add them using the wallet details or a beneficiary’s card details. You can also upload Beneficiary details in Bulk.
Once beneficiary payment details are added, all future payouts can happen using the beneficiary ID without entering other details.
Steps: Go to [Merchant Dashboard](https://merchant.cashfree.com/auth/login) - Payouts - Beneficiaries - All/Batch - Add Beneficiary
Know more:
posthog.capture('Accordion Clicked', { title: "Do I need to be a registered business to use Cashfree Payouts?" })}>
Yes, Payouts can be used only by registered businesses.
If you are not yet registered as a business but plan to start soon, you can sign up and explore the product in the test environment.
We can also set up an account with limits on payout volume after understanding your business and future needs.
{" "}
posthog.capture('Accordion Clicked', { title: "Why did my transfer request fail?" })}>
Bank Transfer: Bank transfers can fail if the beneficiary bank is unable to
process the transfer request in real-time. You can re-try the transfer
attempts in such cases after a few minutes. [Read
more](https://www.cashfree.com/docs/payouts/payouts/make-payouts/lifecycle#failed)
If this issue persists, please reach out to us with the bank account number
and IFSC code.
posthog.capture('Accordion Clicked', { title: "How can I transfer funds from one Payout account to another?" })}>
You can transfer funds from one Cashfree Payout account to another using the Internal Transfer option.
You will see the Internal Transfer option in the Payouts Dashboard once you have more than one Payouts account enabled.
Just click on ‘Transfer’ -> Quick Transfer -> Select the ’Account’ and Enter the ‘Amount’ -> Click on ‘Transfer’ to transfer the amount.
Write to the Cashfree Payments team at [support team](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1), if you want to use more than one Payouts account.
Know more:
posthog.capture('Accordion Clicked', { title: "Transaction status is showing as \'Failed\'. When will I receive the funds?" })}>
If the status is 'Failed', kindly re-initiate the transfer.
In this case, ideally, the amount will not be debited from your payouts account. If debited, money will be reversed to you by the remitter bank within 24hrs.
posthog.capture('Accordion Clicked', { title: "How to make a Batch transfer of funds to beneficiaries using file upload?" })}>
You can use the ‘Batch Transfer’ feature to create and initiate a large number of transfers to the beneficiaries.
* Click on ‘Download sample file’ to find out the details required to be filled in the batch file.
* Add all the required details in the sample downloaded and click on ‘Upload File’ to upload the Batch transfer file.
* You can also use various filters like ‘Processing’, ‘Pending Approval’, ‘Rejected’ and ‘Cancelled’ etc. to search the transfers.
* If you wish to download a ‘Transfer Report’ -- Just click on the ‘Download’ button to do the same.
Know more:
posthog.capture('Accordion Clicked', { title: "Customer initiated a withdrawal, but the amount was not received?" })}>
The transfer will be done instantly.
If the status is Queued, our partner bank wouldn't have shared with us a response regarding the status of the transfer.
If the status has not changed post 24 hours of the withdrawal initiation, please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
posthog.capture('Accordion Clicked', { title: "Transaction status is \'Reversed\' but I have not yet received funds" })}>
Funds ideally get credited immediately.
If not, please wait for 72 hrs as the amount would be with the beneficiary bank which is supposed to be reversed to your Payouts account.
Post 24hrs, if the amount is not credited to you, please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)
posthog.capture('Accordion Clicked', { title: "Do you support payouts to and from other countries?" })}>
Yes, it is possible to send bulk payouts to beneficiaries in India from another country using Global Payouts. The funds can be added by the businesses in USD, EUR and other freely convertible currencies. The purpose of the payment must be known while setting up the account.
An Indian business can also send a payout to other countries. However, there are restrictions around the volume of payments and the purpose of payments. [Get in touch](https://www.cashfree.com/contact-sales/) with us to learn more.
posthog.capture('Accordion Clicked', { title: "Transaction was successful, but later showing as reversed" })}>
If the status changed to Reversed after Successful, inform the customer to check the details below:
* Incorrect account details.
* Reversal by the clearinghouse.
* Reversal by the beneficiary bank due to technical issues.
Here, Cashfree Payments credits the original amount to your Payouts account.
Select a transfer that has been reversed to view more details about the transaction.
Reversed is a final state and does not allow transitioning to any other state.
posthog.capture('Accordion Clicked', { title: "Where can I find my reversed transfers?" })}>
After a successful transaction, in rare cases, a transaction can be reversed by the bank a few days after a successful transaction. It is known as 'Reversed transfer'
You can view all the transfers that have been reversed on a particular day/week by the bank under the ‘Reversed’ tab.
This helps the merchant ensure that the transfer reversal is not missed and appropriate next steps can be taken.You can download all the transfers - just click on the ‘Export’ button.
Know more:
posthog.capture('Accordion Clicked', { title: "How to make a quick transfer of funds to your beneficiaries?" })}>
You can make a ‘Quick transfer’ to your beneficiary using the Transfer feature.
You can also check the status of recent payouts made to your beneficiaries.
To make a quick transfer:
1. Go to Payouts Dashboard > Transfers > click Quick Transfer.
2. Enter the Beneficiary ID, select the Fund Source from which you want to transfer funds, and select the Transfer Method.
3. Enter the Transfer ID, Amount, and Remarks.
Click [here](https://www.cashfree.com/docs/payouts/payouts/make-payouts/customers#quick-transfer) to know more about Quick Transfers.
Know more:
posthog.capture('Accordion Clicked', { title: "How is Payouts different from using banks for bulk payouts?" })}>
Bulk payouts via bank accounts happen by manually adding every beneficiary before transferring or by uploading a spreadsheet on the banking portal. Cashfree Payments automates bulk payouts fully via APIs and offers a much simpler alternative.
Unlike banks, where a single error in a payout file can block all the bulk payouts, using Cashfree Payments, even if there are invalid records in a file, valid transfers go through. Reconciliation for failed and invalid transfers is automated so you always know which transfer failed out of hundreds of payouts, and why. At Cashfree Payments, new beneficiary addition and activation is instant.
Cashfree Payments also allows you to send money to any Paytm Wallet, Amazon Pay Wallet, UPI ID or native wallets in addition to bank accounts, even on holidays. Lastly, all of this can be automated and built into your product or internal systems using our powerful Payouts APIs.
posthog.capture('Accordion Clicked', { title: "Transaction status is showing \'sent to beneficiary\'" })}>
In most cases, the transfer status changes to successful, and the amount will be credited to the customer (or reversed if the customer's account details are incorrect or if the beneficiary bank encounters technical issues) within 24 hours of initiation. However, in rare cases, it may take up to 72 hours, depending on the beneficiary bank.
If the status remains unchanged after 72 hours, please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for further assistance.
posthog.capture('Accordion Clicked', { title: "Is it simpler to send bulk payouts file uploads or via APIs?" })}>
Using bulk file uploads or manual transfers requires no technical expertise and is the quickest way to get started.
However, if you want to automate the payouts from your product or ERP, APIs should be used.
Integrating the API can take a day or two, depending on the complexity of the integration.
Many businesses start by using the bulk file upload or manual transfer option, and gradually automate operations by integrating the API.
View developer documentation [here](https://www.cashfree.com/docs/api-reference/payouts/v1/batch-transfer).
posthog.capture('Accordion Clicked', { title: "What happens in case the account details are incorrect" })}>
Transfers to incorrect account details fail instantly.
For certain banks, it may take up to 24 hours to receive a confirmation of failure.
To ensure that account details are correct, you can activate Cashfree Bank Account Verification and verify the beneficiary account validity and beneficiary name at the bank.
posthog.capture('Accordion Clicked', { title: "What are the different types of reports and how to access them?" })}>
Cashfree Payments offers a wide range of ‘Payouts Reports’ such as:
* Transfer reports - Here you can view details of the Payouts made and Cashgrams that are redeemed for the date range selected.
* Account Statement -In this report, you can view details of all the credits and debits in your Payouts account.
* Reversed Transfers - Here you can view details like date, time, and reason of all transfers that are reversed.
Other reports like Cashgram, PAN Verification and Bank Validation are also available.
To download a report → Just select the ‘Report type’ → You can use various filters to generate your report as per your preference
Now, click on ‘Generate Report’ to generate the report. → You can now download the generated report or delete it.
You can also search and filter the generated reports.
Know more:
{" "}
posthog.capture('Accordion Clicked', { title: "Can I edit beneficiary details?" })}>
The feature to edit beneficiaries is not available on the dashboard.
posthog.capture('Accordion Clicked', { title: "How to assign approver to verify Bulk Transfers?" })}>
The Batch Transfers need approval before the amount gets transferred to the respective beneficiaries.
Therefore, under the ‘Approve Batch’ tab, the same can be accepted or rejected.
It is an optional feature, which can be enabled upon request.
Go to the ‘Approve Batch’ tab → Select a file → And you can Approve or Reject the transfers.
Approvals can work at a ‘transfer level’ as well as ‘file level’ - where all or partial transfers can be approved at once.
Know more:
{" "}
posthog.capture('Accordion Clicked', { title: "I am unable to upload the batch file in beneficiaries and transfers?" })}>
We regret the inconvenience caused. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)
from your registered email ID.
posthog.capture('Accordion Clicked', { title: "How do I delete a beneficiary?" })}>
To delete a beneficiary:
1. Go to Payouts Dashboard > Beneficiaries.
2. Select the beneficiary you want to delete and click the Delete option on the right of the dashboard.
3. You cannot initiate payouts to beneficiaries after you have deleted them.
posthog.capture('Accordion Clicked', { title: "How to enable email updates for daily reports and transfers notifications?" })}>
You can configure the different categories for which you want to receive emails for
notifications from Cashfree Payments, like Set email preference for daily
reports and transfer notifications, enable or disable transfer initiation
email, etc. To enable the email notifications: 1. Log in to the Payouts
dashboard using your credentials, and click Settings from the top navigation
pane. 2. Click [Email
Notifications](https://merchant.cashfree.com/payouts/settings/email-notifications)
under the Payouts card. [Know
more](https://www.cashfree.com/docs/payouts/payouts/dashboard/set-email-notifications#email-notifications)
posthog.capture('Accordion Clicked', { title: "Payouts transfer initiated but not credited to the customer?" })}>
The transfer will be done instantly.
If the customer states that the money is not credited, please check the status of the transfer as follows:
Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payouts > Transfers** to check the **Status** of the respective transfer.
Pending: The payout is in progress and awaiting confirmation from the bank.
Sent to Beneficiary: Inform the customer to wait for 24 hours as the money is with the remitter bank.
Success: When the remitter's bank has completed the transfer, the payout is in the Success state. Kindly Share the UTR with the customer to check with their respective bank.
Processing: The payout request has been received and is being processed.
Failed: Transfers to incorrect account details fail instantly. For certain banks, it may take up to 24 hours to receive a confirmation of failure. Kindly re-initiate the transfer.
Reversed: A payout can be in the Reversed state due to various reasons, such as:
* Incorrect account details
* Reversal by the clearinghouse
* Reversal by the beneficiary bank
Reversed is a final state and does not allow transitioning to any other state. Cashfree credits the original amount to your Payouts account.
posthog.capture('Accordion Clicked', { title: "How can I whitelist IP addresses?" })}>
To whitelist your IP,
Go to Payouts Dashboard > Developers section on the left-side navigation > Payouts > Two-Factor Authentication > IP Whitelist.
Click Add IP Address.
Enter the IP Address you want to whitelist and save the details. All the IP's you have whitelisted will be displayed as shown below.
**Note**- You can whitelist a maximum of 10 IPs.
posthog.capture('Accordion Clicked', { title: 'How to withdraw funds from Cashfree?' })}>
Cashfree supports fund withdrawals through different products. The process varies depending on whether you're using Payments (PG), Payouts, or SecureID.
**Payments (PG)**
To initiate an on-demand withdrawal from Payments Gateway:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. In the left navigation panel, go to Settlements.
3. Select On-demand from the dropdown.
4. Click **Withdraw Now** next to the available balance.
5. A list of previously initiated withdrawals is also displayed on this screen.
**Payouts**
To initiate withdrawal funds from your Cashfree Payouts wallet:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Navigate to Fund Sources > Cashfree Wallet.
3. Under the Overview section, click Withdraw next to Last Withdrawal.
4. Enter the withdrawal Amount and Remarks, then click **Withdraw**.
**SecureID**
To withdraw funds from your SecureID account:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. In the left navigation panel, go to Accounts.
3. A summary of your account transactions will be displayed.
4. Click **Withdraw** to initiate the fund withdrawal.
**Withdrawal guidelines:**
* Maximum 3 withdrawals allowed per day.
* Funds are credited only to your registered business bank account.
* Processing time is between 8:00 AM and 6:45 PM, Monday to Saturday except 2nd and 4th Saturdays.
* Withdrawals are non-reversible once submitted.
* It may take 30 minutes to a few hours for the credit to reflect.
# IP Whitelist and Public Key FAQs
Source: https://www.cashfree.com/docs/help/payouts/ip-whitelist
posthog.capture('Accordion Clicked', { title: "Why do I have to whitelist the IP address or generate a public key?" })}>
Whitelisting the IP address or generating a public key provides a layer of authentication. These cybersecurity techniques prevent anonymous or unknown disbursement requests and allow only verified requests.
posthog.capture('Accordion Clicked', { title: "What is an IP address?" })}>
A string of characters that identifies each computer using the Internet Protocol to communicate over a network. Computers use IP addresses to communicate with each other over the internet.
posthog.capture('Accordion Clicked', { title: "What does it mean to whitelist an IP?" })}>
Whitelisted IPs are an index of approved entities. A whitelist approves a list of email addresses, IP addresses for communication.
posthog.capture('Accordion Clicked', { title: "What happens after I whitelist my IP address?" })}>
The Cashfree Payments production server allows your API requests.
posthog.capture('Accordion Clicked', { title: "How many IP addresses can I whitelist?" })}>
You can whitelist a maximum of 25 IP addresses.
posthog.capture('Accordion Clicked', { title: "Does Cashfree Payments support IPv6?" })}>
No, we only support API requests from IPv4 at the moment.
posthog.capture('Accordion Clicked', { title: "When do I use a public key?" })}>
If your IP address is not static, generate a public key in the Cashfree Payments portal.
posthog.capture('Accordion Clicked', { title: "How to generate a public key from the Cashfree Payments portal?" })}>
1. In the Cashfree Payments dashboard, select **Developers** from the navigation panel on the left.
2. Click **Two-Factor Authentication** from the **Payouts** card.
3. Select **Public Key** from the **Select 2FA Method** dropdown menu.
4. Click **Generate Public Key**.
5. The public key is downloaded to your computer. Use your registered email ID to access the key.
posthog.capture('Accordion Clicked', { title: "How many public keys can I generate at a time?" })}>
One. You can generate only 1 public key at a time.
posthog.capture('Accordion Clicked', { title: "How to use the public key to send API requests?" })}>
You need to generate a signature and proceed with the API requests.
Below are the steps to generate the signature:
1. Retrieve your client ID.
2. Append this with CURRENT UNIX timestamp separated by a period (.).
3. Encrypt this data with the generated public key using RSA encryption - this is the signature.
4. Pass this signature in the header X-CF-Signature.
# Aadhaar Verification FAQs
Source: https://www.cashfree.com/docs/help/secure-id/aadhaar-verification
posthog.capture('Accordion Clicked', { title: "What Aadhaar verification methods does Cashfree offer?" })}>
Cashfree offers two primary Aadhaar verification methods:
* **DigiLocker verification**: Secure, government-approved verification where users share documents directly from their DigiLocker account with consent
* **OCR verification**: Image-based verification using optical character recognition technology to extract details from uploaded Aadhaar documents
posthog.capture('Accordion Clicked', { title: "Which verification method should a business choose?" })}>
The choice depends on specific requirements:
* **Choose DigiLocker verification** to prioritise security, compliance, and user experience. It's government-verified, requires no document uploads, and is DPDPA compliant
* **Choose OCR verification** to handle physical documents or workflows that require image-based verification
DigiLocker is generally recommended for most businesses due to its superior security and user experience.
posthog.capture('Accordion Clicked', { title: "What if a customer doesn't have a DigiLocker account?" })}>
Yes, customers can still use DigiLocker verification even without an existing account. If a customer doesn't have a DigiLocker account, they can create one during the verification process. The system will guide them through:
* Creating a new DigiLocker account using their Aadhaar-linked mobile number
* Setting up a PIN for account security
* Providing consent to share their Aadhaar document
This typically takes 2-3 minutes and only needs to be done once.
posthog.capture('Accordion Clicked', { title: "What happens if a customer's Aadhaar isn't linked to DigiLocker?" })}>
If the Aadhaar isn't linked to DigiLocker, the verification can't proceed through DigiLocker. In this case, you can:
* Use the OCR verification method instead
* Advise the customer to link their Aadhaar to DigiLocker through the official DigiLocker website
* Check with the customer if they have an existing DigiLocker account with different credentials
{" "}
posthog.capture('Accordion Clicked', { title: "Do I have to pay in advance, or can I pay after the Aadhaar verification is done?" })}>
There is an option to pay either way - pre-paid or post-paid. Please get in
touch with our sales team to find the best suitable method for you.
{" "}
posthog.capture('Accordion Clicked', { title: "What is OTP-based Aadhaar Verification?" })}>
Note: This feature has been discontinued and is no longer available.
For current Aadhaar verification options, please refer to our Smart OCR API.
{" "}
posthog.capture('Accordion Clicked', { title: "Does Cashfree support OKYC (Offline KYC) for Aadhaar verification?" })}>
No, OKYC (Offline KYC) isn't supported for Aadhaar verification.
For Aadhaar verification, we recommend using:
* **Smart OCR API**: Extract and verify Aadhaar details from document images
* **DigiLocker integration**: Verify Aadhaar through government-backed DigiLocker platform
* **Video KYC**: Complete verification through live agent-assisted video calls
These alternatives provide secure and compliant Aadhaar verification without requiring OKYC.
posthog.capture('Accordion Clicked', { title: "What all details can be verified through OTP-based Aadhaar Verification?" })}>
The following details can be verified through OTP-based Aadhaar Verification, by Cashfree Payments:
* Registered Name
posthog.capture('Accordion Clicked', { title: "How can you track if DigiLocker verification was successful?" })}>
You can track the verification status through multiple methods:
* **Real-time status checks**: Use the Get Verification Status API to check current progress
* **Webhook notifications**: Receive instant updates when status changes (PENDING, AUTHENTICATED, EXPIRED, CONSENT\_DENIED)
* **Final document retrieval**: Once successful, use the Get Document API to retrieve the verified Aadhaar details
The entire process typically completes within 2-3 minutes.
posthog.capture('Accordion Clicked', { title: "How to handle blurry Aadhaar image uploads?" })}>
For OCR verification, image quality is crucial. If the image is blurry:
* Ask the customer to retake the photo ensuring good lighting and focus
* Verify the Aadhaar number is clearly visible and not scratched or damaged
* Ensure the image captures the entire document without cutting off edges
* Avoid including other objects in the photo
Consider switching to DigiLocker verification to avoid image quality issues entirely.
posthog.capture('Accordion Clicked', { title: "Can you verify someone's Aadhaar using only their name?" })}>
No, you can't verify an Aadhaar card using only the person's name. For security and privacy reasons, Aadhaar verification requires:
* The complete 12-digit Aadhaar number for both DigiLocker and OCR verification methods
* User consent (explicit for DigiLocker, implied for OCR verification)
* Proper authentication through the respective verification flow
posthog.capture('Accordion Clicked', { title: "Is DigiLocker verification legally compliant for KYC requirements?" })}>
Yes, DigiLocker verification is fully compliant with regulatory requirements:
* **Government-approved**: DigiLocker is an official government platform
* **DPDPA compliant**: Meets Digital Personal Data Protection Act (DPDPA) 2023 requirements
* **User consent-based**: Explicit user consent is obtained before accessing documents
* **Audit trail**: Complete verification history is maintained for compliance
This makes it suitable for KYC requirements across banking, lending, insurance, and fintech sectors.
posthog.capture('Accordion Clicked', { title: "What details are accessible after successful Aadhaar verification?" })}>
The accessible details depend on the verification method used:
**DigiLocker verification provides:**
* Full name as registered
* Complete address
* Date of birth
* Gender
* Aadhaar number
* Father's name (if available)
**OCR verification extracts:**
* Aadhaar number
* Name
* Address
* Other visible details from the document image
DigiLocker typically provides more comprehensive and accurate information.
posthog.capture('Accordion Clicked', { title: "Is upfront payment required for Aadhaar verification services?" })}>
Cashfree offers flexible payment options to suit business needs:
* **Prepaid**: Pay in advance and use credits for verification
* **Postpaid**: Pay after using the verification services based on usage
Contact the sales team to discuss the most suitable payment model for business volume and requirements.
posthog.capture('Accordion Clicked', { title: "How secure is DigiLocker verification for privacy-conscious customers?" })}>
DigiLocker verification offers the highest level of privacy and security:
* **Government-managed**: DigiLocker is owned and operated by the Government of India
* **Explicit consent**: Documents are shared only after user provides clear consent
* **No document storage**: Cashfree doesn't store physical document copies
* **Secure transmission**: All data transfers use encrypted channels
* **Limited access**: Only specific requested details are shared
You can assure customers that this method is more secure than sharing physical document copies.
posthog.capture('Accordion Clicked', { title: "What happens if verification fails or times out?" })}>
Different scenarios can cause verification issues:
**DigiLocker verification failures:**
* **EXPIRED**: Link expired (10-minute validity) - generate a new link
* **CONSENT\_DENIED**: User rejected consent - try document processing method
* **Network issues**: Retry after some time or use alternative method
**OCR verification failures:**
* **Poor image quality**: Request better quality images
* **Invalid document**: Verify it's a genuine Aadhaar card
* **Processing errors**: Retry or contact support
Always implement fallback mechanisms and proper error handling in your integration.
posthog.capture('Accordion Clicked', { title: "Are there any volume limits for Aadhaar verification?" })}>
Cashfree supports high-volume verification requirements:
* **Rate limits**: Standard API rate limits apply - contact support for higher limits
* **Daily volumes**: No specific daily caps, but enterprise customers get priority processing
* **Concurrent requests**: Multiple parallel verifications supported
* **Bulk processing**: Available for large-scale verification needs
For high-volume requirements (10,000+ verifications per day), contact the sales team for optimised pricing and performance.
posthog.capture('Accordion Clicked', { title: "What is the validity of the received OTP?" })}>
The generated OTP will be valid for 10 minutes.
posthog.capture('Accordion Clicked', { title: "How fast do verification results come back?" })}>
Response times vary by verification method:
**DigiLocker verification:**
* Initial API response: Immediate (URL generation)
* User completion time: 2-3 minutes (depends on user actions)
* Final document retrieval: 1-2 seconds after user consent
**OCR verification:**
* Image upload processing: 30-60 seconds
* Data extraction: Near real-time
* Verification result: Within 1-2 minutes
Use webhooks for real-time notifications instead of polling for status updates.
posthog.capture('Accordion Clicked', { title: "Can verification be integrated into mobile applications?" })}>
Yes, both verification methods work seamlessly in mobile applications:
**DigiLocker on mobile:**
* Use WebView or in-app browser to load DigiLocker consent URL
* Handle redirect URLs to capture completion status
* Optimised mobile interface provided by DigiLocker
**OCR verification on mobile:**
* Camera integration for document capture
* Image quality validation before upload
* Real-time feedback for better user experience
SDKs and mobile-specific documentation available for popular platforms (Android, iOS, React Native, Flutter).
# Bank Account Verification FAQs
Source: https://www.cashfree.com/docs/help/secure-id/bav
posthog.capture('Accordion Clicked', { title: "I want to use Cashfree Payments marketplace settlement for paying vendors. Do I need to take verification feature separately?" })}>
Yes, if you are using Cashfree Payments marketplace settlement and want to use verification API as well, you need to opt for the feature separately. Our payment experts will help you with integration and you will be able to use the Cashfree Payments marketplace settlement and Secure ID together.
posthog.capture('Accordion Clicked', { title: "How can I use Bank Account Verification API for KYC?" })}>
KYC or “Know Your Customer” is a process to be undertaken by businesses especially financial institutions to obtain information about the identity and address of the customers. One of the key documents is bank account details as the same is regarded as valid proof of the identity of a person/entity.
While onboarding vendors, delivery partners, or even employees, an organisation needs to do a bank account verification. Using Cashfree Payments API, this process can be automated by integrating with the company's existing internal system so that the bank verification process happens smoothly, without exposing the data to any third party. You can also verify PAN, Aadhaar and GSTIN of users or businesses with our Verification Suite.
posthog.capture('Accordion Clicked', { title: "For how many banks, can I do the verification?" })}>
The verification can be done for all the a/c of recognized Indian banks including all public banks, private banks, and 126+ co-operative banks\*.
Verification may not be possible for some cooperative bank accounts.
posthog.capture('Accordion Clicked', { title: "How to verify a/c number on Cashfree Payments for multiple individuals?" })}>
On Cashfree Payments, you can do verification for any number of Indian bank accounts via two modes:
1. Manual entry on Cashfree Payments Bank Account Verification dashboard:
Here you will be required to enter only two details: Indian bank account number and IFSC. If you want to do bulk verification, You can access the bulk upload feature on the dashboard where you can submit a CSV/XSLX file with required details and get a quick response.
2. Using Bank Account Verification API:
This is an integrated automated way to do single/bulk verification. The API can be integrated with the existing company internal system or ERP and then the request can be pushed directly using APIs.
posthog.capture('Accordion Clicked', { title: "Why is Bank Account Verification important?" })}>
Our Plug and Play integrated a/c number Verification API helps you confirm bank account validity instantly. By accessing updated data, the risk of identity fraud and incorrect/incomplete data is reduced. The result such as the account holder’s name shown to you will be exactly as it appears in bank records.
posthog.capture('Accordion Clicked', { title: "I am planning to opt for Cashfree Payouts for bulk disbursals. Do I need to go for verification API separately?" })}>
Yes, Payouts is different. Users can integrate Bank Account Verification to do the validation & will be charged separately.
posthog.capture('Accordion Clicked', { title: "What are the other use cases of this(BAV) feature?" })}>
The capability to verify a/c can be used in multiple business scenarios such as:
1. A crucial part of the verification process before providing loans of all kinds (education, health, business, car etc)
2. Employee background check: A recruitment agency can use the feature for a candidate's background check
3. Vendor onboarding: A marketplace splitting commission with different vendors can use the feature to verify the a/c details at the time of onboarding the vendor, this also helps in correct payments later on.
The ability to integrate the API with existing ERP helps in reducing operational effort and saves cost by 90%.
posthog.capture('Accordion Clicked', { title: "Is there any limit on the total number of Bank Account Verification requests per day?" })}>
No, there is no such limit. You can use this feature to verify any number of bank accounts in a day 24\*7.
posthog.capture('Accordion Clicked', { title: "How much time does verification take?" })}>
On Cashfree Payments, you can verify a/c numbers instantly. As you submit the request, our API gives an instant response.
posthog.capture('Accordion Clicked', { title: "Is there any limit on the total number of UPI requests per day?" })}>
No, there is no such limit. You can use the feature to verify any number of UPI IDs in a day 24\*7.
posthog.capture('Accordion Clicked', { title: "I am planning to opt for Cashfree Payouts for bulk disbursals on UPI ID. Do I need to go for Verification API separately?" })}>
If you are a Payouts merchant, the Secure ID products such as Bank Account Verification (including UPI), Aadhaar Verification, GSTIN Verification, and PAN Verification will be automatically enabled for you. However, you will be charged separately for each validation.
posthog.capture('Accordion Clicked', { title: "How to verify UPI ID on Cashfree Payments for multiple individuals?" })}>
On Cashfree Payments, you can do verification for any number of UPI IDs of individuals or entities via two modes:
1. Manual entry on Cashfree Payments UPI ID verification dashboard.
Here you will be required to enter only one detail: UPI ID (eg abc\@okaxis)
2. Using API
An integrated automated way to do UPI Verification. The API can be integrated with the company's existing internal system or ERP and the request can be pushed directly using APIs.
posthog.capture('Accordion Clicked', { title: "What is UPI ID Verification?" })}>
UPI ID (also called Virtual Payment Address or VPA) is a unique ID you need to create to send and accept money via UPI. Once a UPI address is created and mapped against your existing bank account, you can simply share your UPI address (eg. abc\@okaxis) with the payer.
As a business, verifying a UPI ID comes in handy. The different use cases can be
* Background verification at the time of onboarding a new user/vendor
* Before releasing payment to a UPI ID
With Cashfree Payments instantly verify if the UPI ID is valid, For a Valid UPI ID cross-verify the name of the account holder
posthog.capture('Accordion Clicked', { title: "How much time does the Verification take?" })}>
On Cashfree Payments, you can verify any number of UPI IDs instantly. As you submit the request, our API gives an instant response.
# Secure ID: General FAQs
Source: https://www.cashfree.com/docs/help/secure-id/general-faqs
posthog.capture('Accordion Clicked', { title: 'How to withdraw funds from Cashfree?' })}>
Cashfree supports fund withdrawals through different products. The process varies depending on whether you're using Payments (PG), Payouts, or SecureID.
**Payments (PG)**
To initiate an on-demand withdrawal from Payments Gateway:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. In the left navigation panel, go to Settlements.
3. Select On-demand from the dropdown.
4. Click **Withdraw Now** next to the available balance.
5. A list of previously initiated withdrawals is also displayed on this screen.
**Payouts**
To initiate withdrawal funds from your Cashfree Payouts wallet:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Navigate to Fund Sources > Cashfree Wallet.
3. Under the Overview section, click Withdraw next to Last Withdrawal.
4. Enter the withdrawal Amount and Remarks, then click **Withdraw**.
**SecureID**
To withdraw funds from your SecureID account:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. In the left navigation panel, go to Accounts.
3. A summary of your account transactions will be displayed.
4. Click **Withdraw** to initiate the fund withdrawal.
**Withdrawal guidelines:**
* Maximum 3 withdrawals allowed per day.
* Funds are credited only to your registered business bank account.
* Processing time is between 8:00 AM and 6:45 PM, Monday to Saturday except 2nd and 4th Saturdays.
* Withdrawals are non-reversible once submitted.
* It may take 30 minutes to a few hours for the credit to reflect.
# GSTIN Verification FAQs
Source: https://www.cashfree.com/docs/help/secure-id/gstin-verification
posthog.capture('Accordion Clicked', { title: "What are the details that I will be able to see on verifying the GSTIN of an entity?" })}>
The system will return whether the GSTIN is valid or not along with the following details (if valid):
* The legal name of the business
* GSTIN status
* Taxpayer type
* Date of registration
* GSTIN
* Nature of business
* Business principal address
posthog.capture('Accordion Clicked', { title: "Is there any limit to the number of GSTINs that can be verified in a day?" })}>
No, there is no limit to the number of GST numbers that can be verified in a day.
posthog.capture('Accordion Clicked', { title: "Can I verify the GSTIN by just knowing the name of the person?" })}>
No, to verify a GSTIN, it is mandatory to enter the GST number.
posthog.capture('Accordion Clicked', { title: "Which businesses can benefit from GSTIN verification?" })}>
With GSTIN verification, businesses can now verify the GST number of an entity instantly. The following businesses can benefit from this feature:
* Ecommerce marketplaces
* B2B Reseller Companies
* B2B Ecommerce
* Tax processing and return filing platforms
* Lending and micro-financing platforms
* Insurance providers
* Banks
* Identity verification companies
posthog.capture('Accordion Clicked', { title: "Do I need to pay in advance for GSTIN verification?" })}>
Yes, GSTIN verification requires prepaid payment. Please get in touch with our sales team to set up your account and find the best suitable plan for you.
posthog.capture('Accordion Clicked', { title: "What are the details I need to input to verify a GSTIN?" })}>
All you need to input is the 15-digit GSTIN number of the business and you will get an instant verification status and other business details.
posthog.capture('Accordion Clicked', { title: "What is online GSTIN verification?" })}>
Online GSTIN verification lets businesses validate and verify the authenticity of their customer/vendor/employee’s GSTIN details to avoid identity theft or dealing with fraudsters.
posthog.capture('Accordion Clicked', { title: "What is the average response time for the GSTIN Api?" })}>
The average response time is less than a second.
# PAN Verification FAQs
Source: https://www.cashfree.com/docs/help/secure-id/pan-verification
posthog.capture('Accordion Clicked', { title: "How much time does PAN verification take?" })}>
On Cashfree Payments you can verify upto 10,000 PANs instantly. As you submit the request, our API gives an instant response.
posthog.capture('Accordion Clicked', { title: "Which businesses can benefit from PAN Verification?" })}>
The PAN verification feature can be used to identify the person/businesses during onboarding as well as before initiating the transaction.
Following business categories can use PAN verification to speed up their onboarding, KYC and payment process:
* Lending platforms
* Insurance providers and platforms
* Investment portals
* Wallets
* EMI/installments providers
* Any form of credit providers
* Offline and online marketplaces to onboard vendors, sellers
* Large corporations for onboarding employees
* Payments & fintech companies
posthog.capture('Accordion Clicked', { title: "How to verify PAN using Cashfree Payments for multiple PAN cards?" })}>
With Cashfree Payments, you can do verification for any number of PAN via two modes:
1. Via Dashboard
You can use the dashboard to not only do single PAN verification, but you can also download the sample template, add PAN of users and upload the file and get instant response for upto 10,000+ PANs at a time.
2. Using API
This is an integrated automated way to do bulk verification. The API can be integrated with existing company internal systems or ERP and then requests can be pushed directly using API.
posthog.capture('Accordion Clicked', { title: "I want to use EasySplit - Cashfree marketplace settlement product for paying vendors. Do I need to take the PAN verification feature separately for vendor KYC?" })}>
Yes, if you are using EasySplit and want to use the PAN verification API as well, you need to opt for the feature separately. Our experts will help you with integration and you will be able to use EasySplit and PAN verification features together.
posthog.capture('Accordion Clicked', { title: "I am planning to opt for Cashfree Payouts for bulk disbursals. Do I need to go for PAN verification API separately?" })}>
If you are a Payouts user, you can visit the dashboard to activate PAN verification for your account. PAN verification will be charged separately.
posthog.capture('Accordion Clicked', { title: "Is there any limit on the total number of PAN verification requests per day?" })}>
No, there is no such limit. You can use the feature to verify any number of PANs in a day 24\*7.
posthog.capture('Accordion Clicked', { title: "Why is PAN verification important?" })}>
PAN is a means of identifying various taxpayers in the country. The PAN system of identification is a computer-based system that assigns a unique identification number to every Indian tax-paying entity.
Through this method, all tax-related information for a person is recorded against a single PAN number which acts as the primary key for the storage of information. This is shared across the country and hence no two people on tax paying entities can have the same PAN.
Our Plug and Play integrated PAN verification API helps you confirm if PAN is valid or not, and match the name provided with the name registered with NSDL, the PAN issuing institution.
By accessing updated data, the risk of identity fraud and incorrect/incomplete data is reduced.
posthog.capture('Accordion Clicked', { title: "What is online PAN verification?" })}>
Online PAN verification enables merchants to verify their users’ PAN card details, get the status of the PAN card, and check whether it belongs to a business or an individual.
posthog.capture('Accordion Clicked', { title: "What are the details that I will be able to see on verifying a PAN?" })}>
You will be able to see whether the PAN is valid or not along with the following details (if valid):
* PAN number
* Name provided
* Verification ID
* PAN type
* Name registered
posthog.capture('Accordion Clicked', { title: "Can I verify the PAN card by just knowing the name of the person?" })}>
No, to verify a PAN, it is mandatory to enter the PAN number.
posthog.capture('Accordion Clicked', { title: "What are the other use cases of PAN Verification feature?" })}>
The capability to verify PAN can be used in multiple business scenarios such as
1. Employee background check: a recruitment agency can use the feature for a candidate's background check
2. Vendor onboarding: a marketplace splitting commission with different vendors can use the feature to verify the a/c details at the time of onboarding the vendor, this also helps in correct payments later on. The ability to integrate the API with existing ERP helps in reducing operational effort and saves cost.
posthog.capture('Accordion Clicked', { title: "How can I use the PAN verification API for KYC?" })}>
KYC or “Know Your Customer” is a process undertaken by businesses, especially financial institutions to obtain information about the identity of customers. One of the key documents required is PAN as the same is regarded as valid proof for the financial identity of a person/entity.
While onboarding vendors, delivery partners, or even employees, an organisation needs to do a PAN verification. Using Cashfree Payments API, this process can be automated and integrated with existing company internal systems so that the verification process happens smoothly, without exposing the data to any third party.
# softPOS FAQs
Source: https://www.cashfree.com/docs/help/softpos/softpos
## General FAQs
posthog.capture('Accordion Clicked', { title: "What is softPOS and what are its benefits?" })}>
Cashfree Payments softPOS is an Android-based Point of Sale (POS) solution that enables businesses to accept digital and in-person payments seamlessly. It supports 100+ payment options, including QR codes, Cards, Payment Links, Net Banking, Wallets, and Buy Now Pay Later.
Key Benefits:
1. Turn any Android device into a POS – Just download the app and start accepting payments.
2. Accept multiple payment modes – Manage all transactions in one place for easy reconciliation.
3. Boost sales – Offer flexible payment options like Buy Now, Pay Later to attract more customers.
4. Enable agent-based collections – Assign agents to collect payments, with all transactions reflected in the [Merchant Dashboard](https://merchant.cashfree.com/merchants).
Prerequisites: Works on Android 6.0+ and a Cashfree Payment Gateway account.
posthog.capture('Accordion Clicked', { title: "How does softPOS work?" })}>
Use the Cashfree SoftPOS app to accept payments digitally or in person, directly from your phone. Customers can pay via QR code, Payment Links, Cards, Net Banking, Wallets, and more.
To use SoftPOS, sign up as a Cashfree Payments merchant and activate your Payment Gateway account. Then, request SoftPOS activation from your dashboard. Once approved, add agents, install the app, and start collecting and tracking payments easily.
Click [here](https://www.cashfree.com/docs/payments/softpos/how-softpos-works#how-softpos-works) to know more.
This involves 4 major steps:
1. Activate softPOS
2. Add Agents to Collect Payments
3. Install softPOS Application
4. Receive Payments and Reconcile
posthog.capture('Accordion Clicked', { title: "Is softPOS application available in the iOS App Store?" })}>
No, the Cashfree Payments softPOS application is not available on the iOS App
Store. It is currently available only on the Google Play Store.
posthog.capture('Accordion Clicked', { title: "Are there any transaction limits in softPOS?" })}>
There are no daily transaction limits, but there are limits on the amount
processed per transaction through different payment modes. These limits can be
customized based on your requirements.
posthog.capture('Accordion Clicked', { title: "How many agents can a single merchant add?" })}>
There is no limit. Businesses can add an unlimited number of agents.
posthog.capture('Accordion Clicked', { title: "Are there any extra charges to use the application?" })}>
No, the application is absolutely free. Cashfree Payments charges only for
transactions made using the softPOS application, as applicable. There is no
maintenance or registration fee for using the application.
posthog.capture('Accordion Clicked', { title: "How many agents can a single merchant add?" })}>
There’s no limit. A merchant can add an unlimited number of agents.
posthog.capture('Accordion Clicked', { title: "Is softPOS application available in the iOS App Store?" })}>
No, the Cashfree Payments softPOS application isn't available on the iOS App Store. It's currently available only on the Google Play Store.
posthog.capture('Accordion Clicked', { title: "Are there any transaction limits?" })}>
There are no daily transaction limits. However, there are per-transaction limits, which can be customised based on your business needs.
posthog.capture('Accordion Clicked', { title: "Are there any extra charges to use the application?" })}>
No, the application is free to use. Cashfree Payments charges only for transactions processed through the softPOS application. There are no maintenance or registration fees.
posthog.capture('Accordion Clicked', { title: "Can I customize digital receipts on SoftPOS?" })}>
Currently, digital receipt customization isn't available on Cashfree’s SoftPOS solution.
posthog.capture('Accordion Clicked', { title: "Does SoftPOS support barcode scanning?" })}>
No. Barcode scanning is currently not supported in the Cashfree SoftPOS solution.
posthog.capture('Accordion Clicked', { title: "Can I integrate loyalty programs with SoftPOS?" })}>
Cashfree doesn't offer built-in loyalty program integrations with SoftPOS. You can explore custom development externally to integrate loyalty features.
posthog.capture('Accordion Clicked', { title: "Can I link SoftPOS with P2P POS devices?" })}>
Peer-to-peer POS linking for persistent customers isn't directly supported. However, we’re open to reviewing your use case and may suggest workarounds.
posthog.capture('Accordion Clicked', { title: "Can I print receipts using SoftPOS?" })}>
SoftPOS doesn't support built-in invoice printing. Merchants can integrate third-party software or hardware to print receipts.
## Transactions
posthog.capture('Accordion Clicked', { title: "How do I initiate a transaction?" })}>
To initiate a transaction:
1. Go to the **New Payments** tab.
2. Enter the amount you want to receive.
3. Choose the payment mode you wish to proceed with.
4. Fill in the required details and click on **Accept**.
The user will then be shown a QR code that can be scanned using a PSP app to complete the payment.
posthog.capture('Accordion Clicked', { title: "How can I check if a transaction is successful?" })}>
You can check the status of each transaction in the Payments tab.
* Transactions in an incomplete state may move to success once confirmation is received from the customer’s bank.
* If the status doesn’t update and money is deducted, the amount will be returned within 3-4 working days.
posthog.capture('Accordion Clicked', { title: "How can I see a transaction in a particular date range?" })}>
**Payment Gateway Dashboard** > **Transactions** > **Payments** > Drop down menu on the filter for **dates** > **Custom date range**
posthog.capture('Accordion Clicked', { title: "How can I search for a transaction based on status?" })}>
**Payment Gateway Dashboard** > **Transactions** > **Payments** > **Search and filter** > **Status**
posthog.capture('Accordion Clicked', { title: "What could be the reason for payment being declined?" })}>
There can be multiple reasons for a payment being declined, including failures from the bank's end.
If money is deducted from the customer’s account but the status shows as a failure, the amount will be reversed back to the customer’s account within 7 to 10 working days.
posthog.capture('Accordion Clicked', { title: "How long should I wait if a transaction is pending?" })}>
If a transaction is pending:
1. Go to the **Payments** tab and pull down to refresh the status of the transaction.
2. If the transaction status shows as failed, the money will be reversed to the customer’s account within 7 to 10 working days.
## Dynamic QR code
posthog.capture('Accordion Clicked', { title: "How is this payment option different from the static QR code?" })}>
The difference between dynamic and static QR codes is:
* **Dynamic QR Code**:
* The agent must enter the amount the customer needs to pay.
* The agent can also customize the order by entering details such as the customer's phone number, invoice number, and order note.
* **Static QR Code**:
* The customer scans the QR code using their PSP app, enters the amount, and completes the payment.
posthog.capture('Accordion Clicked', { title: "What are the transaction limits on this payment mode?" })}>
The upper limit per transaction is ₹1 lakh.
This limit can be modified in the dashboard under **Payment Methods**.
posthog.capture('Accordion Clicked', { title: "What happens if the timer runs out before my customer could make a transaction?" })}>
If the timer runs out before the customer completes the transaction:
* If the customer has **not scanned** the QR code, you will need to regenerate the order by re-entering all details in the **New Payments** tab.
* If the customer has **scanned** the QR code, they can continue the transaction. You can check the transaction status in the **Payments** tab by performing a pull-down refresh.
## Payment link
posthog.capture('Accordion Clicked', { title: "How to share a Payment Link?" })}>
The Payment Link is shared via SMS to the phone number entered by the agent.
posthog.capture('Accordion Clicked', { title: "What payment options do my customers get?" })}>
Your customers will have access to 120+ payment options, including cards, net banking, wallets, pay later, and more.
## Cash
posthog.capture('Accordion Clicked', { title: "What does the option of Cash do?" })}>
The **Cash** option allows the agent to make a ledger entry for any cash collection done upon rendering a service. There is no processing involved from Cashfree Payments. These transactions will show up in the **Payments** tab and in the reports, which can be used by merchants for reconciliation.
posthog.capture('Accordion Clicked', { title: "Will I be able to see the transactions marked as cash in the transactions report?" })}>
Yes, you will be able to see the details of all transactions, including those marked as cash, in the transaction report.
## Reports
posthog.capture('Accordion Clicked', { title: "Where can I see the reports for the transaction?" })}>
You can download the SoftPOS transaction report from the **Reports** section of your [Merchant Dashboard](https://merchant.cashfree.com/merchants).
To do so, click on **Reports**, navigate to **Download Report**, and generate a new report. Select the desired **file type**, choose **SoftPOS Transactions** as the report type, and specify the date range for the transactions.
posthog.capture('Accordion Clicked', { title: "What are the details covered in the transaction report?" })}>
The transaction report covers all the details of a transaction, including agent-level details such as:
* Agent's name
* Terminal ID
* Payment method
## Cashfree policies
posthog.capture('Accordion Clicked', { title: "How do I get more information on Cashfree or its policies?" })}>
For further information on Cashfree Payments and its policies, or if you wish to reach out to us, please refer to the following:
* **Grievance Policy**: [Grievance Redressal Policy](https://www.cashfree.com/grievance-redressal-policy/)
* **Terms**: [Terms and Conditions](https://www.cashfree.com/tnc/)
* **Privacy Policy**: [Privacy Policy](https://www.cashfree.com/privacypolicy/)
**Grievance Officer**: Mr. Vaibhav Kaushal\
**Address**: Cashfree Payments India Pvt Ltd
RMZ Eco world, Building 7
10th Floor, Devarabeesanahalli, Marathalli Outer Ring road,
Bangalore - 560103\
**E-Mail**: [grievances@cashfree.com](mailto:grievances@cashfree.com)
**NODAL OFFICER**: Mr. Shaik Mohammed Aftab Alam\
**Address**: Cashfree Payments India Pvt Ltd
RMZ Eco world, Building 7
10th Floor, Devarabeesanahalli, Marathalli Outer Ring road,
Bangalore - 560103\
**E-Mail**: [dispute@cashfree.com](mailto:dispute@cashfree.com)
# Subscriptions FAQs
Source: https://www.cashfree.com/docs/help/subscriptions/faqs/faqs
posthog.capture('Accordion Clicked', { title: "What are the different ways that I can use Cashfree to collect recurring payments or payments for subscriptions from my customers?" })}>
Cashfree offers four different payment methods, each with specific limits on the allowed subscription amounts, as outlined below.
* UPI AutoPay
* Cards
* eNach
* Physical Mandate
[Read more](https://www.cashfree.com/docs/payments/subscription/payment-modes) about these payment modes.
posthog.capture('Accordion Clicked', { title: "Is the Cashfree Subscriptions solution compliant with the new Digital Lending Guidelines by RBI?" })}>
Yes, it is fully compliant with the new Digital Lending Guidelines by RBI. NBFCs and Fintechs can use Cashfree Payments to collect repayments, disburse credit, and co-lend without a hassle.
posthog.capture('Accordion Clicked', { title: "Who can benefit from using Cashfree Subscriptions?" })}>
Cashfree Subscriptions caters to various industries with diverse use cases. Some of the top ones include:
NBFCs and Digital Lending Apps
OTT Platforms
Ed-Tech Platforms
E-commerce Companies
Investment Firms
Insurance Providers
posthog.capture('Accordion Clicked', { title: "How to create a subscriptions plan on Cashfree Payments dashboard?" })}>
1. Go to **Subscription Dashboard** > **All subscriptions** > **Create Subscriptions**
2. Enter details – Add customer info, subscription ID, recurring amount, due date, and max debits.
posthog.capture('Accordion Clicked', { title: "How to create a UPI AutoPay plan?" })}>
To create a new subscription from the dashboard, Go to Subscriptions Dashboard > All Subscriptions > Create Subscription.
You can also create multiple subscriptions at once using the dashboard. Go to Subscriptions Dashboard > Batch Subscriptions > Upload File to upload a file that contains all the information required for multiple subscriptions.
[Learn more](https://www.cashfree.com/docs/payments/subscription/create)
posthog.capture('Accordion Clicked', { title: "What is the Bulk Payments tab on the Subscriptions dashboard?" })}>
For On-Demand subscriptions, when you want to initiate a large number of payments for multiple subscriptions, you can use the Bulk Payments feature.
posthog.capture('Accordion Clicked', { title: "Can I migrate my mandate data from another payment aggregator to Cashfree?" })}>
Cashfree supports importing of mandate information for a subscription. You can move any historical mandate data to Cashfree and continue the transactions in Cashfree. Steps to initiate the porting process-
Cashfree Payments ensures a smooth mandate porting experience.
1. Contact Cashfree Support – Initiate the porting process by nominating Cashfree as your payment processing partner for your Utility Code or mandates.
2. Partner Bank Coordination – Share the mandate list with your partner bank to update their systems. Our team will guide you through the process.
3. Import Mandates – Upload the updated mandate list into Cashfree’s system.
4. Start Processing Payments – Once imported, you can begin processing payments seamlessly through Cashfree.
[Read more](https://www.cashfree.com/docs/payments/subscription/import)
posthog.capture('Accordion Clicked', { title: "What are the various eNACH transaction failure reasons?" })}>
Once the eMandate is successfully created, the corresponding transactions can get declined due to the reasons listed below:
| Transaction Failure Reason | Detailed Description | Resolution |
| ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Balance Insufficient | This error is displayed when the end-customer does not have sufficient balance in their account. In this case, due to payment failure, the end-customer will be asked to pay a fine of amount equivalent to the cheque bounce charges by the destination bank. | The merchant can present the transaction again. It is recommended to contact the end-customer before retrying the failed transaction. A total of 3 retries are allowed before the start of the next cycle. |
| Not Arranged For or Exceeds arrangement | This error is displayed when the end-customer does not have sufficient balance in their overdraft account. | The merchant can present the transaction again. It is recommended to contact the end-customer before retrying the failed transaction. A total of 3 retries are allowed before the start of the next cycle. |
| Customer to refer to the branch | This error is displayed when the reason for the decline is unclear and the destination bank is expecting the end-customer to contact them for further clarification. | Merchant can contact the end-customer and recommend the end-customer to contact the bank and provide further clarification. |
| Account Closed | This error is displayed when the account has been closed and thus all the associated mandates were deactivated. | Further action cannot be taken in this scenario. The merchant can create another mandate for the end-customer to continue with the debit. |
| Invalid UMRN or Inactive Mandate | This error is displayed when the mandate has been de-activated by the NPCI's system. Usually when the mandate has not been debited over a prolonged period of time. | Further action cannot be taken in this scenario. The merchant can create another mandate for the end-customer to continue with the debit. |
| Mandate Cancelled | This error is displayed when the mandate has been cancelled. This can be merchant initiated or end-customer initiated. | Further action cannot be taken in this scenario. The merchant would have to create another mandate for the end-customer to continue with the debit. |
| No Such Account | This error is displayed when the account has been closed or no longer available. Thus all the associated mandates were deactivated. | Further action cannot be taken in this scenario. The merchant would have to create another mandate for the end-customer to continue with the debit. |
| A/c Blocked or Frozen | This error is displayed when all the withdrawals, purchases or transfers have been halted for this account. Hence, the presentation is not successful. | The merchant must contact the end-customer to resolve this issue. |
| Payment Stopped by Drawer | This error is displayed when the presentation has been stopped at the request of the end-customer. | The merchant must contact the end-customer to resolve this issue. |
| Payment Stopped under Court Order/Account Under Litigation | This error is displayed when the presentation has been stopped at a Court order. | The merchant must contact the end-customer to resolve this issue. |
| Customer name mismatch | This error is displayed when the account holder's name provided during mandate creation does not match the account holder's name at the time of presentation. | Since the mandate cannot be edited, the merchant must create a new mandate with the end-customer. |
| Network Failure (CBS) | This error is displayed when the Core Banking System(CBS) of the destination bank has a network failure. Generally, all the presentations for the affected bank would fail for the day. | The merchant can try to present the transaction again. The transaction is expected to go through once the system is up. |
| Returned as per customer request | This error is displayed when the presentation has been stopped at the request of the customer. | The merchant must contact the end-customer to resolve this issue. |
| KYC Documents Pending | Typically end-customer is expected to do a KYC for the bank account at least once in 3 years. On such cases, the presentation could be stopped by the bank, and this error message is displayed. | The end-customer must complete the KYC post which the merchant can try to present the transaction. |
| Documents Pending for Account Holder turning Major | This error is displayed when the documentation is pending. | End customer must complete the documentation process at the bank. |
| Account Inoperative | This error is displayed when there are no transactions in an account for the last 3 months. All the associated mandates are deactivated. | Further action cannot be taken in this scenario. The merchant would have to create another mandate for the end-customer to continue with the debit. |
| Dormant Account | This error is displayed when there are no transactions in an account for the last 6 months. Account is dormant and all the associated mandates are deactivated. | Further action cannot be taken in this scenario. The merchant would have to create another mandate for the end-customer to continue with the debit. |
| Small account, First Transaction to be from Base Branch | For a bank account type - small account, the first transaction must happen at the home branch. | |
| Account reached maximum Debit limit set on account by Bank | This error is displayed when the end-customer has sufficient balance in their account but the account has already reached the maximum limitation set for security reasons. | The merchant must contact the end-customer to increase the limit and then they try to do another presentation. |
| Account Holder Expired | This error message is displayed when the account holder has expired. | - |
| Account under litigation | This error is displayed when an account is currently under legal action. | Further debits are not possible for this bank account. A new mandate must be created with a different bank account to take this forward. |
| Aadhaar number not mapped to the account number | This error is displayed when the end customer Aadhaar number is not linked to the bank account. | The end-customer must link the Aadhaar number with the bank account post which the merchant can try to do another presentation. |
| Customer Insolvent / Insane | - | Further action cannot be taken for this error message. The merchant would have to create another mandate with a different bank account. |
| Item cancelled | This error is displayed when the end-customer has cancelled the presentation. | The merchant must contact the end-customer to get this resolved post which the merchant can try to do another presentation. |
posthog.capture('Accordion Clicked', { title: "What is the Bulk Payments tab on the Subscriptions dashboard?" })}>
For on-demand subscriptions, use the bulk payments feature to initiate a large number of payments for multiple subscriptions.
posthog.capture('Accordion Clicked', { title: "Multiple authorisations will be present if the customer has attempted the transaction multiple times?" })}>
Multiple auths will appear if the customer attempts the transaction more than once.
# Token Vault FAQs
Source: https://www.cashfree.com/docs/help/token-vault/faqs
posthog.capture('Accordion Clicked', { title: "What is card tokenization?" })}>
CCard Tokenization replaces sensitive card details (number, expiry, CVV) with a secure, random token. This token is used for payments, keeping actual card data safe and reducing the risk of fraud.
posthog.capture('Accordion Clicked', { title: "What are the RBI guidelines on tokenization?" })}>
The RBI guidelines on card tokenization are as follows,
* Payment aggregator, payment gateway or merchants cannot store card numbers on their servers even if they are PCI/DSS compliant
* Card networks and Issuing banks can only store card numbers and offer token provisioning services to other entities in payment industry
* The deadline for compliance of these guidelines is 31st of December 2021
posthog.capture('Accordion Clicked', { title: "Why do I need Token Vault by Cashfree Payments?" })}>
A Token Vault securely stores card tokens, enabling customers to make quick, hassle-free payments with saved cards. We generate interoperable network tokens, meaning they can be used across multiple payment providers for seamless transactions. Click [here](https://www.cashfree.com/docs/payments/features/token-vault) to know more
posthog.capture('Accordion Clicked', { title: "What all card details can I save once with tokenization in place?" })}>
Merchants are allowed to store only the last 4 digits of the actual card number, card scheme and issuing bank name. They cannot store other details like card bin, card expiry or CVV.
posthog.capture('Accordion Clicked', { title: "Is there any impact of tokenization on the card payments where the customer enters complete card number?" })}>
No, there is no impact as such on card payments where the customer enters the complete card number details. Only in those cases where merchants or PA/PGs were saving cards will be affected.
posthog.capture('Accordion Clicked', { title: "Can I retrieve the actual card number using the card network token?" })}>
No, merchants will not be able to get the actual card number back from the tokenized cards. Only schemes and issuing banks will be able to do so.
posthog.capture('Accordion Clicked', { title: "Can I provision card network token without taking consent from customer?" })}>
No, explicit consent of customer is mandatory while provisioning token for the card.
posthog.capture('Accordion Clicked', { title: "Can I provision card network token without the customer completing 2FA?" })}>
If 2FA fails even after the customer had given consent to tokenize the card, merchants will not be able to provision token and save the card.
posthog.capture('Accordion Clicked', { title: "Does tokenization affect any other payment mode other than cards? Which all card transactions are affected?" })}>
No, tokenization is limited only for card payments. All card payments like credit, debit, prepaid and corporate credit cards are impacted.
posthog.capture('Accordion Clicked', { title: "If a merchant is PCI/DSS compliant and was saving cards on their own server how can they meet RBI’s compliance requirement?" })}>
If you are a merchant who already PCI/DSS compliant, here is what you need to do to stay RBI compliant,
1. Merchants who were saving the card number on their own servers, will also have to either integrate with individual card schemes and become a token requestor themselves or integrate with Token Vault where Cashfree Payments will be a token requestor on merchant’s behalf.
2. PCI/DSS compliant merchants have to delete the already saved cards with them as RBI does not allow bulk tokenization of cards.
posthog.capture('Accordion Clicked', { title: "Does a merchant need to re-provision the already saved cards on another PA/PG if they wish to shift from Cashfree to some other PA/PG?" })}>
Yes, the token reference number of tokens provisioned through Cashfree will be saved with Cashfree only. However, merchants can fetch the card network tokens from Cashfree and use them for payment on any other PA/PG. It is not possible to migrate cards provisioned through Cashfree on another PG.
# Cashfree Payments Developer Documentation
Source: https://www.cashfree.com/docs/index
Get started with documentation and APIs to start integrating Cashfree Payment's Products.
```html checkout.html theme={"dark"}
Checkout
```
```javascript checkout.js theme={"dark"}
function initiateCheckout(){
const cashfree = Cashfree({
"mode":"sandbox"
});
cashfree.checkout({
paymentSessionId: "your-payment-session-id",
redirectTarget: "_modal"
});
}
```
# Merchants Integration
Source: https://www.cashfree.com/docs/partners/affiliates/assist-merchant/merchants-integration
Once payments are activated for your merchants, help them choose from a range of business-friendly solutions to seamlessly integrate and accept payments.
Cashfree Payments offers the following integration options:
* **Web integrations**: Add payment capabilities to websites using the JavaScript SDK.
* **Mobile app integrations**: Integrate payments into Android, iOS, React Native, and Flutter apps using platform-specific SDKs.
* **E-commerce plugins**: Install ready-to-use plugins on platforms such as Shopify, WooCommerce, WordPress, and others.
* **No-code solutions**: Use the Cashfree Dashboard to create Payment Links and Forms—no coding or development required.
[View feature and technical details for all solutions](https://www.cashfree.com/docs/payments/overview)
Help your merchants choose the solution that best fits their needs—and start earning on every transaction.
# Merchants KYC
Source: https://www.cashfree.com/docs/partners/affiliates/assist-merchant/merchants-kyc
Help your merchants get started quickly by assisting with their Know Your Customer (KYC) process. This improves their onboarding experience and reduces the time it takes to activate their account.
You can assist merchants with KYC in one of the following ways:
* Complete the KYC process for the merchant using your dashboard.
* Share the onboarding link with the merchant.
* Ask the merchant to complete KYC using their [Cashfree Merchant](https://merchant.cashfree.com/auth/login) Dashboard.
After KYC submission, eligible merchants are activated instantly and can start accepting payments.
## Complete KYC using your dashboard
To complete the merchant's KYC on their behalf:
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Go to the **Merchants** section.
3. Select **Complete KYC** for the merchant.
4. A new tab opens with the merchant’s onboarding form.
5. Enter the required onboarding details, following the instructions on the page.
At the final step, the merchant must enter their Aadhaar number and verify it using a one-time password (OTP). You can fill in the details up to this step. Then, share the onboarding link with the merchant to complete Aadhaar verification.
## Share the onboarding link
To share the onboarding link with the merchant:
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Go to the **Merchants** section.
3. Select the **Copy** icon next to the KYC button for the merchant.
4. Share the link using WhatsApp, Instagram, or another messaging platform.
5. Ask the merchant to log in using their Cashfree credentials or select **Login using OTP** to receive an OTP.
6. Once logged in, the onboarding page opens. The merchant can complete the onboarding steps.
For help with merchant KYC, contact your Partner Account Manager or submit a [Support Form](https://merchant.cashfree.com/auth/login).
## Track merchant status
Track the KYC and product activation status of your referred merchants in the Merchants section of the [Affiliate Partner](https://partner.cashfree.com/auth/login).
### Product status
| **Status** | **Description** |
| ------------ | ------------------------------------------------------------ |
| **Pending** | Payments aren’t activated yet. KYC is still pending. |
| **Active** | The merchant is activated and can accept payments. |
| **Rejected** | The requested products can’t be activated for this business. |
### KYC status
| **Status** | **Description** |
| ------------------------------- | -------------------------------------------------------------- |
| **Complete KYC (KYC pending)** | The default status for new merchants. Next step: complete KYC. |
| **Under review** | The KYC has been submitted and is under review. |
| **Resubmit KYC (KYC rejected)** | The submitted KYC has discrepancies. Resubmission is required. |
| **Blocked** | The requested products can’t be activated for this business. |
| **Completed** | KYC has been approved. |
# Get Started as Affiliate Partner
Source: https://www.cashfree.com/docs/partners/affiliates/become-cashfree-affiliate
Visit the [Cashfree Payments website](https://www.cashfree.com/affiliate-program/) and signup for our affiliate program. After you complete the signup process, you will get access to the Affiliate Partner Dashboard. You can add merchants, keep a check on your commissions, get a snapshot of your business with Cashfree, and more within the Affiliate Partner Dashboard.
## Signup for the affiliate program
To become an Affiliate Partner, you must first create an Affiliate Partner account with Cashfree.
1. Go to the [Cashfree Affiliate Partner website](https://www.cashfree.com/affiliate-program/) and click **Become A Partner**.
2. In the **Become a Partner** window, enter your business email and create a password for your account or signup using your Gmail account.
3. In the **Create Partner Account** window, enter your brand name and valid mobile number. Cashfree will verify the mobile number by sending an OTP.
4. [Login](https://www.cashfree.com/affiliate-program/) to the Affiliate Partner Dashboard using the same credentials.
## Activate affiliate account
After signing up, you must complete the KYC process to activate your affiliate account. We’ll verify your submitted details and enable your account for commission payouts.
Commission earnings are activated only after KYC verification. Complete the KYC process at the earliest.
### To activate your account:
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. On the **Summary** page, go to the **Complete your KYC** banner and select **Complete Now**.
3. In the KYC form:
* Fill in your business details.
* Fill in your business verification details.
* Fill in your bank account details.
4. Select **Submit**.
Cashfree Payments will review your submission. While your KYC is under review, you can begin referring merchants. The review process typically takes fewer than **3 business days**.
* You will be notified via **email** and **WhatsApp** once the review is complete. You can also track the status on your **Partner Dashboard**.
* If any discrepancies are found, they will be displayed on your dashboard. Please correct and resubmit the details.
* Once your KYC is approved, you will be eligible to withdraw any earned commissions.
**Note**: Offer Cashfree Payments product suite to your clients. You can refer merchants using your Dashboard. Once referred, you can assist them with their KYC and Payment Integration. Learn how to [refer new merchants](/partners/affiliates/refer-merchants) using your Affiliate Partner Dashboard.
## Partner activation checklist
The following documents are required for KYC verification, based on your business type:
| **Business Type** | **Requirement** | **Details / Accepted Documents** |
| -------------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Individual (unregistered)** | Business identity proof | Personal PAN |
| | Business owner identity proof | Aadhaar (of owner) |
| | Business bank account proof | Owner’s bank account |
| **Sole proprietorship** | Business identity proof | Personal PAN |
| | Business registration proof | GSTIN or one of:
• Municipal certificate
• Shop establishment certificate
• Udyog Aadhaar | | | Business owner identity proof | Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Private or public limited** | Business identity proof | Company PAN | | | Business registration proof | CIN or GSTIN | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Partnership** | Business identity proof | Company PAN | | | Business registration proof | Registered partnership deed | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **LLP** | Business identity proof | Company PAN | | | Business registration proof | LLPIN or GSTIN | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Hindu Undivided Family (HUF)** | Business identity proof | Company PAN | | | Business registration proof | Registered HUF deed | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Others** | Business identity proof | Company PAN | | | Business registration proof | Registered business proof or GSTIN | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account |
# Affiliate Partner Dashboard
Source: https://www.cashfree.com/docs/partners/affiliates/dashboard
The Affiliate Dashboard is a feature-rich user interface that helps you to add and manage your merchants effectively. Analyse your business progress, monitor your commissions and more within the dashboard.
## Dashboard components
* [Summary](/partners/affiliates/dashboard#summary)
* [Merchants](/partners/affiliates/dashboard#merchants)
* [PG Orders](/partners/affiliates/dashboard#pg-orders)
* [Commission](/partners/affiliates/dashboard#commission)
### Summary
The **Summary** screen gives you details about your daily transactions, like the current-day transaction count, the value of the transactions made by your merchants, and the last commission amount you received from Cashfree Payments as per the referral program.
The following details are available on this page:
* Number of Transactions Today - Total number of PG and Payout transactions done by your merchants.
* Value of Today's Transactions - Total value of PG and Payout transactions done by your merchants today.
* Merchant Stats - Number of merchants you have added and activated.
* Referral Link - Copy and share your unique Referral Link with your clients or merchants for sign up and activation.
* Partner Logo - Use the Cashfree Affiliate Partner badge on your website or marketing assets visible to your clients or merchants.
### Merchants
The **Merchants** section in the Affiliate Partner Dashboard allows you to efficiently onboard and manage referred merchants.
You can:
* **Add a single merchant** by entering:
* Business name
* Contact details (email address and phone number)
* Optional KYC information for faster verification
* **Bulk upload merchants** using a predefined file format to add multiple businesses at once. For more information, refer [
Onboarding](/partners/affiliates/refer-merchants#onboarding).
* **Track onboarding status** after submission:
* Merchants receive a verification email
* Status updates are shown on the Dashboard
For more information, refer [Track merchant status](/partners/affiliates/assist-merchant/merchants-kyc#track-merchant-status).
Use this section to monitor your referred merchants and support them through activation and KYC.
### PG Orders
The PG Orders screen gives you merchant-wise details about the PG transactions. Details available are:
* Merchant Name
* Transaction Count
* Transaction Amount
* Total Commission
By default, the report shows details for the last 7 days. You can filter and view the details as per your requirement. Click on a particular transaction to view more details about it.
### Commission
The Commission screen gives you details of all the commissions you have earned month-wise. The volume of transactions made, the total transaction amount, and the commission you have earned will be displayed on this screen. The commission amount will be settled in your account month-wise. For more information, refer [Commissions and Invoices](/partners/affiliates/partner-commissions-and-invoices).
# FAQs
Source: https://www.cashfree.com/docs/partners/affiliates/faqs
The Cashfree Payments Affiliate Program is a referral program through which you can offer the Cashfree Payments product suite to your clients or customers and get rewarded. You can simplify the payments experience for your customers and earn a commission for every transaction your customer makes.
Becoming an affiliate enables you to provide a seamless onboarding experience for your customers and offer them a complete suite of payment solutions for all their payment needs.
Visit the Cashfree Payments website and signup for our affiliate program. After you complete the signup process you will get access to the Affiliate Dashboard. You can add merchants, keep a check on your commissions, get a snapshot of your business with Cashfree, and more within the Affiliate Dashboard.
After you complete the sign-up process, you must activate your account and send us the scanned copies of the documents for KYC verification.
Any individual, proprietary firm, partnership firm (including LLP) or private limited company, that requires an online payment solution for their clients, can register with Cashfree as an Affiliate.
You need to complete KYC to activate your account. Follow the above steps to activate your account. In case you are not able to contact to Cashfree team on call, you can contact us at [partner@cashfree.com](mailto:partner@cashfree.com) or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) We would be happy to assist.
Offer payment solutions to your customers for all the payment issues on a single platform - Payment Gateway, Easy Split, Payment Links, Subscriptions, Payouts, Verification Suite (Bank Accounts, IFSC, UPI VPA, PAN), and more.
**Earn Rewards**: You get commissions for every transaction your customers make. There are two types of commission structures - flat rate and percentage of the transaction value.
**Powerful Dashboard**: A separate dashboard to add and manage all your customers. Get detailed reports about transactions, the value of transactions made, commission amount, and more.
**Extensive Affiliate Support**: Dedicated support to solve all your integration queries.
**Multi-Currency Support**: More than 100+ currency types are supported.
You can refer merchants using one of the following ways below:
* **Refer merchants using the Cashfree Affiliate Partner badge**
1. Go to **[Affiliate Dashboard](https://www.cashfree.com/affiliate-program/)** > **Summary**.
2. Click **Copy Code** in the **Affiliate Logo**section. Add this code to your website or application.
* **Refer merchants using Cashfree Affiliate Referral Links**
1. Go to **[Affiliate Dashboard](https://www.cashfree.com/affiliate-program/)** > **Summary**.
2. Copy the referral link in the **Referral Link** section. Share your unique Affiliate Referral Link with your clients. Once your merchants' signup using the referral link, they will be added as your referred merchant on the dashboard.
* **[Add merchants directly on your affiliate dashboard- single upload](/partners/embedded/add-merchants#adding-merchant-from-dashboard)**
* **[Add merchants directly on your affiliate dashboard- bulk upload](/partners/embedded/add-merchants#add-merchants-using-batch-upload)**
Click forgot password on the login screen and enter the email address. A new password generation link will be sent to your email address.
After you add the merchant details, Cashfree will notify the merchant to accept the invite and verify their email ID. The merchant must submit the business details and upload the required documents.
If the merchants did not verify their email ID, you can resend the verification email to them by clicking **Resend verification email**. To make the merchant onboarding faster, you can also submit business details of your merchants and upload the required documents on your merchants' behalf by following the steps below:
1. Click the ‘**Activate**’ option shown for your merchant entries in the Affiliate dashboard.
2. You would be directed to the merchant account activation page where you can fill in all required business details of your referred merchant and upload their business documents.
Activate option will be shown only for merchants who have verified their email addresses.
If the merchants did not verify their email ID, you can resend the verification email to them by clicking **Resend Email**.
1. Go to **Affiliate Dashboard** > **Merchants**.
2. Check the status of your referred merchants. You will see the below statuses:\
**Resend Email**: Merchants has not verified the email address, you can click here to resend the email address\
**Activate**: The merchant has not uploaded the documents, you can click here to activate the merchant\
**Activated**: The merchant account is active now, the merchant can now start transacting via Cashfree Payments.
To track payment gateway transactions by your merchants, navigate to **PG Orders** on the left panel. You can view the number of transactions, total transaction amount, and commission earned by you on those transactions for every merchant
Similarly, you can navigate to **Payouts Transfers** on the left panel to keep track of all transfers made by your merchants using Cashfree Payouts and check the total commission earned on the transactions.
Both Payment Gateway and Payout transactions will reflect on the dashboard after 24 hours of initiating the transactions.
The commission is earned when any PG or payout transaction is done by your referred merchants via Cashfree.
In the case of Payment Gateway collections, when any customer makes a transaction on your referred merchant’s website/app and the amount is settled to Cashfree, the commission on that transaction is reflected on your Affiliate dashboard.
In the case of Payout disbursals, when your referred merchant makes a payout for vendor payments, processing refunds or disbursing loans etc., using Cashfree, the commission on that transaction is reflected on your Affiliate dashboard.
1. Go to **Affiliate Dashboard** > **Summary** to check total daily transactions and daily transaction volume
2. To track payment gateway transactions by your merchants, go to PG Orders on the left panel. You would be able to view the number of transactions, total transaction amount and commission earned by you on those transactions for every merchant
3. Similarly, you can navigate to ‘Payouts transfer’ on the left panel to keep track of all transfers made by your merchants using Cashfree Payouts, and check the total commission earned on the transactions
4. You can also keep a track of the total commission earned on transactions for a particular period by navigating to ‘Commissions’.
Refer to [Commissions and Invoices](/partners/embedded/commissions-and-invoices) section
Refer to [Commissions and Invoices](/partners/embedded/commissions-and-invoices) section
You will be able to claim your commission only if your Affiliate KYC is complete and the commission structure is configured on your Cashfree Affiliate account.
In case the commission structure is not configured on your Affiliate account, please reach out to [partnership.support@cashfree.com](mailto:partnership.support@cashfree.com).
# Marketing Kit
Source: https://www.cashfree.com/docs/partners/affiliates/marketing-kit
As a Cashfree Affiliate Partner, you have access to marketing resources that help you promote Cashfree Payments to your clients and network. Use these collaterals to explain features, build trust, and onboard more merchants.
Available resources:
| **Title** | **Description** | **Resource** |
| ------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------- |
| Payment Gateway brochure | Help businesses understand and adopt a leading digital payment solution. | [View / Download](https://bit.ly/marketing_affiliate_1) |
# Overview
Source: https://www.cashfree.com/docs/partners/affiliates/overview
The Cashfree Payments Affiliate Program is a referral initiative that allows you to promote Cashfree products to your clients or customers and earn rewards. Help your customers streamline their payment experience while you earn a commission on every transaction they complete.
As an affiliate, you can offer referred businesses access to a complete suite of payment solutions.
## Key features
Sign up and get started with the affiliate program.
Share referral links and send merchant invitations.
Track referrals, commissions, and performance metrics.
Manage earnings and download commission invoices.
Access promotional materials and marketing resources.
Help merchants with KYC and payment integration.
### Benefits of the affiliate program
* **All-in-one payment platform**\
Provide your clients with a wide range of online payment options, including:
* Payment gateway (UPI, credit card, debit card, Buy Now Pay Later, net banking, and more)
* Payment links and forms
* Additional payment tools
* **Earn industry best rewards**\
Receive commission on every transaction completed by your referred customers.
* **Quick merchant onboarding**\
Help your clients get started instantly with 100% paperless onboarding.
* **Affiliate Partner Dashboard**\
Use a dedicated dashboard to manage referrals, track transactions, view commission earnings, and monitor performance.
* **Support for international payments**\
Accept payments in over 100 currencies from customers around the world.
### Who can join?
Any registered business or individual can join the affiliate program, including:
* **Web and app developers, freelancers, and agencies**\
Recommend Cashfree Payments and earn commissions on transactions.
* **Coworking spaces, accelerators, and incubators**\
Offer built-in payment solutions to startups in your network.
* **Associations and ecosystem enablers**\
Equip your community with full-stack payment processing solutions.
* **Influencers and bloggers**\
Promote Cashfree Payments to your audience and earn passive income.
# Partner Earnings Guide
Source: https://www.cashfree.com/docs/partners/affiliates/partner-commissions-and-invoices
Become a Cashfree Affiliate, offer payment solutions to your merchants, and earn a commission for every transaction your customers make.
## Commissions
As a **Cashfree Affiliate Partner**, you offer payment solutions to your merchants and earn a commission on each transaction they make. You can view your commissions in the **Partner Dashboard**. To receive your monthly payout, you need to create and submit an invoice through the dashboard.
### How Cashfree calculates commissions?
Cashfree calculates your commission based on the difference between the merchant pricing and the partner pricing. Here are some key terms:
* **Merchant pricing**: The fee Cashfree charges the merchant for each transaction. This is either a percentage of the transaction amount or a flat fee.
* **Partner pricing**: The fee defined for you during onboarding, based on the merchant’s pricing.
* **Partner commission**: The difference between the merchant pricing and the partner pricing. This is what you earn per transaction.
Refer to the sample scenario below:
You refer an e-commerce merchant, **ABC Ltd.** The following pricing applies:
* **Merchant pricing for UPI**: 1.95%
* **Partner pricing for UPI**: 1.70%
* **Commission earned**: 1.95% – 1.70% = 0.25%
For a single transaction of ₹10,000:
* **Transaction amount**: ₹10,000
* **Fee charged to the merchant**: 1.95% × ₹10,000 = ₹195
* **Your commission**: 0.25% × ₹10,000 = ₹25
If ABC Ltd. processes 100 such transactions in a month, you earn:\
₹25 × 100 = ₹2,500
**Notes**:
* Commission rates vary based on the merchant and partner pricing agreed upon during onboarding.
* The system aggregates commissions monthly and displays them in the **Partner Dashboard**.
### View commissions
You can track all your commissions from the affiliate dashboard.
1. Login to your dashboard using your credentials. Select **Commission** to view the total commission earned on transactions for a particular period.
2. To track payment gateway transactions by your merchants, select **PG Orders** in the navigation section on the left. You can view the number of transactions, total transaction amount, and commission earned by you on those transactions for every merchant.
### Commission for GST registered and unregistered affiliates
If you are GST registered and shared the GSTIN details with Cashfree Payments, you will see the GST component in the **Commission** section. This information is not visible to the unregistered affiliates.
All GST-registered affiliates must share their GSTIN with Cashfree Payments as per compliance requirements. Please update your GST details via the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
### Receive commission amount
Cashfree generates and displays commissions every month. You see the commission for the previous month by the 5th of the current month. To start the settlement process, you create an invoice.
#### Eligibility requirements
You receive a commission if:
* You have at least two transacting merchants in the month.
* Your Partner KYC is complete.
* Your commission amount is more than ₹1.
If you meet all the requirements but don’t receive your commission, raise a ticket through the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
## Invoices
To receive the commission amount for the previous months: you must create an invoice, specify the mandatory details, and upload the invoice.
To raise an invoice,
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Select **Commission** > **Invoice**.
3. Click **Add Invoice**.
3. Select the months for which you want to create an invoice.
4. If you use an accounting system and want to upload an invoice using the same system, you can click **Upload Invoice**. Ensure your company's GSTIN and Cashfree Payments GSTIN are specified in the invoice.\
Alternatively, you can click **Generate Invoice** if you need help with creating the invoice. Cashfree Payments automatically creates an invoice. You can enter the mandatory details and send the invoice.
5. Upload or generate the invoice and enter the mandatory details. Click **Approve and Send Invoice** to send the invoice to Cashfree Payments for further processing of the commission amount.
### Invoice statuses
| Status | Description |
| :----------------- | :--------------------------------------------------------------------------------------- |
| Under Review | The invoice status is yet to be verified by Cashfree Payments. |
| Approved | The invoice is verified and approved for processing the commission amount. |
| Payout in Progress | The commission amount is initiated for payout by Cashfree Payments. |
| Paid | The commission amount is settled in your bank account registered with Cashfree Payments. |
| Rejected | The invoice is rejected by Cashfree Payments. |
# Refer and Onboard Merchants
Source: https://www.cashfree.com/docs/partners/affiliates/refer-merchants
As a Cashfree Affiliate Partner, you can refer businesses to use Cashfree Payments. You can also help them with KYC verification and integration to simplify onboarding.
After you sign in to your Affiliate Partner Dashboard, you can refer merchants in the following ways:
* [Share your referral link](/partners/affiliates/refer-merchants#share-a-referral-link): Copy and share your unique referral link through email, messaging apps, or social media.
* [Send an email invitation](/partners/affiliates/refer-merchants#send-an-email-invitation): Add the merchant’s details and send an invitation directly to their email address.
## Share a referral link
To share your referral link:
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Go to the **Summary** page in your dashboard.
3. Copy your unique **Referral Link** and share it with merchants or clients via **WhatsApp**, **Instagram**, or other channels.
## Send an email invitation
To add a merchant via an email invitation:
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Go to the **Affiliate Dashboard** > **Merchants** > **All** and click **Add Merchant**.
3. On the Add a New Merchant screen, under Basic Details, fill in the merchant's information:
* Merchant Name
* Merchant ID (Optional)
* Email Address
* Mobile Number
* Accept the terms and conditions.
3. Click **Add Merchant & Exit** or click **Proceed** to enable faster onboarding and KYC verification by submitting the merchant's basic KYC details.
**Business Details (Optional)**:
* Business Type
* Business Model
* Business PAN Details
* Bank Account Details
* Business Category and subcategory
* Website and application link
* Authorised signatory PAN details
* Name as per Authorized Signatory PAN
* GSTIN
4. Click **Add Merchant**.
A verification email will be sent to the merchant, and the onboarding status will be updated after successful verification.
If your merchant hasn't received the email, click the **Resend Email** option
in the **Merchants** screen to resend the verification email to the merchant.
## Bulk referral
To onboard multiple merchants at once, upload their details using a file in the format specified by Cashfree Payments.
**To upload merchant details in bulk:**
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Go to **Merchants**, and then select **Bulk upload merchants**.
3. Select **Upload File**, and choose the file you want to upload.\
Ensure the following mandatory fields are filled:
* Business Name
* Registered Email
* Phone Number
* Merchant ID
You can also include optional fields such as business details, PAN, and bank account details for KYC verification.
4. After upload, the system displays a summary of:
* Total merchants added
* Valid and invalid entries
* Upload status
You can download the file, correct any errors, and re-upload it.
[Download sample upload file](https://cashfreepublic.s3.ap-south-1.amazonaws.com/payoutsample/Bulk-Upload-Format.csv)
**Note**:
* Help merchants get started by assisting with their KYC process. For more information, refer [Merchants KYC](/partners/affiliates/assist-merchant/merchants-kyc).
* After payment activation, guide merchants in selecting business-friendly solutions to integrate and accept payments. For more information, refer [Merchants Integration](/partners/affiliates/assist-merchant/merchants-integration).
# Adding Merchants with Embedded Payments
Source: https://www.cashfree.com/docs/partners/embedded/add-merchants
## Overview
As part of Embedded Payments offerings, you can add and onboard your businesses as Merchants and manage their Cashfree accounts. After the account is activated, you can manage their transactions within your platform. You can add a merchant from the Embedded Payments Dashboard or using our APIs. The Merchant homepage has the following options:
* Merchant Name
* Merchant Email
* Merchant Added On Time
* Merchant Onboarding Status
* Min KYC Status
* Dashboard Access
* Action
## Adding merchant from dashboard
To add a merchant,
1. Go to the **Embedded Payments Dashboard** > **Merchants** > **Add Merchant**.
2. In the **Add New Merchant** screen, enter the merchant **Business Name**, **Registered Email**, **Phone Number**, and **Merchant ID**. Merchant ID is a unique alphanumeric identifier for the merchants. It will be auto-generated if not provided. The maximum number of characters allowed is 40. (Hyphen and underscore allowed.)
3. For faster onboarding and KYC verification, you can submit the merchants' basic KYC details.
**Details Required (Optional)**:
* Business Type
* Business Model
* Business PAN Details
* Bank Account Details
* Business Category and subcategory
* Website and application link
* Authorised signatory PAN details
* Name as per Authorized Signatory PAN
* GSTIN
4. Accept the terms and conditions, and click **Submit**.
A verification email will be sent to the merchant, and the onboarding status will be updated after successful verification.
## Add merchants using batch upload
To onboard many merchants at once, you can add all the details in a file (format specified by Cashfree Payments) and upload it.
To bulk upload merchant details,
1. Go to the **Embedded Payments Dashboard** > **Merchants** > click **Bulk upload merchants**.
2. Click **Upload File** and choose the file you want to upload. Ensure all the details are provided as per the sample file. Fill in the mandatory fields - Business Name, Registered Email, Phone Number, and Merchant ID.\
You can also specify the business details, PAN, and bank account details of the merchants for KYC verification, if required.
3. Details like the number of merchants added to the file, how many are valid/invalid, and the status of the uploaded file will be displayed after the file is successfully uploaded. You can download the file and correct any errors in the file and upload it again.
Sample file is available here.
## Add merchant using APIs
You can add a merchant using our APIs. Use these APIs to create a merchant and onboard merchants from your platform. There are other actions you can do with these APIs such as:
* Updating merchant details
* Fetching the merchant onboarding status
* Creating onboarding link
### List of merchant APIs
| API Name | Description |
| :------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------- |
| [Create Merchant](/api-reference/platforms/latest/merchant-onboarding/create-merchant) | Use this API to create a new merchant account. |
| [Update Merchant](/api-reference/platforms/latest/merchant-onboarding/update-merchant) | Use this API to update the merchant details. |
| [Get Merchant Status](/api-reference/platforms/latest/merchant-onboarding/update-merchant) | Use this API to view merchant details. |
| [Create Onboarding Link](/api-reference/platforms/latest/merchant-onboarding/create-embeddable-onboarding-link-does-not-require-login) | Use this API to create a new onboarding link. |
Listen to merchant activation events using [Merchant Onboarding Webhooks](api-reference/platforms/latest/merchant-onboarding/webhooks).
If your merchant hasn't received the email, click the **Resend Email** option in the **Merchants** screen to resend the verification email to the merchant.
## Activation lifecycle
#### Onboarding status
**Pending Email Verification**: The Merchant must first verify their registered email address. An email is sent automatically from Cashfree Payments (from [care@cashfreemail.com](mailto:care@cashfreemail.com)) to the merchant email ID you specified when you added the merchant details.\
If the merchant hasn't received the email in their Primary inbox, please ask them to check it in the Spam folder. If the merchant has not received the email you can use the Resend Email email to send the verification email again.
**Email Verified**: This means that Merchant has verified their email address, and can now start their KYC verification process.
#### Product KYC status
* **Min KYC Pending**: Merchant must submit the required KYC details and documents.
* **Min KYC Submitted**: Merchant has submitted their KYC details and documents and the documents are being reviewed by Cashfree Payments
* **Min KYC Rejected**: Merchant KYC has discrepancies and corresponding KYC details and documents need to be provided.
* **Min KYC Approved**: Merchant KYC has been approved and **Payment Gateway** product is activated.
If your merchants have verified their email you can fill out the KYC on behalf
of your merchant and activate the account for your merchants.
# Commissions and Invoices
Source: https://www.cashfree.com/docs/partners/embedded/commissions-and-invoices
## Commissions
### How does it work?
For Payment Gateway collections: your commission reflects on your partner dashboard when a customer makes a transaction on your referred merchant’s website/app and the amount is settled to Cashfree Payments.
### Calculate commissions
Commissions are calculated in two ways:
* Flat rate
* Percentage of the transaction amount
**Commission as a flat rate**\
Flat rate pricing involves charging a fixed rate for a transaction. It does not alter or fluctuate regardless of the transaction amount.
For example, let us say you are an e-commerce automation platform, and you help e-commerce businesses in converting COD orders to pre-paid. You have offered Cashfree's Payment Gateway to one of your clients, ABC Ltd., at a markup of ₹100 over Cashfree's base rate of 3% (the minimum amount that goes to Cashfree Payments). Here is the calculation for the transaction that ABC Ltd. collected ₹10,000 using Cashfree Payments.
| Transaction Amount (A) | Cashfree's Charge (Base rate) (B) | Your Markup (C) | GST (D) | Total Amount Paid by your Client |
| :--------------------- | :-------------------------------- | :-------------- | :------------------- | :------------------------------- |
| ₹10,000 | 3% (10,000\*3%) = ₹300 | ₹100 | (300+100)\*18% = ₹72 | B+C+D = ₹472 |
**Commission as a percentage of the transaction amount**\
Percentage pricing involves charging a specific percentage for a transaction.
For example, let us say you have offered Cashfree’s payment gateway to ABC Ltd. at a markup of 1% instead of INR 100 over Cashfree’s base rate of 3% (the minimum amount that goes to Cashfree Payments).
| Transaction Amount (A) | Cashfree's Charge (Base rate) (B) | Your Markup (C) | GST (D) | Total Amount Paid by your Client |
| :--------------------- | :-------------------------------- | :--------------------- | :------------------- | :------------------------------- |
| ₹10,000 | 3% (10,000\*3%) = ₹300 | 1% (10,000\*1%) = ₹100 | (300+100)\*18% = ₹72 | B+C+D = ₹472 |
### View commissions
You can track all your commissions from the embedded payments dashboard.
1. Login to your dashboard using your credentials. Select **Commission** to view the total commission earned on transactions for a particular period.
2. To track payment gateway transactions by your merchants, select **PG Orders** in the navigation section on the left. You can view the number of transactions, total transaction amount, and commission earned by you on those transactions for every merchant.
### Commission for GST registered and unregistered partners
If you are GST registered and shared the GSTIN details with Cashfree Payments, you will see the GST component in the **Commission** section. This information is not visible to the unregistered partnerss.
All GST-registered partners must share their GSTIN with Cashfree Payments as per compliance requirements. Fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) to update your GST details.
### Receive commission amount
To initiate your commission settlement process for the previous month, you must create an invoice. Click [here](doc:partner-invoices) for more information on how to create an invoice.
To claim your commission, ensure Partner KYC is complete, and the commission
structure is configured on your Cashfree Payments Partner account. If the
commission structure is not configured on your Partner account, write to
[partnership.support@cashfree.com](mailto:partnership.support@cashfree.com).
This process is applicable for invoices from September 2022 onwards.
## Invoices
To receive the commission amount for the previous months: you must create an invoice, specify the mandatory details, and upload the invoice.
To raise an invoice,
1. Login to the partner dashboard using your credentials. Select **Commission** > **Invoice**.
2. Click **Add Invoice**.
3. Select the months for which you want to create an invoice.
4. If you use an accounting system and want to upload an invoice using the same system, you can click **Upload Invoice**. Ensure your company's GSTIN and Cashfree Payments GSTIN are specified in the invoice.\
Alternatively, you can click **Generate Invoice** if you need help with creating the invoice. Cashfree Payments automatically creates an invoice. You can enter the mandatory details and send the invoice.
5. Upload or generate the invoice and enter the mandatory details. Click **Approve and Send Invoice** to send the invoice to Cashfree Payments for further processing of the commission amount.
### Invoice statuses
| Status | Description |
| :----------------- | :--------------------------------------------------------------------------------------- |
| Under Review | The invoice status is yet to be verified by Cashfree Payments. |
| Approved | The invoice is verified and approved for processing the commission amount. |
| Payout in Progress | The commission amount is initiated for payout by Cashfree Payments. |
| Paid | The commission amount is settled in your bank account registered with Cashfree Payments. |
| Rejected | The invoice is rejected by Cashfree Payments. |
# Embedded Payments Dashboard
Source: https://www.cashfree.com/docs/partners/embedded/dashboard
## Summary
The **Summary** screen gives you details about your daily transactions, like the current-day transaction count, the value of the transactions made by your merchants, and the last commission amount you received from Cashfree Payments as per the referral program.
The following details are available on this page:
* Number of Transactions Today - Total number of PG and Payout transactions done by your merchants.
* Value of Today's Transactions - Total value of PG and Payout transactions done by your merchants today.
* Last Commission Amount - The last month's commission amount to be settled to your bank account.
* Merchant Stats - Number of merchants you have added and activated.
* Referral Link - Send this to your merchants for signing up.
* Partner Logo - To showcase that you are Cashfree Verified Affiliate Partner, a partner logo is available on the Summary screen. Copy and Download the Logo.
* PG Transaction Value
* Payouts Count
* Commission Summary
## PG orders
The PG Orders screen gives you merchant-wise details about the PG transactions. Details available are:
* Merchant Name
* Transaction Count
* Transaction Amount
* Total Commission
By default, the report shows details for the last 7 days. You can filter and view the details as per your requirement. Click on a particular transaction to view more details about it.
## Payout transfer
The Payout Transfer screen gives you details about the payout transactions done by your merchants. Details available are:
* Merchant Name
* Transfer Count
* Transfer Amount
* Total Commission
Click on a particular payout transaction to view more details about it.
## Developers
The developers section contains resources for developers to build and monitor their integration of APIs into their platform. This section shows the API keys, Webhooks, and Onboarding Webhooks.
### API keys
You can view the API keys and the time it was generated. You can also reset the API keys using the **Reset API key** option.
### Webhook
Add and define webhooks for individual events and get notified for each action on the URLs configured.
#### Add webhook endpoint
To add a new webhook,
1. Go to **Embedded Payment Dashboard** > **Developers**.
2. Click **Add Webhook Endpoint** to create a new webhook. Enter the endpoint URL and select the required action events and click **Add Webhook**.
1. Click the pencil icon beside each webhook to update the webhook. Edit the webhook URL, add/remove events from the list and click **Update Webhook**.
#### Onboarding webhook
Add onboarding webhooks to build webhooks for your partners so that you can get the merchant lifecycle webhook events.
To Add Onboarding Webhook,
1. Go to **Embedded Payment Dashboard** > **Developers**.
2. Click **Add Webhook URL** to create a new webhook. Enter the endpoint URL and click **Add Webhook**.
## Reports
Now generate various reports from the Embedded Payments Dashboard. The Reports homepage has the following options:
* Report Type
* Report Name
* Merchants Count (Click on it to view the merchant names)
* Report Size
* Generated At
* Download Report
* Delete Report
The following are the report types available in Embedded Payments:
* Transaction
* Settlement
* Refund
* Dispute
To generate a report,
1. Go to **Embedded Payment Dashboard** > **Reports**. Choose the required report from the **Report Type** drop-down and click **Generate Report**. You can also apply filter and view reports as per your requirement.
To view the merchant's list, click the number available on the corresponding merchant.
# Get Started with Embedded Payments
Source: https://www.cashfree.com/docs/partners/embedded/get-started
Signup for Embedded Payments to get started with the product. After you complete the signup and activation process, you will get access to the Embedded Payments Partner Dashboard. You can add merchants, integrate our Payment Gateway solution, keep a check on your commissions, get a snapshot of your business with Cashfree, and more within the Embedded Payments Dashboard.
## Signup for embedded payments
To use Embedded Payments, you must first create an Embedded Payments Partner account with Cashfree.
1. Go to the Embedded Payments [sign up page](https://partner.cashfree.com/partner-ui/authentication/signup?product=embedded).
2. In the **Create Account** screen, enter your Business Information and create a password for your account.
3. Click **Signup**.
4. You can [login](https://partner.cashfree.com/partner-ui/authentication/login) to the Embedded Payments Dashboard using the same credentials.
## Activate embedded payments account
After you complete the signup process, you will receive a welcome email from Cashfree Payments. To complete the activation of your account, you have to send us the documents listed below to complete the KYC for your account. We will verify all the details and enable your account within 48 hours of submitting all documents.
You can Login to your Embedded Payments Dashboard with the email ID and password entered during sign-up and explore your Embedded Payments Dashboard.
If you face any issues or need further support you can contact us at **[Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)**.
### Documents required for KYC verification
**Business Details**
* Website URL
* Official email ID
* Official contact name and phone number
* Bank account details - name, account number, and IFSC
| For Proprietorship | For Partnership/LLP | For Private Ltd./Public Ltd. Entities |
| :------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------- | :---------------------------------------------------------------- |
| Business registration proof (GST certificate/Shop act licence/labour licence/ MSME certificate/Trade license) | Business reg. proof (Partnership Deed/ LLP COI) | Certificate of Incorporation |
| Proprietor's PAN card | Business PAN card | Business PAN card |
| Proprietor's address proof (DL/Voter ID/Passport) | Authorized signatory PAN card | Authorized signatory/director's PAN card |
| Cancelled cheque or bank statement | Authorized signatory - address proof (DL/Voter ID/Passport) | Authorized signatory - address proof (DL/Voter ID/Passport) |
| | Cancelled cheque or bank statement | Cancelled cheque or bank statement |
| | | Memorandum of Association (MOA) and Articles of Association (AOA) |
Commissions will be enabled only after completing KYC verification for your
account. Please ensure you share the required documents on time.
# Embedded Payment Gateway Integration
Source: https://www.cashfree.com/docs/partners/embedded/integration/gateway-integration
Cashfree Payment Gateway accepts domestic and international payments, and supports a wide range of payment options. Integrate Embedded Payment Gateway to easily enable your businesses to collect payments from their customers. Use our pre-built checkout integration, or customise the payment flow as per your requirements. You can also use our SDKs to easily integrate your mobile applications with our gateway. You can easily collect payments using popular Payment Methods like Cards, UPI, Netbanking, Wallets, PayPal, EMI, and Pay Later options.
You can build and try out the integration in the sandbox environment. Click [here](/partners/embedded/integration/gateway-sandbox-environment) to know more.
## Partner API keys
To get started with Partner API requests, you must first generate partner API keys from your [Partner Dashboard](https://partner.cashfree.com/partner-ui/authentication/login).
1. Go to **Partner Dashboard** > **Developers** section.
2. In the **Developers** Section, click **Generate API Key**.
3. Copy and download the API keys for all API requests and future reference.
## Payment gateway APIs
All the Payment Gateway APIs that you find in [this](/api-reference/payments/latest/overview) document can be used using partner authentication for your merchants.
### Partner authentication
To use Payment Gateway APIs for Partner Auth integration, **x-client-id** and **x-client-secret** headers will not be used anymore, please use the following headers:
* **x-partner-apikey**: This is the common API Key generated and unique for each Partner.
* **x-partner-merchantid**: This is the unique merchant ID for each merchant associated with the Partner. To know the merchant ID, go to **Partner Dashboard** > **Merchants** section, and copy the **Merchant ID** of the merchant you want to transact with.
### Payment Gateway SDKs
We support the following SDK integrations:
| Integration Types |
| :--------------------------------------------------------------- |
| [JS Integration](/payments/online/element/overview) |
| [Web Integration](/payments/online/web/redirect) |
| [Android Integration](/payments/online/mobile/android) |
| [iOS Integration](/payments/online/mobile/ios) |
| [React Native Integration](/payments/online/mobile/react-native) |
| [Cordova Integration](/payments/online/mobile/cordova) |
| [Flutter Integration](/payments/online/mobile/flutter) |
## Partner webhooks
To configure partner webhook,
1. Go to **Partner Dashboard** > **Developers** > **Webhooks**.
2. Click **Add Webhook URL** and enter the URL where you want to receive the updates.
3. Select the events for which you want to configure the webhooks to receive updates, and click **Add Webhook**.
4. Your webhook is now added successfully. You can also edit the added webhook using the edit option from the Webhook homepage.
Notifications will be sent to your configured endpoint as a POST request with the body containing the various parameters specifying the details of each event. Each request contains an event parameter that identifies its type.
We support webhooks in both encoded and JSON formats.
### How to use Cashfree Payments webhooks?
### 1. Create an endpoint URL
To receive event notifications, you need to create an endpoint in your server that can accept requests from Cashfree Payments. The endpoint URL can be HTTP in your local machine for testing purposes while developing. However, it should be HTTPS for the production environment.\
You receive webhook event notifications on the specified URLs. You can use one URL to handle different event types at once or specify individual URLs for specific events.
### 2. Select events to subscribe
You can configure webhooks to receive notifications for the following events:
* [Payment Success](/api-reference/payments/latest/payments/webhooks#payment-success-webhook)
* [User Dropped](/api-reference/payments/latest/payments/webhooks#payment-user-dropped-webhook)
* [Payment Failed](/api-reference/payments/latest/payments/webhooks#payment-failed-webhook)
* [Refunds](/api-reference/payments/latest/refunds/webhooks#refund-webhooks)
* [Settlement Webhooks](/payments/split/webhooks#settlement-webhook)
An additional object **merchant** is sent in partner webhook payload to
identify the merchants.
```json json theme={"dark"}
{
"merchant": {
"merchant_id": {{merchant identifier}}
},
"data": {
...
},
"event_time": ...,
"type": ...
}
```
### 3. Test webhooks
Test your webhooks in the sandbox environment before going live to check payloads and integration. Configuring your webhooks, from the dashboard, in the test environment and events triggered in test transactions will send webhooks to the configured endpoint.
You can create endpoint URLs and test webhooks using tools like [webhook.site](https://webhook.site) or create a tunnel to your localhost using tools like [ngrok](https://ngrok.com).
### 4. Verify webhooks
It's a best practice to verify webhooks so that your server isn't manipulated by other requests acting as Cashfree webhooks. Use webhook signatures to verify Cashfree Payments webhooks and perform further actions only after verifying the webhook.
#### Webhook signature
Use the signature to verify if the request hasn't been tampered with. To verify the signature at your end, you need your Cashfree Payment Gateway secret key along with the payload.
* The timestamp is present in the header `x-webhook-timestamp`.
* The actual signature is present in the header `x-webhook-signature`.
The signature creation logic is as below:
```text Signature theme={"dark"}
timestamp := 1617695238078;
signedPayload := $timestamp.$payload;
expectedSignature := Base64Encode(HMACSHA256($signedPayload, $partnerApiKey));
```
Click [here](/payments/online/webhooks/overview#manual-verification-custom-approach) to check the sample codes.
Use **\$partnerApiKey** instead of **\$merchantSecretKey** to verify the webhooks.
Sometimes you may receive the same webhook more than once. It's recommended to ensure that your implementation of the webhook is idempotent. Also, your endpoint should return a 2xx response for a successful webhook delivery from our end. Please ensure the response is quick before performing other logic, which could cause a timeout.
# Sandbox Environment for Embedded Payments Partners
Source: https://www.cashfree.com/docs/partners/embedded/integration/gateway-sandbox-environment
Build and safely test your Embedded Payment Gateway Integration in our Sandbox ('Test') Environment developed exclusively for Embedded Payments Partners. Our aim is to streamline the integration process for developers seeking to incorporate our Payments and/or Onboarding APIs and Webhooks into their software platforms.
This dedicated testing environment is crafted to cater to the needs of developers, providing them with a robust space to experiment, simulate, and seamlessly code our development solutions within their platforms. With our Sandbox Environment, developers can confidently test and refine their integrations, ensuring a smooth and efficient implementation of our APIs and Webhooks.
## Advantages
* **Safe Testing**: You can conduct thorough testing without affecting real transactions. This safeguards your live environment while refining payment flows.
* **Realistic Simulations**: You can mimic real-world scenarios with our realistic simulations. You can as well test various payment methods, edge cases, and user interactions effortlessly.
* **Enhanced Debugging**: You can diagnose and troubleshoot issues effectively with detailed error reporting. Identify and resolve potential challenges before you impact your live users.
## How to simulate working environment in sandbox?
To begin with, login to your **Partner Dashboard** > and click the **Switch to Test** option. The dashboard will switch to the Test Environment (sandbox). There will be a visible label at the top to let you identify that you are in the Test Environment.
When you are in the test environment, the "Switch to Test" button will change to “Switch to Prod”. You can use it to switch back to the live environment.
While operating within the test environment, you have the capability to simulate essential features of the payment gateway. This empowers you to replicate and test the necessary functionalities vital for the seamless operation of the payment gateway system.
You can add new merchants from the Merchants section through the **Add Merchant** option. The added merchant will be enabled in test environment with payment gateway activated and default pricing.
Only Business Name, Registered Email and Phone Number are mandatory when adding a merchant in the test environment. You can then select the checkbox "I agree to the terms and conditions" and submit the form.
This activation takes upto 5 mins. Refresh the Merchants tab to recheck the activation status.
Please note that KYC is required for activating merchants in the live environment.
You can access the **Developers** tab, and generate Partner API Key and configure Partner Webhooks as well. Once done, you can follow integration steps mentioned in the [Embedded Payment Gateway Integration guide](/partners/embedded/integration/gateway-integration).
Sample request to **Create an Order** -
```Text curl theme={"dark"}
curl --location 'https://sandbox.cashfree.com/pg/orders' \
--header 'x-partner-apikey: {{partnerAPIKey}}' \
--header 'x-partner-merchantid: {{partnermerchantId}}'
--header 'x-api-version: 2022-09-01' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"order_amount": "10",
"order_currency": "INR",
"customer_details": {
"customer_id": "USER123",
"customer_name": "joe",
"customer_email": "joe.s@cashfree.com",
"customer_phone": "+919876543210"
},
"order_meta": {
"return_url": "https://b8af79f41056.eu.ngrok.io?order_id={order_id}",
"notify_url": "https://b8af79f41056.eu.ngrok.io/webhook.php",
}
}'
```
Sample request to **Get Order** details -
```Text curl theme={"dark"}
curl --request GET \
--url https://sandbox.cashfree.com/pg/orders/{{order_id}}\
--header 'x-partner-apikey: {{partnerAPIKey}}' \
--header 'x-partner-merchantid: {{partnermerchantId}}'
--header 'accept: application/json' \
--header 'x-api-version: 2022-09-01'
```
Apart from this, you can simulate payments using payments methods such as Card, UPI, and other payment modes that are part of the integration. Other features like Summary, PG Orders, Reports will also work in Test Environment
The data between Live and Test environments is completely isolated. Any data changes (eg. merchant addition, order creation etc.) in this environment will not happen in Live, and vice versa. These are not live transactions, these are just simulations. No fund movement will occur.
## Partner webhooks
You can also configure webhooks in the test environment. To configure partner webhook,
1. Go to **Partner Dashboard** > **Developers** > **Webhooks**.
2. Click **Add Webhook URL** and enter the URL where you want to receive the updates.
3. Select the events for which you want to configure the webhooks to receive updates, and click **Add Webhook**.
Notifications will be sent to your configured endpoint as a POST request with the body containing the various parameters specifying the details of each event. Each request contains an event parameter that identifies its type.
We support webhooks in both encoded and JSON formats.
# Embedded Payments Overview
Source: https://www.cashfree.com/docs/partners/embedded/overview
Embedded Payments by Cashfree lets platforms enable direct, compliant payments between businesses and their customers, with seamless onboarding built in. Ideal for ERPs, SaaS, and software platforms embedding payments into their product.
## Key features
Onboard businesses with automated KYC and compliance checks.
Integrate payment processing with UPI, cards, and wallets.
Manage transactions, reporting, and payment analytics.
Track commission earnings with automated invoicing.
Access settlement, transaction, and reconciliation reports.
Test integrations in a complete sandbox environment.
**ERPs and SaaS**:
Embed payments in ERP and SaaS products across education, hospitality, POS, accounting, billing, and checkout systems.
**Platforms**:
Enable end-to-end payment flows inside e-commerce, CRM, and financial platforms.
## Advantages of embedded payments
Embedded Payments provides the following advantages:
* **Payment solutions**: Offer payment solutions to businesses on your platform, such as payment gateway, easy split, payment links, and subscriptions.
* **Onboarding businesses**: Use pre-built or custom flows to onboard businesses onto Cashfree.
* **Managing payments**: Provide businesses and their customers with the best payment experience using Cashfree's product suite.
* **Ensuring compliance**: Simplify compliance requirements across onboarding, KYC, payments, and post-payment journeys.
* **API-first product**: Use robust APIs to scale your platform and support more businesses without operational overhead.
* **Powerful dashboard**: Access a separate dashboard to add and manage businesses, view detailed transaction reports, and monitor commission amounts.
* **Unlocking new revenue**: Earn commissions for every transaction across onboarded businesses.
# Dispute Report
Source: https://www.cashfree.com/docs/partners/embedded/reports/dispute-reports
Through the dispute report, you can view the list of disputed transactions for the selected time period.
To view the dispute report,
1. Go to **Embedded Payment Gateway Dashboard** > **Reports**.
2. From the dropdown, select **Disputes** report and click on **Generate Report**.
3. Select the date range for which you want to view the report. You can also select the file format (csv or xlsx).
4. Click **Generate Report**. The report will be generated based on the criteria you have filtered. You can download the report after it has been generated.
# Ledger Report
Source: https://www.cashfree.com/docs/partners/embedded/reports/ledger-reports
The ledger report summarises all the debits and credits that have happened in your account for the selected time period and helps you in reconciliation. For each SETTLEMENT\_COMPUTE (Credit) entry in the ledger, you can view and reconcile the transaction level details in the settlement reconciliation report.
To view the ledger report,
1. Go to **Embedded Payment Gateway Dashboard** > **Reports**.
2. From the dropdown, select **Ledger** report and click on **Generate Report**.
3. Select the date range for which you want to view the report. You can also select the file format (csv or xlsx).
4. Click **Generate Report**. The report will be generated based on the criteria you have filtered. You can download the report after it has been generated.
# Refunds Report
Source: https://www.cashfree.com/docs/partners/embedded/reports/refunds-reports
The refunds report gives you details of all the refunds that are initiated in the selected time period. The report includes refund ID, order ID, transaction and refund amount, date, corresponding refund ID, ARN and more.
To view the refunds report,
1. Go to **Embedded Payment Gateway Dashboard** > **Reports**.
2. From the dropdown, select **Refunds** report and click on **Generate Report**.
3. Select the date range for which you want to view the report. You can also select the file format (csv or xlsx).
4. Click **Generate Report**. The report will be generated based on the criteria you have filtered. You can download the report after it has been generated.
# Overview
Source: https://www.cashfree.com/docs/partners/embedded/reports/reports
There are various reports that Cashfree supports. These reports help you to reconcile transactions, view adjustments and settlements, analyse your business transactions, and much more. You can view these reports day-wise, week-wise or for a custom date range. You also have the option to download the reports.
While generating a report, you can get consolidated reports across your merchants.
Embedded Payment Gateway reports include the following:
* [Transactions](/partners/embedded/reports/transaction-reports)
* [Settlements](/partners/embedded/reports/settlement-reports)
* [Refunds](/partners/embedded/reports/refunds-reports)
* [Disputes](/partners/embedded/reports/dispute-reports)
* [Settlement Recon](/partners/embedded/reports/settlement-recon-reports)
To map any report entry to the related merchant, we've introduced an additional column - Partner Merchant Reference ID in the respective reports. This ID is same as the Merchant ID in Merchants tab.
# Settlement Recon Report
Source: https://www.cashfree.com/docs/partners/embedded/reports/settlement-recon-reports
A new report **Settlement Recon** is available to help you with a faster reconciliation for all types of settlements for a selected date range. The Settlement Recon report provides the list of settlements received in the specified date range, along with detailed information about transactions, adjustments/refunds against transactions, disputes, and more, corresponding to the settlements received.
To generate the settlement recon report,
1. Go to **Embedded Payment Gateway Dashboard** > **Reports**.
2. From the dropdown, select **Settlement Recon** report and click on **Generate Report**.
3. Select the date range for which you want to view the report. You can also select the file format (csv or xlsx).
4. Click **Generate Report**. The report will be generated based on the criteria you have filtered. You can download the report after it has been generated.
# Settlement Reports
Source: https://www.cashfree.com/docs/partners/embedded/reports/settlement-reports
Through the settlement reports you can view settlement details like Settlement ID, Status, Date and UTR for the date range selected.
To view the settlement report,
1. Go to **Embedded Payment Gateway Dashboard** > **Reports**.
2. From the dropdown, select **Settlements** report and click on **Generate Report**.
3. Select the date range for which you want to view the report. You can also select the file format (csv or xlsx).
4. Click **Generate Report**. The report will be generated based on the criteria you have filtered. You can download the report after it has been generated.
# Transactions Report
Source: https://www.cashfree.com/docs/partners/embedded/reports/transaction-reports
The transaction report gives you details of all the transactions that were made for the period selected. Customer details, transaction amount, payment method, transaction status, settlement amount (if the settlement is complete), and more, are available in this report. If the transaction involves goods/services from two or more vendors, the vendor-wise payment split is also available in the transactions report.
To generate the transactions report,
1. Go to **Embedded Payment Gateway Dashboard** > **Reports**.
2. From the dropdown, select **Transactions** report and click on **Generate Report**.
3. Select the date range for which you want to view the report. You can also select the file format (csv or xlsx).
4. Select the status of the transactions that you want to view. You have the option to view all transactions based on the transaction status (Success, Failed, Dropped, Incomplete).
5. Click **Generate Report**. The report will be generated based on the criteria you have filtered. You can download the report after it has been generated.
# Introduction
Source: https://www.cashfree.com/docs/partners/introduction
Partners and Platforms by Cashfree Payments is a comprehensive growth ecosystem designed to help businesses expand their reach and revenue through two powerful programs. This solution enables platforms, ERPs, SaaS providers, and partners to offer complete payment solutions while earning commissions through merchant referrals and transaction processing.
Partners and Platforms products are designed to maximise revenue opportunities while providing seamless integration, robust merchant management tools, and comprehensive support that meets business growth requirements.
## Core partnership models
End-to-end payments product for platforms, ERPs, and SaaS to facilitate direct payments between businesses and customers.
Referral initiative to promote Cashfree products to clients and earn commission on every transaction they complete.
## Key benefits
Partners and Platforms provide the following advantages for your business growth:
* **Merchant management**: Add and onboard merchants through the dashboard or APIs, manage their Cashfree accounts, and track their onboarding status and KYC compliance.
* **Commission tracking**: Earn and track commissions on every transaction processed by your onboarded merchants with detailed reporting and invoicing.
* **Dashboard access**: Access dedicated partner dashboards to manage merchants, view transaction reports, and monitor your partnership performance.
* **Flexible partnership models**: Choose between deep platform integration with Embedded Payments or simple referral-based earning through the Affiliate Program.
* **Marketing resources**: Get access to marketing kits, promotional materials, and dedicated partner support to maximize your referral success.
## Getting started
Use the following resources to set up your partnership model:
Learn how to integrate the Embedded Payments gateway into your platform.
Learn how to refer and onboard merchants to start earning commissions.
# Bills
Source: https://www.cashfree.com/docs/payments/bbps-billers/dashboard-actions/bills
The bills section displays all the bills that were uploaded as csv files. Details mentioned below are available in this section:
* Bill Date - Date the bill was generated.
* Bill Reference ID - Unique identifier of the bill generated by the merchant/biller.
* Bill Number - Number of the bill.
* Customer Name - Name of the customer.
* Due Date - Date on which the bill is due next.
* Bill Period - The frequency of the bill.
* Bill Amount - Amount of the bill.
* Bill Status - Status of the bill.
* Action - Action that can be performed on the bill.
# Cancel Bills
Click the Cancel button from the Actions tab to cancel the bill. Note that any payment for this bill won't be accepted post this.
# Bulk Bills
You can upload multiple bills at once using the Upload Batch Bill File functionality. Details such as:
* Uploaded At - The time at which the bill was uploaded.
* Uploaded By - The person who uploaded the bill.
* File Name - Name of the file.
* File ID - ID of the file.
* Total Records - Number of records in the file.
* Invalid Records - Number of invalid records.
* Failure Reason - Reason why the upload failed.
* File Status - Upload status.
To upload a file,
Go to **Bulk Bills** > **Upload File** > **Choose File** > **Upload**. Ensure that the file you are uploading is as per the format in the sample file.
You can download the sample file using the **Download Sample File** option. You can also download the sample file using the **Download** option from the Bulk Bills section.
# Summary Homepage
Source: https://www.cashfree.com/docs/payments/bbps-billers/dashboard-actions/summary
The summary page in BBPS Billers gives you a overview of the following activities:
* Today's Transaction - The count of the total number of transactions that took place today along with the amount.
* Transaction Summary - A graphical representation of sum of total payments that came in for a particular day over the time range that is specified in the filter above. Hover over the graph to view the transaction amount. Clicking on the arrow mark will redirect you to the Transactions page.
* Average Transaction Value - A graphical representation of day wise average transaction value over the time range that is specified in the filter above. Clicking on the arrow mark will redirect you to the Transactions page.
* Transaction Status - Pie Chart representation which demonstrates the split of successful, pending and failed transactions. Hover your mouse over a particular region to view the success/failed/pending status. Clicking on the arrow mark will redirect you to the Transactions page.
# Transaction
Source: https://www.cashfree.com/docs/payments/bbps-billers/dashboard-actions/transaction
The Transaction page displays all the transactions made by your customers based on the filter you have applied. Details that are mentioned below are available in the transactions section such as:
* Date and Time of the transaction
* BBPS Transaction ID - A unique identifier of the payment received. This is generated by NPCI.
* Bill Reference ID - A unique identifier of the bill. This is generated by the merchant/biller.
* Amount Received - The amount received from your customer.
* Bill Payment Status - Status of the bill payment.
You can apply search on the following parameters: BBPS Transaction ID and Biller Reference ID
You can apply filter on Bill Payment Status.
# BBPS Billers - FAQs
Source: https://www.cashfree.com/docs/payments/bbps-billers/faqs
Bharat Bill Pay System (BBPS) is an integrated online ecosystem that connects 35 lakhs offline collection centres and 150+ digital payment channels including major UPI apps for all kinds of bill payments. A single integration, often facilitated by payment aggregators like Cashfree gives you access to this huge network which enables you to provide multiple payment options for your customers, both online and offline.
The billers are entities that generate the recurring bills to be paid. A few common examples are:
* Electricity boards with the electricity bills
* NBFCs with loan repayment
* Insurance companies with premium payments
* Housing facilities with rents
* Clubs and associations with membership charges
* Broadband and cable TVs with usage bills
Cashfree’s Biller solution for BBPS helps you collect bills from all major UPI apps like Paytm, PhonePe, Google Pay, and more with a single integration that connects you to the BBPS network. You can start the integration process with the following steps:
1. Express your interest [here](https://form.typeform.com/to/fLAObAhk?typeform-source=www.cashfree.com).
2. Our BBPS expert will reach out to you at the earliest to take the next steps on onboarding agreement and provide you complete integration support.
3. Post integration, the Cashfree team supports you to do end-to-end testing and enables you to start collecting bill payments on the BBPS network within 3 weeks.
The transaction limits are dependent on the mode of payment. For example, if the customer is making the payment through an UPI app, the UPI transaction limits would be applicable for the BBPS transaction.
BBPS works on a T+1\* settlement cycle. The billers get fast and guaranteed settlements for transactions through BBPS within 24 hours after the payment is made.
T+x\*: Settlement cycle is subject to bank approval and can vary based on transaction type, business category/model, risk parameters, and other factors.
With Cashfree’s Biller solution for BBPS, you can integrate and go live as a biller in less than 3 weeks. To start integrating, reach out to our BBPS expert here
The charges per transaction vary from category to category. To get the best pricing for your business category, please reach out to us [here](https://form.typeform.com/to/fLAObAhk?typeform-source=www.cashfree.com).
# Getting Onboarded and Listed on BBPS
Source: https://www.cashfree.com/docs/payments/bbps-billers/onboarding
There are three steps involved to start collecting bill payments using BBPS Biller -
**Step 1**: Contact our BBPS Product Champion at [rahul.saha@cashfree.com](mailto:rahul.saha@cashfree.com) and finalise the commercials.
**Step 2** - Basis your preference, you can integrate BBPS Billers Solution via APIs or use our no-code solution to start sooner.
**Step 3**: Your onboarding on the BBPS platform will be taken care by Cashfree Payments.
**Step 4**: Once a biller is live on the BBPS platform as a biller, following timelines are usual for you to be visible to your customers.
* BHIM (Immediately)
* Google Pay (Within 1 week)
* PhonePe and other UPI platforms as well as offline platforms (2 weeks)
**Step 5** Now your customers can use any application to view their latest bill and you can use Cashfree Dashboard to see realtime reporting of transactions coming through BBPS.
# Overview
Source: https://www.cashfree.com/docs/payments/bbps-billers/overview
Maximize your payment collection efficiency using Cashfree Payments' BBPS-Biller solution. This is designed to seamlessly handle recurring payments digitally and offline. Harness India's advanced bill payments infrastructure at unparalleled cost-effectiveness.
To begin with, you must first understand What is BBPS? -
Bharat Bill Pay System (BBPS) is an integrated online ecosystem that connects 150+ digital payment channels including major UPI apps like GPay, PhonePe, Paytm, AmazonPay, all phone banking apps and netbanking websites for all kinds of bill payments and 35 lacs offline collection centres. This is possible just by a simple single integration through Cashfree Payments which gives wide coverage and reduces payment expenses. These set of apps support multiple payment modes like UPI, Debit and Credit Cards, Net Banking, cash etc.
**Advantages of BBPS for Billers?**
* You can use Bharat BillPay's expansive network comprising over 150 digital channels and more than 35 lakh physical outlets for efficient collection.
* Modernize your collection process effortlessly with our digital solutions.
* Expand your presence across all Bharat BillPay enabled collection channels seamlessly.
* Accelerate your dues collection with multiple daily settlement cycles for faster processing.
* Go live in less than 3 weeks.
* 12+ payment modes for customers.
* Efficient settlement processing with a frequency of up to 6 cycles per day, ensuring swift and timely completion.
* Follows RBI regulatory standards, ensuring full compliance at every step.
***
# Use Cases
* **Electricity and Water Bills**: Efficient payment solutions for utilities like electricity and water bills catered specifically to DISCOMs, Water Supply Boards, Municipal Corporations, and similar entities.
* **Partial and full loan repayments**: Streamline partial and complete loan repayments effortlessly, designed specifically for Non-Banking Financial Companies (NBFCs), Loan Servicing Platforms (LSPs), and other institutions specializing in lending.
* **Broadband, Cable and DTH bills and advance payments**: Tailored solutions for managing broadband, cable, and DTH bills, including advance payments, exclusively designed for Local Cable Operators (LCOs), Multiple System Operators (MSOs), broadband, and DTH distributors.
* **Landline and Mobile Postpaid recharges**: Simplified solutions for seamless recharges of landline and mobile postpaid services, dedicated to mobile network operators and landline service providers.
* **B2B invoice payment**s - Streamline your payment collection process, for B2B invoice payments.
* **Insurance Premium payments online and offline**: Comprehensive solutions crafted for insurance providers, aggregators, and related entities, facilitating hassle-free insurance premium payments both online and offline.
* **Piped Gas and LPG Cylinder**: For city gas distribution networks, LPG providers etc.
* **PGs and Colive Rentals**: For all rental service providers like PGs, co-living, hostels etc.
***
# BBPS Categories
A biller operating in any one of the below categories can readily be a part of BBPS.
| Categories Supported | *(as by Nov'24)* | |
| :------------------- | :--------------- | :---------------------- |
| Agent Collection | Credit Card | Landline Postpaid |
| B2B | Donation | Loan Repayment |
| Broadband Postpaid | DTH | LPG Gas |
| Cable TV | Education Fees | Mobile Postpaid |
| Mobile Prepaid | Electricity | Municipal Services |
| Municipal Taxes | Fastag | National Pension System |
| NCMC Recharge | Gas | Prepaid Meter |
| Recurring Deposit | Housing Society | Rental |
| Subscription | Insurance | Water |
In case your business/use-case doesn't fit in any of the categories, you can reach out to us to get onboarded on the BBPS platform.
# Reports
Source: https://www.cashfree.com/docs/payments/bbps-billers/reports
There are various reports that can be generated from BBPS Billers. These reports help you to analyse your business transactions, and much more. You can view these reports day-wise, week-wise or for a custom date range. You also have the option to download the reports.
There are two reports you can generate from the BBPS Billers Report Dashboard : Transactions Report
* Bill Status Report
The Transactions report has details such as Transaction ID, Status, Issuer Name and Transaction Date for the date range selected.
Through the Bill Status report you can view the details of the uploaded bills through No-Code like bill amount, paid amount, payment date, status, etc.
To generate a new report,
1. Go to **BBPS Billers Dashboard** > **Reports** > **Generate Report**.
2. Select the **Report Type**, **Date Range**, and provide a **File Name**. Once done, click **Generate Report**.
3. You can also download your report. Click the ellipsis icon on the report you want to download and select **Download Report**.
# Abandoned Checkout
Source: https://www.cashfree.com/docs/payments/checkout/abandoned-checkout/abandoned-checkout
Cashfree Abandoned Checkout helps merchants recover lost sales by capturing abandoned checkout data and sharing it with Business Service Providers (BSPs) in real-time. This allows merchants to retarget customers who leave the checkout process without completing their purchase.
## Purpose
Shopify no longer supports direct updates of abandoned checkout data from third-party providers. As a result, merchants can’t automatically track where customers drop off. Cashfree Abandoned Checkout addresses this by ensuring merchants receive abandoned cart data instantly, helping them re-engage customers and increase conversions.
## Data flow and captured information
Cashfree uses real-time webhooks to send abandoned checkout data directly to BSPs. The captured data includes:
* Customer details: Phone number and email, even if partially filled.
* Address details: Any entered address, including partial entries (for example, ZIP code).
* Cart details: Complete cart contents.
* OCC checkout URL: A dynamic link that lets customers resume checkout.
* Marketing opt-in status: Indicates whether the customer agreed to receive marketing communications.
## Benefits
* Immediate retargeting: Reach high-intent customers quickly through BSP channels, such as WhatsApp.
* No data loss: Capture customer details even if they abandon the process early.
* Automated workflow: After setup, no manual intervention is required.
* Flexible checkout options: Supports both Shopify checkout links and Cashfree OCC checkout links.
* Secure data handling: Each merchant receives a unique token to ensure secure and authenticated data sharing with BSPs.
# Ecom360 Webhook
Source: https://www.cashfree.com/docs/payments/checkout/abandoned-checkout/ecom360
Configure Ecom360 webhook notifications to send data directly to your WhatsApp Business Service Provider (BSP). Once set up, the webhook sends structured JSON payloads to the BSP’s callback URL whenever a customer abandons a checkout.
The payload includes customer contact details, cart contents, a dynamic link to resume checkout, and other relevant metadata. This enables BSPs to automatically trigger WhatsApp messages for timely retargeting.
This setup supports both Shopify and Cashfree OCC checkout flows. After configuration, the process runs automatically with no manual input required.
## Setting up webhook notifications for WhatsApp provider
Follow these steps to subscribe to the `abandonedCheckout` webhook topic:
1. Get the callback URL where you want to receive event notifications from the webhook consumer (e.g., business service providers such as Spur, LimeChat, Gupshup, Whitespeed, or BiteSpeed).
2. Generate the webhook key using the below steps:
* Go to the [Ecom Dashboard](https://brands.zecpe.com/login).
* Enter the callback URL.
* Generate the webhook key.
3. Share the generated webhook key to the webhook consumer.
4. Share the [integration steps](/payments/checkout/abandoned-checkout#integration-steps) with the WhatsApp provider.
### Integration steps
The **Ecom 360 Webhook** monitors key events, such as abandoned checkouts, in real time. When a merchants subscribes to this webhook, it receives structured JSON payloads containing customer and order details. This allows businesses to automate actions such as sending reminders or promotional offers.
#### Subscribing to a webhook topic
To subscribe to the `abandonedCheckout` topic, provide the following details:
* **Topic name**: `abandonedCheckout`
* **Callback URL**: The URL where you want to receive event notifications.
* **Webhook version**: `v1`
* **Secret key**: Cashfree Payments provides this key to verify the authenticity of received events.
After subscribing, the webhook sends real-time notifications to the specified callback URL when an event occurs.
#### Sample webhook event payload
When the `abandonedCheckout` event triggers, the webhook sends the following payload:
```json theme={"dark"}
{
"event": "ABANDONED_CHECKOUT",
"data": {
"cart_id": "cart_123456",
"store_url": "my-store.myshopify.com",
"platform": "SHOPIFY",
"cart_token": "abc123token",
"email": "customer@example.com",
"phone": "+1234567890",
"abandoned_checkout_url": "https://my-store.myshopify.com/checkouts/abc123token",
"original_total_price": 10000,
"total_price": 8500,
"total_discount": 1500,
"utm_parameters": {
"fbclid": "fbclid_123",
"utm_campaign": "summer_sale"
},
"line_items": [
{
"product_id": "prod_001",
"variant_id": "var_001",
"sku": "SKU001",
"price": 5000,
"quantity": 2,
"gram": 200,
"title": "T-Shirt - Blue"
},
{
"product_id": "prod_002",
"variant_id": "var_002",
"sku": "SKU002",
"price": 3000,
"quantity": 1,
"gram": 150,
"title": "Cap - Black"
}
],
"promotions": [
{
"code": "WELCOME10",
"value": 1000
},
{
"code": "SUMMER2025",
"value": 500
}
],
"customer": {
"email": "customer@example.com",
"first_name": "John",
"last_name": "Doe",
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"address1": "123 Elm Street",
"address2": "Apt 4B",
"city": "New York",
"province": "NY",
"country": "US",
"zip": "10001",
"phone": "+1234567890",
"name": "John Doe",
"province_code": "NY",
"country_code": "US"
}
}
}
}
```
#### Webhook headers
Each webhook request includes the following headers to help businesses identify and validate the request:
| **Header key** | **Description** |
| --------------------- | -------------------------------------------------- |
| `x-store-url` | Specifies the store URL associated with the event |
| `x-webhook-topic` | Indicates the subscribed topic |
| `x-webhook-version` | Displays the webhook version |
| `x-webhook-signature` | Provides the HMAC signature to verify authenticity |
| `x-request-id` | Assigns a unique identifier for the request |
| `User-Agent` | Identifies the request as `Ecom360-v1` |
| `Content-Type` | Defines the payload format (`application/json`) |
**Note**: For assistance with setup or further inquiries, contact your Cashfree Payments Account Manager or fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)
# Abandoned Checkout Webhook
Source: https://www.cashfree.com/docs/payments/checkout/abandoned-checkout/webhook
Cashfree One Click Checkout (OCC) webhooks notify business service providers (BSPs) in real time when customers create abandoned carts. BSPs can add their webhook URLs to receive these events.
If a customer drops off during checkout and provides a phone number or email address, Cashfree OCC creates an abandoned cart record in both Shopify and the Cashfree system. Merchants can use this data to retarget users.
Abandoned cart records include:
* **Customer details:** Phone number, email address, or both
* **Address details:** Pincode, state, and other information. The address is included only if the customer submits the complete address.
* **Cart details:** Always included
* **OCC URL:** Link to the merchant’s Shopify store with the OCC page preloaded
Cashfree OCC triggers webhooks only for abandoned carts, not for completed checkouts. Once a BSP adds a webhook URL, it begins receiving events.
To enable this, merchants must ask the BSP to share the webhook URL where Cashfree should send data.
Cashfree doesn't send abandoned checkouts to Shopify if a login is required in the native checkout settings.
## Adding a webhook endpoint
To start receiving abandoned cart webhooks from Cashfree One Click Checkout (OCC), follow these steps:
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
2. Go to **Payment Gateway > Developers > Webhooks > Configuration > Payment Gateway** tab.
3. On the **Webhooks** page, click **Add Webhook Endpoints**.
4. In the **Endpoint Details** section:
* Enter the **endpoint URL** where you want to receive webhook data.
* Click **Test** to verify the URL.
* From the drop-down menu, select **Webhook Version: 2025-01-01**.
* Click **Continue**.
5. In the **Add Policy** section:
* Choose a **retry policy**. The default policy includes **3 retries**.
* Select the relevant **events** to subscribe to.
* Optionally, add another **retry policy** if needed.
* Click **Continue**.
6. In the **Summary** section:
* Review the configuration.
* Click **Update Secret Key**, then click **Update** in the confirmation pop-up.
* Click **Save**.
## Sample webhook event payload
Below is a sample webhook event payload for an abandoned cart.
Use the signature to verify that the request has not been tampered with. To verify the signature, use your merchant secret key along with the payload.
```json theme={"dark"}
{
"cartId": 75355,
"storeUrl": "test-mihir-1.myshopify.com",
"platform": null,
"cartToken": "Z2NwLWFzaWEtc291dGhlYXN0MTowMUpXRVgyWlJQSFpRRk42SDBCRkFaME1XMA?key=2fee923b8bebe7ecccfad7afd75e7a34",
"email": "darpxxxxx[at]xxxx[dot]xom",
"phone": "+91 6000376569",
"abandonedCheckoutUrl": "https://sandbox.cashfree.com/pg/view/sessions/checkout/web/g63eHoiIayRccLzTvGPX",
"originalTotalPrice": 2000.0,
"totalPrice": 1800.0,
"totalDiscount": 200.0,
"utmParameters": {
"fbclid": "",
"utm_campaign": "",
"utm_medium": "",
"utm_content": "",
"utm_source": ""
},
"lineItems": [
{
"reference": 8181897822385,
"variantId": 45515259445425,
"skuName": "",
"name": "Jordans - Black",
"description": "",
"detailsUrlStr": "",
"imageUrlStr": "https://cdn.shopify.com/s/files/1/0628/9037/7393/files/1.webp?v=1732785645",
"imageS3UrlStr": "https://cashfree-checkoutcartimages-gamma.cashfree.com/2193502202/checkoutcartitem1",
"originalPrice": 500.0,
"discountedPrice": 400.0,
"currency": "INR",
"quantity": 2,
"discounts": [
{
"title": "SHOE_AUTOMATIC",
"description": "",
"type": "FIXED",
"value": 200
}
]
},
{
"reference": 8352793428145,
"variantId": 45538243870897,
"skuName": "",
"name": "bundle 2 - Black / L / Mock",
"description": "",
"detailsUrlStr": "",
"imageUrlStr": "",
"imageS3UrlStr": "https://cashfree-checkoutcartimages-gamma.cashfree.com/2193502202/checkoutcartitem2",
"originalPrice": 1000.0,
"discountedPrice": 1000.0,
"currency": "INR",
"quantity": 1,
"discounts": []
}
],
"promotions": [
{
"code": "SHOE_AUTOMATIC",
"value": 200
}
],
"customer": {
"email": "darpxxxxx[at]xxxx[dot]xom",
"firstName": "Darpan",
"lastName": "Deka",
"shippingAddress": {
"customerName": "Darpan Deka",
"address1": "Rangia, Murara",
"address2": "",
"city": "Rangia",
"province": "Assam",
"country": "India",
"zip": "781354",
"email": "XXXXXXXXXXXXXXXXXXXX",
"phone": "XXXXXXXXXXXXXXXXXXXX",
"name": null,
"provinceCode": "AS",
"countryCode": "IN"
}
}
}
```
## Webhook headers
Each webhook request contains the following headers for validation and tracing:
| **Header Key** | **Description** |
| ----------------------------- | ---------------------------------------------------------------------------- |
| `x-datadog-sampling-priority` | Indicates trace sampling priority. A value of 1 means the trace is retained. |
| `x-datadog-parent-id` | ID of the parent span in a distributed trace. |
| `x-datadog-trace-id` | Unique ID for the trace across services. |
| `content-length` | Size of the request body in bytes. |
| `x-webhook-attempt` | Number of delivery attempts. |
| `content-type` | MIME type of the request body (`application/json`). |
| `x-webhook-signature` | Cryptographic signature for payload integrity. |
| `x-idempotency-key` | Unique key to prevent duplicate processing. |
| `x-webhook-timestamp` | Unix timestamp (in milliseconds) indicating when the webhook was sent. |
| `x-webhook-version` | Version of the webhook payload (e.g., `2025-01-01`). |
| `accept` | Acceptable media types in the response (`*/*`). |
| `host` | Receiving server domain (e.g., `webhook.site`). |
| `user-agent` | Client software sending the request (e.g., `ReactorNetty/1.1.11`). |
# Customer Login and Address-Prefilling
Source: https://www.cashfree.com/docs/payments/checkout/address-prefill
Learn more about login and address-prefill on checkout.
E-commerce businesses typically experience a 30% drop-off rate during the login and address collection steps. Customer Login and Address Prefilling on checkout helps address this issue.
Cashfree helps e-commerce brands in the following ways:
* Reduces cart abandonment at the login and address stages.
* Streamlines the conversion funnel for a seamless purchase experience.
* Encourages customers to complete their purchases with minimal friction.
## Customer login
The Customer Login feature simplifies the checkout process for repeat customers and increases conversion rates.
* Cashfree Customer Login enables repeat customers to bypass the login process, taking them directly to the address stage. Returning customers on **Cashfree’s network of over 2,500 brands** don't need to log in again; they proceed directly to the address step.
* As a result, Cashfree automatically logs in 50% of customers in its network, leading to conversion rates twice as high as those achieved with traditional login methods.
## Address prefilling
The Address Prefilling feature helps customers complete their purchases by reducing friction at the address entry stage.
* The address stage often results in a 22% cart drop-off rate due to lengthy forms. Cashfree Address Prefilling reduces this friction by automatically filling in address details, thereby increasing order completion rates.
* Cashfree Address Prefilling reduces cart abandonment by auto filling addresses for returning customers, ensuring a quick and accurate checkout using data from over **100 million shoppers**.
* For new customers, entering a postcode fills in 40% of the address fields (city and county), requiring only essential details such as name, address line, and email. This approach speeds up checkout and reduces drop-offs.
## How it works
Follow these steps to use Customer Login and Address Prefilling:
1. The customer logs into the checkout using their phone number. If the customer has already logged in with any merchant on the Cashfree network, they skip this step.
2. Cashfree fetches the address associated with this phone number. If the address isn't available, the customer can enter their address details and proceed.
This feature is available as part of **One Click Checkout**. To activate this product, go to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **PG Products > [One Click Checkout](https://merchant.cashfree.com/merchants/pg/one-click-checkout)**.
* **Shopify Integration** for One Click Checkout
* **Custom Integration** for One Click Checkout
# Payment Analytics
Source: https://www.cashfree.com/docs/payments/checkout/after/analytics
Unlock key insights to grow your business.
Payments Intelligence helps you optimise payments, boost sales, and reduce costs. Discover patterns, fix issues, and enhance customer experience to drive growth.
You can access analytics in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **Payment Gateway > Summary > Analytics**.
## Payment analytics
Payment analytics reveals buying patterns and key customer segments.
* **Customer journey insights**\
Track repeat and new customers’ buying behavior to improve targeting.
* **Identify high-value customers**\
Find loyal buyers and potential repeat customers to boost engagement.
## Success rate analytics
Success rate shows the percentage of successful transactions. Tracking success rate helps you spot payment issues and create a smoother checkout.
### Transaction analytics
* **Monitor success rates by payment method**\
See which payment methods work best, for example UPI and card, and identify issues.
* **Detailed gateway and method insights**\
Check success rate by each gateway to understand and optimise your payment options.
## Volume analytics
Volume analytics shows how much each payment method contributes to total sales.
* **View payment volume across methods**\
Understand which payment types your customers prefer, for example, UPI or wallet.
* **Customer payment preferences**\
Use these insights to adjust payment options based on customer trends.
## Regional insights
Regional insights provide visibility into where your customers are transacting from. The dashboard displays the successful transaction volumes segmented by states and regions, helping you track business performance geographically.
Locations are derived from IP addresses. These are estimates and may not always reflect the actual origin for server-to-server traffic.
* **Trend visualisation**: Track successful transactions over time across selected regions.
* **State and district level breakdown**: Within each state, you can drill down to view transaction volumes at the district or regional level.
* **Comparison view**: Select multiple states to compare transaction performance side by side.
**Example**\
In the example shown above, Maharashtra contributed the highest transaction volume with 13,741 successful transactions. Delhi, Gujarat, Uttar Pradesh, and West Bengal each recorded five successful transactions, while Karnataka recorded four successful transactions during the same period.
Use these insights to identify high-performing regions, optimise marketing spend, and understand customer behaviour across geographies.
snippets/related-topics-loader.mdx
# Customer Hub
Source: https://www.cashfree.com/docs/payments/checkout/after/customer-hub
Learn how Cashfree can help you manage your customer better
The **Customer Hub** is a simple portal where customers can handle everything related to their Cashfree Payments in one place. They can check payments, saved cards, refunds, and more.
**Try it out here**: [Cashfree Customer Hub](https://www.cashfree.com/customers)
## Why merchants should use Customer Hub
The Customer Hub helps merchants by making things easier for their customers. Here’s why it’s great for merchants:
* **Fewer Support Calls**\
Since customers can find answers on their own (like checking payments or refunds), they don’t need to contact support as much. This means merchants get fewer calls and can focus on other things.
* **Better Customer Trust**\
When customers can see their information and manage it easily, they feel more in control. This builds trust and makes them more likely to come back.
* **Accurate Data**\
Customers can update their own details, like billing addresses or payment methods, so merchants have the latest info without needing to do it themselves.
* **Simple Compliance**\
With the Customer Hub, customers have access to their own data, helping merchants stay compliant with data privacy rules.
* **Clear, Real-Time Updates**\
Customers can check the Hub anytime for real-time updates on payments and refunds, so they’re always in the loop. This builds transparency and trust.
## Manage saved payment methods
To manage saved payment methods in Customer Hub:
1. Log in to the [Customer Hub](https://www.cashfree.com/customers/) using your mobile number.
2. Under Manage, select **Payment Methods**.
3. Select the payment method you want to manage: **Cards** or **UPI**.
4. Add, edit, or delete the payment method as needed.
# External Analytics
Source: https://www.cashfree.com/docs/payments/checkout/after/external-analytics
Unlock key insights to grow your business by integrating **Cashfree Checkout**, **Payment Links**, and **Payment Forms** with your preferred analytics platform. Send real-time events to track user behaviour, optimise conversions, and measure performance across platforms.
## Supported platforms
Cashfree supports integration with the following analytics platforms:
* [Google Analytics 4 (GA4)](/payments/checkout/after/external-analytics#google-analytics-4-ga4)
* [Meta Pixel](/payments/checkout/after/external-analytics#meta-pixel)
* [Mixpanel](/payments/checkout/after/external-analytics#mixpanel)
* [Google Ads (via GA4 linking) ](/payments/checkout/after/external-analytics#ga4-google-ads)
* [Meta Ads (via Meta Pixel linking) ](/payments/checkout/after/external-analytics#meta-pixel-meta-ads)
If your analytics provider is not listed, contact [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
## Configure external analytics
To configure external analytics integration, follow these steps:
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
2. In the **Payment Gateway** section, select **Access**.
3. In the left navigation pane, select **Developers > Checkout Analytics**.
4. Under the **Actions** column, select the **Edit** icon.
5. In the **External Analytics Configuration** modal, configure the integration as described in the setup sections below.
6. Select **Save** to apply your changes.
## Event categories
Events are organised into different categories based on where they are triggered and what they track. You can track customer interactions in your integration by using the following event categories:
* Checkout
* One Click Checkout (OCC)
### Checkout events
Use these events to track customer interactions in the standard checkout flow, including checkout pages, payment links, and payment forms.
#### Client-side Checkout events
Client-side events are triggered in the browser or app when customers interact with the checkout interface.
| Event name | Description |
| ---------------------------------- | ------------------------------------------ |
| `cf_checkout_load` | Checkout loaded successfully. |
| `cf_checkout_transaction_initiate` | Customer initiated a transaction. |
| `cf_transaction_success` | Transaction completed successfully. |
| `cf_transaction_failure` | Transaction failed. |
| `cf_retry_checkout` | Redirected to checkout after failure. |
| `cf_return_to_merchant` | Customer redirected back to merchant page. |
#### Client-side payment link and payment form events
| Event name | Description |
| ----------------------- | ----------------------------------------------- |
| `cf_pl_load` | Payment link loaded successfully. |
| `cf_pf_load` | Payment form loaded successfully. |
| `cf_checkout_initiated` | Checkout initiated from a payment link or form. |
| `cf_purchase_completed` | Payment completed successfully. |
### One click checkout (OCC) events
Use these events to track customer interactions in the One Click Checkout (OCC) flow. OCC events are available for server-side and client-side tracking.
#### Server-side events
Server-side events are pushed to Google Analytics 4 (GA4) and Meta Facebook.
| GA4 event | Meta Facebook event |
| ------------------------------------ | ------------------------------------ |
| `begin_checkout` (standard event) | `InitiateCheckout` (standard event) |
| `cf_checkout_login_otp_sent` | `cf_checkout_login_otp_sent` |
| `cf_checkout_login_verify` | `cf_checkout_login_verify` |
| `add_shipping_info` (standard) | `cf_checkout_address_collected` |
| `cf_checkout_payment_info_displayed` | `cf_checkout_payment_info_displayed` |
| `add_payment_info` (standard) | `AddPaymentInfo` (standard event) |
| `purchase` (standard) | `purchase` (standard event) |
#### Client-side events
Client-side events are triggered in the browser or app when customers interact with OCC pages.
| Event name | Description |
| ---------------------------------- | -------------------------------------------- |
| `cf_checkout_occ_load` | First page or login page loaded. |
| `cf_checkout_login_verify` | OTP verified. |
| `cf_checkout_login_otp_sent` | OTP sent. |
| `cf_checkout_address_load` | Addresses loaded. |
| `cf_checkout_address_collected` | Address save or continue clicked. |
| `cf_checkout_load` | Payment page opened. |
| `cf_checkout_transaction_initiate` | Order payment transaction initiated. |
| `cf_checkout_offer_apply` | Offer applied. |
| `cf_checkout_offer_remove` | Offer removed. |
| `cf_checkout_order_cancelled` | Order cancelled. |
| `cf_checkout_address_deleted` | Address deleted. |
| `cf_checkout_address_updated` | Address updated. |
| `transaction_success` | Triggered only for non-Shopify integrations. |
## Setup instructions
Follow the platform-specific instructions below to configure your analytics integration.
To set up GA4 integration, complete the following steps:
1. Sign in to your [GA4 account](https://analytics.google.com/).
2. Go to **Admin** (bottom left).
3. Select **Data Streams** and open the relevant stream.
4. Copy the **Measurement ID**.
5. In Cashfree’s External Analytics Configuration modal, enable **Broadcast events to Google**.
6. Enter the **Measurement ID**.
7. Generate an API token:
* In GA4 Admin, select **Measurement Protocol API secrets**.
* Create a new API secret and copy the value.
8. Enter the **Access Token** in Cashfree’s configuration modal.
9. Select **Save**.
**Verification**:
* In GA4, go to **Reports > Realtime Overview**.
* Perform a test transaction.
* Events should appear in real time.
To set up Meta Pixel integration, complete the following steps:
1. Sign in to [Meta Events Manager](https://www.facebook.com/events_manager2).
2. Select your Pixel from **Data Sources**.
3. Copy the **Pixel ID** from **Settings**.
4. Generate an **Access Token**:
* Scroll to **Conversions API**.
* Select **Generate Access Token**.\
5. In Cashfree’s configuration modal, enter the Pixel ID and Access Token.
6. Select **Save**.
**Verification**:
1. Navigate to **Data Source** tab under Events Manager.
2. Select your particular Pixel ID, click on **Overview**.
Here, you see the list of events coming, if there is some activity on the OCC.
If you are a Shopify merchant using OCC, disable the **purchase** event in Cashfree Meta Pixel setup. This prevents double-counting if Facebook and Instagram sales channels are active in your Shopify store.
To set up Mixpanel integration, complete the following steps:
1. Sign in to your [Mixpanel account](https://mixpanel.com/).
2. Go to **Project Settings**.
3. Copy the **Project Token**.
4. Enter it in the Cashfree configuration modal.
5. Select **Save**.
## Linking with ad platforms
You can link your analytics platforms with advertising platforms to enhance tracking and optimisation.
Link Google Ads and GA4
### Step 1: Mark the purchase event as a conversion in GA4
GA4 imports only events that are marked as key events. Mark the purchase event as a key event before you import it into Google Ads.
1. Sign in to your GA4 property.
2. Select **Admin** (bottom-left).
3. Under **Data display**, select **Events**.
4. Find the **purchase** event in the list of collected events.
5. Check for the star icon to confirm the purchase event is marked as a key event (purchase events are usually marked by default).
### Step 2: Link Google Analytics 4 to Google Ads
Linking creates the connection that lets data flow between the two platforms.
1. In your GA4 property, open **Admin**.
2. Under **Product links**, select **Google Ads links**.
3. Select **Link** (top-right).
4. Choose **Google Ads accounts** and pick the account(s) you want to link.
5. Select the checkbox next to the account and choose **Confirm**.
6. On the next screen, ensure **Enable personalised advertising** and **Enable auto tagging** are turned on (they should be on by default). Keep both enabled where possible.
* Personalised advertising lets you use GA4 audiences for remarketing in Google Ads.
* Auto tagging adds the gclid parameter to your ad URLs so GA4 can attribute clicks and conversions to Google Ads campaigns.
7. Select **Next**, review the settings, then select **Submit**.
Allow up to 24 hours for data to start flowing between the two platforms.
### Step 3: Import the purchase conversion into Google Ads
After linking and once data has synced, import the GA4 conversion into Google Ads.
1. Sign in to your Google Ads account.
2. From the left menu, select **Goals**.
3. Under **Conversion**, select **Summary**.
4. Select **+ Create conversion action**.
5. Choose **Import**.
6. Select **Google Analytics 4 properties**, choose **Web**, then select **Continue**.
7. Select the **purchase** event (or other conversions you want to track) from the list of GA4 key events.
8. Select **Import and continue**, then select **Done**.
### Step 4: Configure the purchase conversion in Google Ads
1. On the **Conversions** summary page, find the purchase conversion you imported.
2. Select the conversion name to edit settings.
3. Set **Value** to **Use the value from Google Analytics** so the purchase amount is passed into Google Ads dynamically.
4. Set **Action optimisation** to **Primary action** so Google Ads can use this conversion for bidding optimisation.
When setup is complete, start analysing conversion data in both platforms.
Changes to conversion tracking apply only to future orders and events and won’t be applied retroactively to historical data. Allow up to 48 hours for the new conversion data to appear in GA4 and Meta reporting dashboards.
Once you have configured Meta Pixel integration with Cashfree, you can link it with Meta Ads Manager to enhance your advertising campaigns with conversion tracking and optimisation.
### Prerequisites
Before linking Meta Pixel with Meta Ads, ensure you have:
* A configured Meta Pixel with Cashfree integration
* An active Meta Ads Manager account
* Admin access to your Meta Business account
### Step 1: Access your Meta Ads Manager
1. Sign in to [Meta Ads Manager](https://www.facebook.com/adsmanager/).
2. Navigate to **Events Manager** from the main menu.
3. Select your configured Pixel from the **Data Sources** list.
### Step 2: Verify pixel events
1. In **Events Manager**, go to your Pixel's **Overview** tab.
2. Verify that Cashfree events such as `purchase` and `InitiateCheckout` are appearing.
3. Verify event data quality using the **Diagnostics** tab.
### Step 3: Create custom conversions
1. In **Events Manager**, select **Custom Conversions** from the left menu.
2. Select **Create Custom Conversion**.
3. Define conversion rules based on Cashfree events:
* For purchase tracking: use the `purchase` event
* For checkout initiation: use the `InitiateCheckout` event
* For payment info collection: use the `AddPaymentInfo` event
4. Set conversion values and attribution windows as needed.
5. Save the custom conversion.
### Step 4: Use conversions in Meta Ads campaigns
1. In [Meta Ads Manager](https://www.facebook.com/adsmanager/), create or edit a campaign.
2. In the **Optimisation & Delivery** section, select your custom conversion as the optimisation goal.
3. Set appropriate bid strategies based on your conversion objectives.
4. Launch your campaign to begin using Cashfree conversion data for optimisation.
### Step 5: Monitor performance
* Use **[Ads Reporting](https://www.facebook.com/adsmanager/reporting/)** to view conversion metrics from Cashfree events.
* Monitor attribution data in **Events Manager** to understand the customer journey.
* Adjust campaign targeting and bidding based on Cashfree conversion insights.
## Verification and troubleshooting
* Allow up to 48 hours for new configurations.
* Ensure IDs and tokens are correct.
* For Shopify merchants, disable duplicate purchase events.
* Use provider-specific real-time or debug views.
If you are a Shopify merchant using One Click Checkout, disable the purchase event in Cashfree Meta Pixel setup. This prevents double-counting if Facebook and Instagram sales channels are active in your Shopify store.
snippets/related-topics-loader.mdx
# Recovering Abandoned Orders via WhatsApp
Source: https://www.cashfree.com/docs/payments/checkout/cart-recovery
How to retarget dropped off customers and improve conversion
Customers drop off at checkout due to multiple reasons like lack of clarity on pricing, delivery, payment issues, and others. To convert these high-intent customers, we have released a workflow via WhatsApp and SMS that can recover up to **4%** of these lost orders.
## Key features
* **✅ Pay via UPI**: Customers can directly complete their payment from WhatsApp in just 1 click using the UPI intent flow.
* **✅ Additional Offer**: You can additionally incentivize the customer using an offer that would be auto-applied to increase the chances of conversion. (This will be an offer funded by you.)
* **✅ Cashfree Verified Messages**: Build additional trust with your customers with WhatsApp messages delivered from Cashfree's verified WhatsApp account.
## Abandoned orders report
You can view and download corresponding reports from the payment gateway dashboard > Reports section.
## Activation
You can reach out to us by filling out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for activation with the following details:
* Duration after which the message should be sent
* Offer details to nudge customer. The offer can be a flat amount or a percentage value (Optional).
# Go Live Checklist
Source: https://www.cashfree.com/docs/payments/checkout/checklist
Verify your One Click Checkout configurations with this checklist before you go live.
After Cashfree One Click Checkout is successfully integrated with your Shopify Preview Store, ensure and verify the following configurations to get the maximum conversions on the Checkout.
## Shopify dashboard
### Products
Ensure Cashfree is added as Sales Channel for all your products in Shopify.
1. Navigate to **Products** > All in your Shopify store admin.
2. Select all the products and click **Include in sales channels**.
3. Select **Cashfree-OCC-** sales channel and click **Include products** to save.
Once done, Cashfree Checkout will open for all these products when added in the cart and proceeding to checkout.
### Taxes
Ensure **Inclusive Taxes** is set up since Cashfree Checkout is compatible with this setting.
1. Navigate to **Settings > Taxes and duties** in your Shopify store admin.
2. Scroll to **Global settings** and select the **Include sales tax in product price and shipping rate** check box. Click **Save**.
## Cashfree dashboard
### Payments
* Verify **Online Payments** are set up for your account.
* Check that the Online Payment Gateway is activated. Note that Payment Gateway is shown in Products Activated section on Merchant Dashboard.
* Check that online payment methods like **UPI** and **Cards** are activated in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **Payment Gateway > Settings > Payment Methods**.
### COD and RTO
* Verify **COD** is set up for your account.
* Configure **COD** (or **Partial COD**) rules. Click [here](https://www.cashfree.com/docs/payments/checkout/cod/overview) to understand COD management.
* Set up **RTO Intelligence** and COD configurations to manage RTO. Click [here](https://www.cashfree.com/docs/payments/checkout/cod/blacklist-cod) to understand RTO tools.\
You can configure COD and set up RTO rules in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **PG Products > One Click Checkout > COD & RTO**.
## Ads and analytics tracking
To maintain accurate ROAS, Conversion metrics and performance, ensure your ads and analytics setup is complete. Your ROAS and Conversion metrics will drop if this isn't set up correctly.
1. Configure **Meta Pixel tracking** to get Checkout and Conversion events.
* Know more about the setup here:**[External Analytics OCC](https://www.cashfree.com/docs/payments/checkout/after/external-analytics#meta-pixel).**
* You can set up analytics tracking in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **Payment Gateway > Developers > Checkout Analytics**.
If “Facebook and Instagram” sales channel is activated in your Shopify store, ensure the **Purchase** event is disabled in Cashfree during the Meta Pixel Analytics setup.
2. Configure **Google Analytics (GA4) tracking** to get Checkout and Conversion events.
* Know more about the setup here: **[External Analytics OCC](https://www.cashfree.com/docs/payments/checkout/after/external-analytics#google-analytics-4-ga4).**
* You can set up analytics tracking in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **Payment Gateway > Developers > Checkout Analytics**.
3. Configure **Google Ads conversion tracking via GA4**.
* Know more about the setup here: **[External Analytics OCC](https://www.cashfree.com/docs/payments/checkout/after/external-analytics#ga4-google-ads).**
## Shipping and delivery
Ensure your **Shipping Rates and Delivery Time** is correctly configured to avoid drop-offs at the address stage.
* Set up your **Shipping Rules, COD Availability, and Shipping Charges** to ease your delivery operations.
* Understand setup steps [here](https://www.cashfree.com/docs/payments/checkout/shipping-overview).
* You can set up the shipping rules in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **PG Products > One Click Checkout > Shipping & Delivery**.
Shoppers are increasingly conscious of **Expected Delivery Time**. Ensure this is added during setup to avoid drop-offs.
Shopify Shipping Rules **won't be shown** on Cashfree OCC. Set these up in Cashfree as per the above.
## Discounts and offers
Ensure your Discounts and Offers are synced from Shopify or created in Cashfree to boost your customer acquisition and repeat purchases.
* Setup your Shopify Discounts to be displayed on Checkout.
* For Shopify discounts to work with Cashfree Checkout, the **Cashfree-OCC-**\* sales channel must be added. Click [here](https://www.cashfree.com/docs/payments/checkout/offers/shopify) to know more about Shopify discounts.
* Create Prepaid, Payment Method, and other special offers to drive conversions.
You can import Shopify discounts and create Cashfree offers in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **PG Products > One Click Checkout > Offers**.
## Branding and customisation
Customise the checkout experience to match your brand identity.
* You can customise your **Brand Logo** and **Colors** on checkout in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **PG Products > One Click Checkout > Customisation**.
Ensure your **Brand Name** is visible on Checkout. Reach out to [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for this.
## Abandoned checkout recovery
Set up recovery flows to recover dropped shoppers.
1. **Abandoned Checkout**:
* This is created and available in Shopify dashboard and no configuration required.
* Connect your **Recovery Provider** on Shopify to target these shoppers.\
Only sessions that have reached the **Payments page** and dropped are created in Shopify.
2. **WhatsApp via Cashfree webhooks**:
* Configure your WhatsApp Provider to get notified via **Abandoned Checkout webhooks**. Click [here](https://www.cashfree.com/docs/payments/checkout/abandoned-checkout/webhook) to know more about Abandoned Checkout webhook.\
Sessions that completed the **Login step** (verified phone number is available) and dropped are notified via webhook.
## Final checkout flow
* Verify and experience the final checkout flow in your **Preview Theme** on Shopify.
## OCC analytics
* Check OCC **Sales and Performance** in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **PG Products > One Click Checkout > Funnel Analytics**.
## Special flow handling
### Bundler apps
* Check your bundled product information and amount are correctly captured in **Cart Summary** and when **Order is Placed via OCC**.
* If your current Bundler app isn't working, try one of these integrated and tested apps:
* [Shopify Bundles](https://apps.shopify.com/shopify-bundles)
* [Bundler Product Bundles](https://apps.shopify.com/bundler-product-bundles)
* [Pumper Product Bundles](https://apps.shopify.com/pumper-quantity-breaks-product-bundles-discounts)
* [Essential Post-Purchase Upsell](https://apps.shopify.com/essential-post-purchase-upsell)
* [Revy Product Bundles](https://apps.shopify.com/product-bundles-discounts-by-revy)
* [Koala Product Bundles](https://apps.shopify.com/profitkoala-upsell-bundle)
### Sidecart apps
* Check product, amount, and discount information is correctly captured during OCC Checkout.
* OCC works with vanilla Shopify Sidecart. If your current app doesn’t work, try one of these:
* [iCart](https://apps.shopify.com/icart)
* [Slide Cart](https://apps.shopify.com/slide-cart)
* [Sticky Cart by Qikify](https://apps.shopify.com/sticky-cart-by-qikify)
* [CornerCart](https://apps.shopify.com/cornercart)
* [XB Sticky Add To Cart + Upsell](https://apps.shopify.com/xb-sticky-add-to-cart-upsell)
* [Monster Cart Upsell+Free Gifts](https://apps.shopify.com/monster-upsells)
### International orders
* OCC doesn't support International Orders and Currency.
* To facilitate the same, we can add a custom CTA above/below your Checkout button which redirects such shoppers to Shopify Checkout.
Reach out to [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for this configuration.
### Gift card and store credit apps
* OCC doesn't support Shopify or custom Gift Card and Store Credit Apps.
* Add a **custom CTA** above/below Checkout button to redirect shoppers to Shopify Checkout.
Reach out to [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for this configuration.
### Loyalty and rewards apps
* OCC doesn't support third-party Loyalty Apps.
* Add a **custom CTA** above/below Checkout button to redirect shoppers to Shopify Checkout.
Reach out to [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for this configuration.
# Go Live Checklist
Source: https://www.cashfree.com/docs/payments/checkout/checklist-deprecated
Verify your One Click Checkout configurations with this checklist before you go live.
# Blacklist Cash on Delivery (COD)
Source: https://www.cashfree.com/docs/payments/checkout/cod/blacklist-cod
Learn more about Blacklisting COD on One Click Checkout
The Blacklisting feature in Cashfree helps merchants reduce losses from Return to Origin (RTO), where customers refuse to accept Cash on Delivery (COD) orders. RTOs increase costs due to shipping and inventory handling.
Secure your business by blocking high-risk customers, limiting COD for select products, and managing delivery zones prone to issues. Customize your store’s operations to reduce risks, minimise losses, and ensure smooth, efficient order fulfilment.
## Key features
* Block high-risk customers using advanced risk models
* Restrict certain products from COD eligibility
* Manage pin codes with a history of delivery issues
## Blacklisting COD
Use the Blacklist feature to restrict Cash on Delivery (COD) based on products, customers, or pincodes.
### To access the Blacklist:
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
2. Under One-Click Checkout, select Access.
3. In the left pane, select COD & RTO.
4. Select the Blacklist tab.
5. Select Add to Blacklist.
### To blacklist by product:
1. In the Add Product ID to Blacklist window:
* To block a single product, select Single Product ID and enter the product ID.
* To block multiple products, select Multiple Product IDs and upload a .csv file containing product IDs.
The file must be under 500 KB. The `productid` field is required.
2. Select Proceed.
### To blacklist by customer:
1. In the Add Phone Number to Blacklist window:
* To block a single customer, select Single Phone Number and enter the phone number.
* To block multiple customers, select Multiple Phone Numbers, and upload a .csv file with phone numbers.
The file must be under 500 KB. The `phonenumber` field is required.
2. Select Proceed.
### To blacklist by pincode:
1. In the Add Pincodes to Blacklist window:
* To block a single pincode, select Single Pincode and enter the pincode.
* To block multiple pincodes, select Multiple Pincodes and upload a .csv file with pincode values.
The file must be under 500 KB. The `pincode` field is required.
2. Select Proceed.
# Configure Cash on Delivery
Source: https://www.cashfree.com/docs/payments/checkout/cod/configure
Learn more about configuring Cash on Delivery
Cashfree Payments lets you set rules for handling Cash on Delivery (COD) transactions. You can define rules based on transaction amount, specify COD types, apply handling fees, and enable partial payment collection. These configurations give customers more flexibility and help increase conversions.
## Key features
* **Partial COD support**: Collect a flat amount or a percentage of the order value upfront. This helps reduce RTOs, improve order reliability, and manage risk for high-value or first-time orders—while offering customers flexible payment options and protecting your business.
* **Flexible COD rules**: Set minimum and maximum order amounts to control COD eligibility.
* **Custom transaction types**: Choose between full COD or Partial COD based on your business needs.
* **Handling fee configuration**: Apply handling fees for COD orders to offset delivery risks or costs.
* **Tiered rule setup**: Create multiple slabs to apply different COD rules for different order ranges.
## Configuring COD
To configure COD:
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
2. Under **One-Click Checkout**, select **Access**.
3. In the left pane, select **COD & RTO**.
4. Select the **Configuration** tab.
5. Under **Configure COD Rules**, do the following:
* In **Transaction Amount**, set the **Min Amount** and **Max Amount** for COD.
* Under **Transaction Type**, choose one of the following:
* **COD**: Enter a value in the **Handling Fee** field.
* **Partial COD**: Specify the advance amount to collect. Choose a **Flat Amount** or **Percentage** of the order value.
6. To define more COD rules, select **Add Another Slab**.
7. Select **Confirm** to save your settings.
**Note**: If a transaction amount doesn’t match any rule, COD is disabled and the payment defaults to prepaid. Create custom slabs as needed.
# Overview
Source: https://www.cashfree.com/docs/payments/checkout/cod/overview
Manage COD effectively with Cashfree's One Click Checkout
Cash on Delivery (COD) is one of the most widely used payment methods in Indian e-commerce, often accounting for over 70% of orders. It builds trust—especially among new users—by allowing payment only at the time of delivery.
Cashfree’s One-Click Checkout provides powerful tools to help you manage COD efficiently, reduce losses from Return to Origin (RTO), and improve delivery success rates.
## How COD works with Cashfree Payments?
Setting up and managing COD with Cashfree is simple:
* **Order confirmation** – When a customer selects COD at checkout, Cashfree records the payment mode as **Cash on Delivery** with a **SUCCESS** status.
* **Order status** – The order appears as **PENDING** in Shopify. For custom integrations, use webhooks to monitor and update the order status.
Cashfree does not collect cash from customers.
## Manage COD with Cashfree
Use the Cashfree Dashboard to customise COD operations based on your business goals:
* **Add or remove fees** – Configure convenience fees or waive them as needed. Learn how to [configure Cash on Delivery](/payments/checkout/cod/configure).
* **Set restrictions** – Blacklist specific pincodes, product IDs, or customer phone numbers to control COD availability. Learn how to [blacklist Cash on Delivery](/payments/checkout/cod/blacklist-cod).
* **Use RTO Intelligence** – Automatically hide the COD option for high-risk customers based on historical shipping and order data. Learn how to [configure RTO Intelligence](/payments/checkout/cod/rto).
* **Enable Partial COD** – Collect a flat amount or a percentage of the order value in advance. This helps reduce RTO risk, particularly for high-value or first-time orders. Learn how to [configure Partial COD](/payments/checkout/cod/configure#configuring-cod).
* **Track payments** – View and manage both COD and prepaid orders in a single dashboard with analytics tools for insights and reporting.
Always check the order status and details for COD using [webhooks](/api-reference/payments/latest/payments/webhooks) or [status APIs](/api-reference/payments/latest/orders/get) to keep the order status updated.
# RTO Intelligence
Source: https://www.cashfree.com/docs/payments/checkout/cod/rto
Learn more about RTO Intelligence
Cashfree’s AI-powered Return to Origin (RTO) Intelligence reduces return orders and fraud by disabling Cash on Delivery for high-risk customers. Integrated with One-Click Checkout, it uses machine learning to predict RTO risk, improving delivery rates and reducing costs.
## Key features
* **Smarter RTO risk prediction**: Uses a machine learning model that goes beyond historical order count to improve the accuracy and precision of RTO risk assessment.
* **Enriched data inputs**: Enhances model performance by combining customer phone numbers, shipping addresses, cart items, merchant transaction history, and 10+ other parameters.
* **Shipping provider integration**: Connects with shipping partners such as Delhivery and Selloship to provide end-to-end order visibility, enabling more accurate risk prediction.
## Activate RTO Intelligence
To activate RTO Intelligence:
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
2. Under **One-Click Checkout**, select **Access**.
3. In the left pane, select **COD & RTO**.
4. Select the **RTO Intelligence** tab.
5. Turn on the toggle in the top-right corner.
**Note**: You can't turn on the toggle if no shipping provider credentials are linked.
6. In the **Link a Shipping Provider** modal:
1. Select the shipping company from the **Shipping Company** dropdown.
2. Enter your **Username**.
3. Enter your **Password**.
4. Select **Add Now**.
# Customise Checkout
Source: https://www.cashfree.com/docs/payments/checkout/customise-checkout
Customise the checkout experience to match your brand identity and ensure a seamless transition for your customers.
The *Canvas* branding dashboard aims to enable you to customise every visual detail of all the components present in the checkout page to make it look like a true extension of your own platform. This helps in instilling trust in customers regarding the authenticity of the checkout page and makes the visual transition from your platform to checkout much smoother.
## VKYC webhook events
The following events are triggered at different stages of the Video KYC process:
| Event | Description |
| :------------------------------ | :------------------------------------------------------- |
| VKYC\_USER\_LINK\_GENERATED | User VKYC link has been generated for the user |
| VKYC\_USER\_LINK\_EXPIRED | User VKYC link has expired |
| VKYC\_USER\_AADHAAR\_VERIFIED | User's Aadhaar has been successfully verified |
| VKYC\_USER\_CALL\_SCHEDULED | User VKYC call has been scheduled |
| VKYC\_USER\_PRECHECK\_FAILED | User Pre-verification checks have failed |
| VKYC\_USER\_CALL\_QUEUED | User has joined and is waiting in the queue for an agent |
| VKYC\_USER\_CALL\_STARTED | User VKYC call has started with an agent |
| VKYC\_USER\_DROPOFF\_FROM\_CALL | User has dropped off from the VKYC call |
| VKYC\_USER\_CALL\_COMPLETED | User VKYC call has been completed successfully |
- Aadhaar Number - Enter your aadhaar number. Enter the OTP received on your mobile number in the{" "} One Time Password popup.
- I do not have my mobile number linked to this aadhaar. - In case the entered mobile number is not the registered mobile number for aadhaar, you can verify by uploading any of the government IDs: aadhaar, driving licence, voter ID, and passport.
- Select ID Proof and Upload - Use the dropdown menu to select an ID proof.
- Upload - Upload the selected document.
- Registration Certificate from Registrar of Company for a Jurisdiction
- Certificate/ License under Shops and Establishment Act and/or other Acts as applicable
- Sales Tax or Income Tax Return
- Partnership Deed
- Registration Certificate from Registrar of Firms
- Trust Deed/Society/NGO Registration Certificate
- FORM 80G/12A
- Trust PAN and bank
* The Business PAN information of TRUST/Society/Local Authority/Artificial Juridical Person/Government. * The PAN information of the Authorised Signatory (Trustee of the firm) * Bank account details or a cancelled cheque * Aadhaar number of the Authorised Signatory (Trustee of the firm) If Authorised Signatory is not the Trustee of the firm * The PAN information of the Trustee * Identity proof of the Trustee * Board Resolution signed by the Trustee * Business registration proof * Trust Deed/Society/NGO Registration Certificate * Certificate of registration number issued by charity commissioner or registrar of cooperative society or any other competent authority * Letter of Intent/Authorisation (LOI)/(LOA) * Society Certificate * NGO Registration Certificate * [Line of business(LOB) specific documents](#upload-documents) *** ## Manage account ### Profile You can manage your account information and control overall activities in the **Profile** page. You can control basic account settings, configure two-factor authentication, monitor login history, and view your tax invoices. #### My information **My Information** displays the following information under **Personal Profile**: * **Name**: The registered name of your Cashfree Payments account. * **Email ID**: The registered email address of your Cashfree Payments account. * **Phone Number**: The registered phone number of your Cashfree Payments account. * **Customer Support Email**: Your customer support email address. * **Account Password**: Click **Set Password** to change your account password  ### Update information You can edit your details such as email ID, phone number, and customer support email ID using the features available on the dashboard. The **Edit** icon next to each information allows you to update the information after successful OTP authentication.
To confirm your identity and prevent fraudulent activities, we require an aadhaar validation to update your contact information.
Ensure the aadhaar number used during the KYC process of your Cashfree Payments' account is used to initiate this change.
You only have to go through the aadhaar validation process once when you try to update both the email and phone number information.
You can assign multiple roles for the user by checking the respective boxes of the roles. The **Permissions** section displays the combined permissions of the selected roles.
#### Invite a user and enable permissions without a specific role
You can also invite a user and enable specific permission without assigning a specific role. You can use this to provide temporary access to a specific dashboard without having to redefine the entire role within your organisation.
Follow the instructions below to invite a user and enable permission:
1. After you enter the required information of the user in the **User details** section of the **Invite New User** popup, scroll down to see **Direct Permission Assignment**.
2. Click **Enable permissions without a specific role**.
3. The **Select Account for Payouts/VRS** dropdown appears; use it to select the account(s) that the user can access.
4. Follow the instructions in the **Permissions** section, and click **Invite New User**:
* **Search for a permission**: Use this search bar to search for a permission.
* **Table**
* **Product**: Use the dropdown to navigate through each product's features.
* **View**: Use the toggle to enable or disable a permission that allows to only view the module or feature.
* **Manage**: Use the toggle to enable or disable a permission that allows to add, edit, download etc.
5. A user is invited successfully. You can view the invited user(s) in the **User Management > Invited Users** screen.
#### Manage users
Follow the instructions below to manage existing users:
1. The table in the **User Management** screen lists the created users.
* **Enable/Disable**: Use this toggle to enable or disable a user.
2. Click the ellipses icon of the user that you want to manage.
3. Select an option:
* **View details**: It allows you to view the user details.
* **Edit details**: It allows you to edit the user's permission/role in the **Update Details** popup. Click **Update User** when done.
* **Delete**: It allows you to delete the user.
### Role management
This dashboard feature allows you to create and define the access levels and permissions for different roles within the system. The cornerstone of this system is its enhanced flexibility and control through the creation of different roles with specific permissions for each role.
#### Create role
You can now create roles tailored to the exact needs of your team members. For example, you can define a role for a user that allows only to view Payment Gateway's orders and nothing beyond that.
Follow the instructions below to create a role:
1. Log in to the dashboard using your credentials.
2. From the product selection screen, click **Settings** from the top navigation pane.
3. Click **Access Management** from the **General** card, and click **Role Management**.
4. Click **New Role**.
5. Enter the following information in the **Create New Role** popup, and click **Create New Role**:
* **Role**: Enter the name of the role in this field.
* **Description**: Enter the description for the role.
* **Search for a permission**: Use this search bar to search for a permission.
* **Table**
* **Product**: Use the dropdown to navigate through each product's features.
* **View**: Use the toggle to enable or disable a permission that allows to only view the module or feature.
* **Manage**: Use the toggle to enable or disable a permission that allows to add, edit, download etc.
6. A role is successfully created. You can view the created role(s) in the **Role Management** screen.
#### Manage role
To maintain security and proper governance, we allows you to manage the created roles. Follow the instructions below to manage:
1. From the **Role Management** screen, click the ellipses icon of the role.
2. A dropdown box appears with the following options:
* **Edit role**: It allows you to edit the role. Click **Edit Role** > update the details > and click **Update Role**.
* **Delete**: It allows you to delete the role.
# Pricing FAQs
Source: https://www.cashfree.com/docs/help/account/pricing
- A digitally signed Form 16A
- A cancelled cheque for the bank account where the refund should be credited
2. Go to the **Profile** section.
3. Select **Edit** next to the display name field.
4. Enter the updated name and submit the request.
5. Verify the change using the **OTP sent to your Aadhaar-linked mobile number**.
2. Go to the **Profile** section.
3. Select **Edit** next to the phone number field.
4. Enter the new phone number and submit the request.
5. Verify the change using the **OTP sent to your Aadhaar-linked mobile number**.
2. Large Input for **Donor Residential Address** (if you want to collect donor address details):
* Field Label - Residential Address.
* Field Options - Required (enable if you want to make the address mandatory).
3. Use multiple **Section Breaks** to add the static text content to show beside the form.
in the text, and the content after that will be in a new line. Do not use the Enter key for this purpose (Example: the text "[care@cashfree.com](mailto:care@cashfree.com)\
+9199999xxxxx\
Address" will be shown as follows, with content after \
shown in a new line).
* You can use the following content (one section break for each section) as a reference to create a complete donation page:
1. **Donation Cause**:
* Mention how the donated funds will help Covid-19 patients and if you have partnered with any other donation agency.
* Example: Our hospitals are going through dire situations, we urgently need more oxygen cylinders, concentrators and vaccine doses to save as many lives as possible. \This campaign started as a self-funded mission to help hospitals across the country get immediate access to 100 oxygen concentrators and fund 5000 vaccine doses. 2. **Tax Exemption Details**: * If your organisation is eligible to give 80G certificates, clearly mention your registration number and PAN details. * Example: Your contribution has an exemption of 50% under Section 80G of the IT Act. An 80G certificate will be provided within a few days if a valid PAN and residential address are provided by the payer. Compulsory for donations above Rs. 50,000. \
Registration No: XX \
PAN: XX. 3. **Contact Us**: * Provide your valid contact details so donors can reach out to you. * Example: [youremailid@yourdomain.com](mailto:youremailid@yourdomain.com)\
+9199999xxxxx\
Your Registered Address. 4. **Terms & Conditions**: * Mention any terms and conditions if applicable to donors. * Example: Donations using this link can be made by Indian citizens only (residents and non-residents). We accept cards issued outside India. 8. Click **Save Form** to save the changes. 9. You can check the link on `https://www.cashfree.com/donation/{identifier}`. This is different from the usual PayMe address - `https://cashfree.com/payme/{identifier}`. 10. If you follow all the above-mentioned steps correctly, the final output would be similar to the image below:
Now, go ahead and start collecting funds for a cause that's dear to you!
On-Demand Settlement Flow
### Activate on-demand settlements
To enable instant settlement from the Cashfree Payments dashboard:
1. Go to the Payment Gateway Dashboard.
2. Navigate to the Settlements section.
3.Look for the On-Demand Settlements option.
If you're eligible, you'll see options to configure On-Demand settlements.
After activation, you can request settlements instantly 24x7 including holidays.
Settlement Amount
You will see a success screen as shown below:
Settlement Success
You will see all the settlements received in the Settlements > On-Demand screen. You can click the individual settlements to know more details.
- Ticket Bookings – Airlines, concerts, and events often place a hold on a credit card to ensure funds are available before finalizing the booking. This is useful if confirmation is pending or for refundable ticket options.
- Car Rentals – Rental companies use pre-authorization to secure a deposit in case of damages, late returns, or additional charges. The hold is released if no extra fees are incurred.
- Hotel Reservations – Hotels pre-authorize a guest’s credit card at check-in to cover potential incidentals, damages, or unpaid charges, ensuring payment security before checkout.
Payments
Get started with documentation and APIs to start integrating Cashfree Payment's Products.
Payouts
Get started with the documentation and APIs to integrate Cashfree Payouts. Automate and manage payouts for vendors, refunds, loans, and more.
Secure ID
Get started with the documentation and APIs to integrate Cashfree Secure ID. Simplify user onboarding with a compliant, scalable, and customizable identity verification platform.
{/* New Newsletter Subscription */}
{/* Social Links in a Single Row */}
Subscribe to Developer Updates:
GitHub
Postman Collections
Discord
Cashien AI
YouTube
Blog
3. In the **Create Partner Account** window, enter your brand name and valid mobile number. Cashfree will verify the mobile number by sending an OTP.
4. [Login](https://www.cashfree.com/affiliate-program/) to the Affiliate Partner Dashboard using the same credentials.
## Activate affiliate account
After signing up, you must complete the KYC process to activate your affiliate account. We’ll verify your submitted details and enable your account for commission payouts.
**Info:** Offer Cashfree Payments product suite to your clients. You can refer merchants using your Dashboard. Once referred, you can assist them with their KYC and Payment Integration. Learn how to [refer new merchants](/partners/affiliates/refer-merchants) using your Affiliate Partner Dashboard.
• Municipal certificate
• Shop establishment certificate
• Udyog Aadhaar | | | Business owner identity proof | Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Private or public limited** | Business identity proof | Company PAN | | | Business registration proof | CIN or GSTIN | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Partnership** | Business identity proof | Company PAN | | | Business registration proof | Registered partnership deed | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **LLP** | Business identity proof | Company PAN | | | Business registration proof | LLPIN or GSTIN | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Hindu Undivided Family (HUF)** | Business identity proof | Company PAN | | | Business registration proof | Registered HUF deed | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account | | **Others** | Business identity proof | Company PAN | | | Business registration proof | Registered business proof or GSTIN | | | Business owner identity proof | PAN and Aadhaar (of owner) | | | Business bank account proof | Business bank account |
### Merchants
The **Merchants** section in the Affiliate Partner Dashboard allows you to efficiently onboard and manage referred merchants.
You can:
* **Add a single merchant** by entering:
* Business name
* Contact details (email address and phone number)
* Optional KYC information for faster verification
* **Bulk upload merchants** using a predefined file format to add multiple businesses at once. For more information, refer [
Onboarding](/partners/affiliates/refer-merchants#onboarding).
* **Track onboarding status** after submission:
* Merchants receive a verification email
* Status updates are shown on the Dashboard
For more information, refer [Track merchant status](/partners/affiliates/assist-merchant/merchants-kyc#track-merchant-status).
# FAQs
Source: https://www.cashfree.com/docs/partners/affiliates/faqs
2. You would be directed to the merchant account activation page where you can fill in all required business details of your referred merchant and upload their business documents.
2. To track payment gateway transactions by your merchants, select **PG Orders** in the navigation section on the left. You can view the number of transactions, total transaction amount, and commission earned by you on those transactions for every merchant.
### Commission for GST registered and unregistered affiliates
If you are GST registered and shared the GSTIN details with Cashfree Payments, you will see the GST component in the **Commission** section. This information is not visible to the unregistered affiliates.
All GST-registered affiliates must share their GSTIN with Cashfree Payments as per compliance requirements. Please update your GST details via the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
### Receive commission amount
Cashfree generates and displays commissions every month. You see the commission for the previous month by the 5th of the current month. To start the settlement process, you create an invoice.
#### Eligibility requirements
You receive a commission if:
* You have at least two transacting merchants in the month.
* Your Partner KYC is complete.
* Your commission amount is more than ₹1.
If you meet all the requirements but don’t receive your commission, raise a ticket through the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
## Invoices
To receive the commission amount for the previous months: you must create an invoice, specify the mandatory details, and upload the invoice.
To raise an invoice,
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Select **Commission** > **Invoice**.
3. Click **Add Invoice**.
3. Select the months for which you want to create an invoice.
4. If you use an accounting system and want to upload an invoice using the same system, you can click **Upload Invoice**. Ensure your company's GSTIN and Cashfree Payments GSTIN are specified in the invoice.\
Alternatively, you can click **Generate Invoice** if you need help with creating the invoice. Cashfree Payments automatically creates an invoice. You can enter the mandatory details and send the invoice.
5. Upload or generate the invoice and enter the mandatory details. Click **Approve and Send Invoice** to send the invoice to Cashfree Payments for further processing of the commission amount.
### Invoice statuses
| Status | Description |
| :----------------- | :--------------------------------------------------------------------------------------- |
| Under Review | The invoice status is yet to be verified by Cashfree Payments. |
| Approved | The invoice is verified and approved for processing the commission amount. |
| Payout in Progress | The commission amount is initiated for payout by Cashfree Payments. |
| Paid | The commission amount is settled in your bank account registered with Cashfree Payments. |
| Rejected | The invoice is rejected by Cashfree Payments. |
# Refer and Onboard Merchants
Source: https://www.cashfree.com/docs/partners/affiliates/refer-merchants
As a Cashfree Affiliate Partner, you can refer businesses to use Cashfree Payments. You can also help them with KYC verification and integration to simplify onboarding.
After you sign in to your Affiliate Partner Dashboard, you can refer merchants in the following ways:
* [Share your referral link](/partners/affiliates/refer-merchants#share-a-referral-link): Copy and share your unique referral link through email, messaging apps, or social media.
* [Send an email invitation](/partners/affiliates/refer-merchants#send-an-email-invitation): Add the merchant’s details and send an invitation directly to their email address.
## Share a referral link
To share your referral link:
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Go to the **Summary** page in your dashboard.
3. Copy your unique **Referral Link** and share it with merchants or clients via **WhatsApp**, **Instagram**, or other channels.
## Send an email invitation
To add a merchant via an email invitation:
1. Login to the [Affiliate Partner](https://partner.cashfree.com/auth/login) dashboard using your credentials.
2. Go to the **Affiliate Dashboard** > **Merchants** > **All** and click **Add Merchant**.
3. On the Add a New Merchant screen, under Basic Details, fill in the merchant's information:
* Merchant Name
* Merchant ID (Optional)
* Email Address
* Mobile Number
* Accept the terms and conditions.
3. Click **Add Merchant & Exit** or click **Proceed** to enable faster onboarding and KYC verification by submitting the merchant's basic KYC details.
**Business Details (Optional)**:
* Business Type
* Business Model
* Business PAN Details
* Bank Account Details
* Business Category and subcategory
* Website and application link
* Authorised signatory PAN details
* Name as per Authorized Signatory PAN
* GSTIN
4. Click **Add Merchant**.
A verification email will be sent to the merchant, and the onboarding status will be updated after successful verification.
## Adding merchant from dashboard
To add a merchant,
1. Go to the **Embedded Payments Dashboard** > **Merchants** > **Add Merchant**.
2. In the **Add New Merchant** screen, enter the merchant **Business Name**, **Registered Email**, **Phone Number**, and **Merchant ID**. Merchant ID is a unique alphanumeric identifier for the merchants. It will be auto-generated if not provided. The maximum number of characters allowed is 40. (Hyphen and underscore allowed.)
3. For faster onboarding and KYC verification, you can submit the merchants' basic KYC details.
**Details Required (Optional)**:
* Business Type
* Business Model
* Business PAN Details
* Bank Account Details
* Business Category and subcategory
* Website and application link
* Authorised signatory PAN details
* Name as per Authorized Signatory PAN
* GSTIN
4. Accept the terms and conditions, and click **Submit**.
A verification email will be sent to the merchant, and the onboarding status will be updated after successful verification.
## Add merchants using batch upload
To onboard many merchants at once, you can add all the details in a file (format specified by Cashfree Payments) and upload it.
To bulk upload merchant details,
1. Go to the **Embedded Payments Dashboard** > **Merchants** > click **Bulk upload merchants**.
2. Click **Upload File** and choose the file you want to upload. Ensure all the details are provided as per the sample file. Fill in the mandatory fields - Business Name, Registered Email, Phone Number, and Merchant ID.\
You can also specify the business details, PAN, and bank account details of the merchants for KYC verification, if required.
3. Details like the number of merchants added to the file, how many are valid/invalid, and the status of the uploaded file will be displayed after the file is successfully uploaded. You can download the file and correct any errors in the file and upload it again.
Sample file is available here.
## Add merchant using APIs
You can add a merchant using our APIs. Use these APIs to create a merchant and onboard merchants from your platform. There are other actions you can do with these APIs such as:
* Updating merchant details
* Fetching the merchant onboarding status
* Creating onboarding link
### List of merchant APIs
| API Name | Description |
| :------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------- |
| [Create Merchant](/api-reference/platforms/latest/merchant-onboarding/create-merchant) | Use this API to create a new merchant account. |
| [Update Merchant](/api-reference/platforms/latest/merchant-onboarding/update-merchant) | Use this API to update the merchant details. |
| [Get Merchant Status](/api-reference/platforms/latest/merchant-onboarding/update-merchant) | Use this API to view merchant details. |
| [Create Onboarding Link](/api-reference/platforms/latest/merchant-onboarding/create-embeddable-onboarding-link-does-not-require-login) | Use this API to create a new onboarding link. |
Listen to merchant activation events using [Merchant Onboarding Webhooks](api-reference/platforms/latest/merchant-onboarding/webhooks).
2. To track payment gateway transactions by your merchants, select **PG Orders** in the navigation section on the left. You can view the number of transactions, total transaction amount, and commission earned by you on those transactions for every merchant.
### Commission for GST registered and unregistered partners
If you are GST registered and shared the GSTIN details with Cashfree Payments, you will see the GST component in the **Commission** section. This information is not visible to the unregistered partnerss.
All GST-registered partners must share their GSTIN with Cashfree Payments as per compliance requirements. Fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) to update your GST details.
### Receive commission amount
To initiate your commission settlement process for the previous month, you must create an invoice. Click [here](doc:partner-invoices) for more information on how to create an invoice.
3. Select the months for which you want to create an invoice.
4. If you use an accounting system and want to upload an invoice using the same system, you can click **Upload Invoice**. Ensure your company's GSTIN and Cashfree Payments GSTIN are specified in the invoice.\
Alternatively, you can click **Generate Invoice** if you need help with creating the invoice. Cashfree Payments automatically creates an invoice. You can enter the mandatory details and send the invoice.
5. Upload or generate the invoice and enter the mandatory details. Click **Approve and Send Invoice** to send the invoice to Cashfree Payments for further processing of the commission amount.
### Invoice statuses
| Status | Description |
| :----------------- | :--------------------------------------------------------------------------------------- |
| Under Review | The invoice status is yet to be verified by Cashfree Payments. |
| Approved | The invoice is verified and approved for processing the commission amount. |
| Payout in Progress | The commission amount is initiated for payout by Cashfree Payments. |
| Paid | The commission amount is settled in your bank account registered with Cashfree Payments. |
| Rejected | The invoice is rejected by Cashfree Payments. |
# Embedded Payments Dashboard
Source: https://www.cashfree.com/docs/partners/embedded/dashboard
## Summary
The **Summary** screen gives you details about your daily transactions, like the current-day transaction count, the value of the transactions made by your merchants, and the last commission amount you received from Cashfree Payments as per the referral program.
The following details are available on this page:
* Number of Transactions Today - Total number of PG and Payout transactions done by your merchants.
* Value of Today's Transactions - Total value of PG and Payout transactions done by your merchants today.
* Last Commission Amount - The last month's commission amount to be settled to your bank account.
* Merchant Stats - Number of merchants you have added and activated.
* Referral Link - Send this to your merchants for signing up.
* Partner Logo - To showcase that you are Cashfree Verified Affiliate Partner, a partner logo is available on the Summary screen. Copy and Download the Logo.
* PG Transaction Value
* Payouts Count
* Commission Summary
## PG orders
The PG Orders screen gives you merchant-wise details about the PG transactions. Details available are:
* Merchant Name
* Transaction Count
* Transaction Amount
* Total Commission
By default, the report shows details for the last 7 days. You can filter and view the details as per your requirement. Click on a particular transaction to view more details about it.
## Payout transfer
The Payout Transfer screen gives you details about the payout transactions done by your merchants. Details available are:
* Merchant Name
* Transfer Count
* Transfer Amount
* Total Commission
Click on a particular payout transaction to view more details about it.
## Developers
The developers section contains resources for developers to build and monitor their integration of APIs into their platform. This section shows the API keys, Webhooks, and Onboarding Webhooks.
### API keys
You can view the API keys and the time it was generated. You can also reset the API keys using the **Reset API key** option.
### Webhook
Add and define webhooks for individual events and get notified for each action on the URLs configured.
#### Add webhook endpoint
To add a new webhook,
1. Go to **Embedded Payment Dashboard** > **Developers**.
2. Click **Add Webhook Endpoint** to create a new webhook. Enter the endpoint URL and select the required action events and click **Add Webhook**.
1. Click the pencil icon beside each webhook to update the webhook. Edit the webhook URL, add/remove events from the list and click **Update Webhook**.
#### Onboarding webhook
Add onboarding webhooks to build webhooks for your partners so that you can get the merchant lifecycle webhook events.
To Add Onboarding Webhook,
1. Go to **Embedded Payment Dashboard** > **Developers**.
2. Click **Add Webhook URL** to create a new webhook. Enter the endpoint URL and click **Add Webhook**.
## Reports
Now generate various reports from the Embedded Payments Dashboard. The Reports homepage has the following options:
* Report Type
* Report Name
* Merchants Count (Click on it to view the merchant names)
* Report Size
* Generated At
* Download Report
* Delete Report
The following are the report types available in Embedded Payments:
* Transaction
* Settlement
* Refund
* Dispute
To generate a report,
1. Go to **Embedded Payment Dashboard** > **Reports**. Choose the required report from the **Report Type** drop-down and click **Generate Report**. You can also apply filter and view reports as per your requirement.
To view the merchant's list, click the number available on the corresponding merchant.
# Get Started with Embedded Payments
Source: https://www.cashfree.com/docs/partners/embedded/get-started
Signup for Embedded Payments to get started with the product. After you complete the signup and activation process, you will get access to the Embedded Payments Partner Dashboard. You can add merchants, integrate our Payment Gateway solution, keep a check on your commissions, get a snapshot of your business with Cashfree, and more within the Embedded Payments Dashboard.
## Signup for embedded payments
To use Embedded Payments, you must first create an Embedded Payments Partner account with Cashfree.
1. Go to the Embedded Payments [sign up page](https://partner.cashfree.com/partner-ui/authentication/signup?product=embedded).
2. In the **Create Account** screen, enter your Business Information and create a password for your account.
3. Click **Signup**.
4. You can [login](https://partner.cashfree.com/partner-ui/authentication/login) to the Embedded Payments Dashboard using the same credentials.
## Activate embedded payments account
After you complete the signup process, you will receive a welcome email from Cashfree Payments. To complete the activation of your account, you have to send us the documents listed below to complete the KYC for your account. We will verify all the details and enable your account within 48 hours of submitting all documents.
You can Login to your Embedded Payments Dashboard with the email ID and password entered during sign-up and explore your Embedded Payments Dashboard.
If you face any issues or need further support you can contact us at **[Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)**.
### Documents required for KYC verification
**Business Details**
* Website URL
* Official email ID
* Official contact name and phone number
* Bank account details - name, account number, and IFSC
| For Proprietorship | For Partnership/LLP | For Private Ltd./Public Ltd. Entities |
| :------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------- | :---------------------------------------------------------------- |
| Business registration proof (GST certificate/Shop act licence/labour licence/ MSME certificate/Trade license) | Business reg. proof (Partnership Deed/ LLP COI) | Certificate of Incorporation |
| Proprietor's PAN card | Business PAN card | Business PAN card |
| Proprietor's address proof (DL/Voter ID/Passport) | Authorized signatory PAN card | Authorized signatory/director's PAN card |
| Cancelled cheque or bank statement | Authorized signatory - address proof (DL/Voter ID/Passport) | Authorized signatory - address proof (DL/Voter ID/Passport) |
| | Cancelled cheque or bank statement | Cancelled cheque or bank statement |
| | | Memorandum of Association (MOA) and Articles of Association (AOA) |
3. Copy and download the API keys for all API requests and future reference.
## Payment gateway APIs
All the Payment Gateway APIs that you find in [this](/api-reference/payments/latest/overview) document can be used using partner authentication for your merchants.
### Partner authentication
To use Payment Gateway APIs for Partner Auth integration, **x-client-id** and **x-client-secret** headers will not be used anymore, please use the following headers:
* **x-partner-apikey**: This is the common API Key generated and unique for each Partner.
* **x-partner-merchantid**: This is the unique merchant ID for each merchant associated with the Partner. To know the merchant ID, go to **Partner Dashboard** > **Merchants** section, and copy the **Merchant ID** of the merchant you want to transact with.
### Payment Gateway SDKs
We support the following SDK integrations:
| Integration Types |
| :--------------------------------------------------------------- |
| [JS Integration](/payments/online/element/overview) |
| [Web Integration](/payments/online/web/redirect) |
| [Android Integration](/payments/online/mobile/android) |
| [iOS Integration](/payments/online/mobile/ios) |
| [React Native Integration](/payments/online/mobile/react-native) |
| [Cordova Integration](/payments/online/mobile/cordova) |
| [Flutter Integration](/payments/online/mobile/flutter) |
## Partner webhooks
To configure partner webhook,
1. Go to **Partner Dashboard** > **Developers** > **Webhooks**.
2. Click **Add Webhook URL** and enter the URL where you want to receive the updates.
3. Select the events for which you want to configure the webhooks to receive updates, and click **Add Webhook**.
4. Your webhook is now added successfully. You can also edit the added webhook using the edit option from the Webhook homepage.
Notifications will be sent to your configured endpoint as a POST request with the body containing the various parameters specifying the details of each event. Each request contains an event parameter that identifies its type.
We support webhooks in both encoded and JSON formats.
### How to use Cashfree Payments webhooks?
### 1. Create an endpoint URL
To receive event notifications, you need to create an endpoint in your server that can accept requests from Cashfree Payments. The endpoint URL can be HTTP in your local machine for testing purposes while developing. However, it should be HTTPS for the production environment.\
You receive webhook event notifications on the specified URLs. You can use one URL to handle different event types at once or specify individual URLs for specific events.
### 2. Select events to subscribe
You can configure webhooks to receive notifications for the following events:
* [Payment Success](/api-reference/payments/latest/payments/webhooks#payment-success-webhook)
* [User Dropped](/api-reference/payments/latest/payments/webhooks#payment-user-dropped-webhook)
* [Payment Failed](/api-reference/payments/latest/payments/webhooks#payment-failed-webhook)
* [Refunds](/api-reference/payments/latest/refunds/webhooks#refund-webhooks)
* [Settlement Webhooks](/payments/split/webhooks#settlement-webhook)
When you are in the test environment, the "Switch to Test" button will change to “Switch to Prod”. You can use it to switch back to the live environment.
While operating within the test environment, you have the capability to simulate essential features of the payment gateway. This empowers you to replicate and test the necessary functionalities vital for the seamless operation of the payment gateway system.
You can add new merchants from the Merchants section through the **Add Merchant** option. The added merchant will be enabled in test environment with payment gateway activated and default pricing.
This activation takes upto 5 mins. Refresh the Merchants tab to recheck the activation status.
Please note that KYC is required for activating merchants in the live environment.
You can access the **Developers** tab, and generate Partner API Key and configure Partner Webhooks as well. Once done, you can follow integration steps mentioned in the [Embedded Payment Gateway Integration guide](/partners/embedded/integration/gateway-integration).
Sample request to **Create an Order** -
```Text curl theme={"dark"}
curl --location 'https://sandbox.cashfree.com/pg/orders' \
--header 'x-partner-apikey: {{partnerAPIKey}}' \
--header 'x-partner-merchantid: {{partnermerchantId}}'
--header 'x-api-version: 2022-09-01' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"order_amount": "10",
"order_currency": "INR",
"customer_details": {
"customer_id": "USER123",
"customer_name": "joe",
"customer_email": "joe.s@cashfree.com",
"customer_phone": "+919876543210"
},
"order_meta": {
"return_url": "https://b8af79f41056.eu.ngrok.io?order_id={order_id}",
"notify_url": "https://b8af79f41056.eu.ngrok.io/webhook.php",
}
}'
```
Sample request to **Get Order** details -
```Text curl theme={"dark"}
curl --request GET \
--url https://sandbox.cashfree.com/pg/orders/{{order_id}}\
--header 'x-partner-apikey: {{partnerAPIKey}}' \
--header 'x-partner-merchantid: {{partnermerchantId}}'
--header 'accept: application/json' \
--header 'x-api-version: 2022-09-01'
```
Apart from this, you can simulate payments using payments methods such as Card, UPI, and other payment modes that are part of the integration. Other features like Summary, PG Orders, Reports will also work in Test Environment
2. Click **Add Webhook URL** and enter the URL where you want to receive the updates.
3. Select the events for which you want to configure the webhooks to receive updates, and click **Add Webhook**.
Notifications will be sent to your configured endpoint as a POST request with the body containing the various parameters specifying the details of each event. Each request contains an event parameter that identifies its type.
We support webhooks in both encoded and JSON formats.
# Embedded Payments Overview
Source: https://www.cashfree.com/docs/partners/embedded/overview
Embedded Payments by Cashfree lets platforms enable direct, compliant payments between businesses and their customers, with seamless onboarding built in. Ideal for ERPs, SaaS, and software platforms embedding payments into their product.
## Key features
# Cancel Bills
Click the Cancel button from the Actions tab to cancel the bill. Note that any payment for this bill won't be accepted post this.
# Bulk Bills
You can upload multiple bills at once using the Upload Batch Bill File functionality. Details such as:
* Uploaded At - The time at which the bill was uploaded.
* Uploaded By - The person who uploaded the bill.
* File Name - Name of the file.
* File ID - ID of the file.
* Total Records - Number of records in the file.
* Invalid Records - Number of invalid records.
* Failure Reason - Reason why the upload failed.
* File Status - Upload status.
To upload a file,
Go to **Bulk Bills** > **Upload File** > **Choose File** > **Upload**. Ensure that the file you are uploading is as per the format in the sample file.
You can download the sample file using the **Download Sample File** option. You can also download the sample file using the **Download** option from the Bulk Bills section.
# Summary Homepage
Source: https://www.cashfree.com/docs/payments/bbps-billers/dashboard-actions/summary
The summary page in BBPS Billers gives you a overview of the following activities:
* Today's Transaction - The count of the total number of transactions that took place today along with the amount.
* Transaction Summary - A graphical representation of sum of total payments that came in for a particular day over the time range that is specified in the filter above. Hover over the graph to view the transaction amount. Clicking on the arrow mark will redirect you to the Transactions page.
* Average Transaction Value - A graphical representation of day wise average transaction value over the time range that is specified in the filter above. Clicking on the arrow mark will redirect you to the Transactions page.
* Transaction Status - Pie Chart representation which demonstrates the split of successful, pending and failed transactions. Hover your mouse over a particular region to view the success/failed/pending status. Clicking on the arrow mark will redirect you to the Transactions page.
# Transaction
Source: https://www.cashfree.com/docs/payments/bbps-billers/dashboard-actions/transaction
The Transaction page displays all the transactions made by your customers based on the filter you have applied. Details that are mentioned below are available in the transactions section such as:
* Date and Time of the transaction
* BBPS Transaction ID - A unique identifier of the payment received. This is generated by NPCI.
* Bill Reference ID - A unique identifier of the bill. This is generated by the merchant/biller.
* Amount Received - The amount received from your customer.
* Bill Payment Status - Status of the bill payment.
You can apply search on the following parameters: BBPS Transaction ID and Biller Reference ID
You can apply filter on Bill Payment Status.
# BBPS Billers - FAQs
Source: https://www.cashfree.com/docs/payments/bbps-billers/faqs
2. Select the **Report Type**, **Date Range**, and provide a **File Name**. Once done, click **Generate Report**.
3. You can also download your report. Click the ellipsis icon on the report you want to download and select **Download Report**.
# Abandoned Checkout
Source: https://www.cashfree.com/docs/payments/checkout/abandoned-checkout/abandoned-checkout
Cashfree Abandoned Checkout helps merchants recover lost sales by capturing abandoned checkout data and sharing it with Business Service Providers (BSPs) in real-time. This allows merchants to retarget customers who leave the checkout process without completing their purchase.
## Purpose
Shopify no longer supports direct updates of abandoned checkout data from third-party providers. As a result, merchants can’t automatically track where customers drop off. Cashfree Abandoned Checkout addresses this by ensuring merchants receive abandoned cart data instantly, helping them re-engage customers and increase conversions.
## Data flow and captured information
Cashfree uses real-time webhooks to send abandoned checkout data directly to BSPs. The captured data includes:
* Customer details: Phone number and email, even if partially filled.
* Address details: Any entered address, including partial entries (for example, ZIP code).
* Cart details: Complete cart contents.
* OCC checkout URL: A dynamic link that lets customers resume checkout.
* Marketing opt-in status: Indicates whether the customer agreed to receive marketing communications.
## Benefits
* Immediate retargeting: Reach high-intent customers quickly through BSP channels, such as WhatsApp.
* No data loss: Capture customer details even if they abandon the process early.
* Automated workflow: After setup, no manual intervention is required.
* Flexible checkout options: Supports both Shopify checkout links and Cashfree OCC checkout links.
* Secure data handling: Each merchant receives a unique token to ensure secure and authenticated data sharing with BSPs.
# Ecom360 Webhook
Source: https://www.cashfree.com/docs/payments/checkout/abandoned-checkout/ecom360
Configure Ecom360 webhook notifications to send data directly to your WhatsApp Business Service Provider (BSP). Once set up, the webhook sends structured JSON payloads to the BSP’s callback URL whenever a customer abandons a checkout.
The payload includes customer contact details, cart contents, a dynamic link to resume checkout, and other relevant metadata. This enables BSPs to automatically trigger WhatsApp messages for timely retargeting.
This setup supports both Shopify and Cashfree OCC checkout flows. After configuration, the process runs automatically with no manual input required.
## Setting up webhook notifications for WhatsApp provider
Follow these steps to subscribe to the `abandonedCheckout` webhook topic:
1. Get the callback URL where you want to receive event notifications from the webhook consumer (e.g., business service providers such as Spur, LimeChat, Gupshup, Whitespeed, or BiteSpeed).
2. Generate the webhook key using the below steps:
* Go to the [Ecom Dashboard](https://brands.zecpe.com/login).
* Enter the callback URL.
* Generate the webhook key.
3. Share the generated webhook key to the webhook consumer.
4. Share the [integration steps](/payments/checkout/abandoned-checkout#integration-steps) with the WhatsApp provider.
### Integration steps
The **Ecom 360 Webhook** monitors key events, such as abandoned checkouts, in real time. When a merchants subscribes to this webhook, it receives structured JSON payloads containing customer and order details. This allows businesses to automate actions such as sending reminders or promotional offers.
#### Subscribing to a webhook topic
To subscribe to the `abandonedCheckout` topic, provide the following details:
* **Topic name**: `abandonedCheckout`
* **Callback URL**: The URL where you want to receive event notifications.
* **Webhook version**: `v1`
* **Secret key**: Cashfree Payments provides this key to verify the authenticity of received events.
After subscribing, the webhook sends real-time notifications to the specified callback URL when an event occurs.
#### Sample webhook event payload
When the `abandonedCheckout` event triggers, the webhook sends the following payload:
```json theme={"dark"}
{
"event": "ABANDONED_CHECKOUT",
"data": {
"cart_id": "cart_123456",
"store_url": "my-store.myshopify.com",
"platform": "SHOPIFY",
"cart_token": "abc123token",
"email": "customer@example.com",
"phone": "+1234567890",
"abandoned_checkout_url": "https://my-store.myshopify.com/checkouts/abc123token",
"original_total_price": 10000,
"total_price": 8500,
"total_discount": 1500,
"utm_parameters": {
"fbclid": "fbclid_123",
"utm_campaign": "summer_sale"
},
"line_items": [
{
"product_id": "prod_001",
"variant_id": "var_001",
"sku": "SKU001",
"price": 5000,
"quantity": 2,
"gram": 200,
"title": "T-Shirt - Blue"
},
{
"product_id": "prod_002",
"variant_id": "var_002",
"sku": "SKU002",
"price": 3000,
"quantity": 1,
"gram": 150,
"title": "Cap - Black"
}
],
"promotions": [
{
"code": "WELCOME10",
"value": 1000
},
{
"code": "SUMMER2025",
"value": 500
}
],
"customer": {
"email": "customer@example.com",
"first_name": "John",
"last_name": "Doe",
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"address1": "123 Elm Street",
"address2": "Apt 4B",
"city": "New York",
"province": "NY",
"country": "US",
"zip": "10001",
"phone": "+1234567890",
"name": "John Doe",
"province_code": "NY",
"country_code": "US"
}
}
}
}
```
#### Webhook headers
Each webhook request includes the following headers to help businesses identify and validate the request:
| **Header key** | **Description** |
| --------------------- | -------------------------------------------------- |
| `x-store-url` | Specifies the store URL associated with the event |
| `x-webhook-topic` | Indicates the subscribed topic |
| `x-webhook-version` | Displays the webhook version |
| `x-webhook-signature` | Provides the HMAC signature to verify authenticity |
| `x-request-id` | Assigns a unique identifier for the request |
| `User-Agent` | Identifies the request as `Ecom360-v1` |
| `Content-Type` | Defines the payload format (`application/json`) |
* **Identify high-value customers**\
Find loyal buyers and potential repeat customers to boost engagement.
## Success rate analytics
Success rate shows the percentage of successful transactions. Tracking success rate helps you spot payment issues and create a smoother checkout.
### Transaction analytics
* **Monitor success rates by payment method**\
See which payment methods work best, for example UPI and card, and identify issues.
* **Detailed gateway and method insights**\
Check success rate by each gateway to understand and optimise your payment options.
## Volume analytics
Volume analytics shows how much each payment method contributes to total sales.
* **View payment volume across methods**\
Understand which payment types your customers prefer, for example, UPI or wallet.
* **Customer payment preferences**\
Use these insights to adjust payment options based on customer trends.
## Regional insights
Regional insights provide visibility into where your customers are transacting from. The dashboard displays the successful transaction volumes segmented by states and regions, helping you track business performance geographically.
**Example**\
In the example shown above, Maharashtra contributed the highest transaction volume with 13,741 successful transactions. Delhi, Gujarat, Uttar Pradesh, and West Bengal each recorded five successful transactions, while Karnataka recorded four successful transactions during the same period.
Use these insights to identify high-performing regions, optimise marketing spend, and understand customer behaviour across geographies.
## Event categories
Events are organised into different categories based on where they are triggered and what they track. You can track customer interactions in your integration by using the following event categories:
* Checkout
* One Click Checkout (OCC)
### Checkout events
Use these events to track customer interactions in the standard checkout flow, including checkout pages, payment links, and payment forms.
#### Client-side Checkout events
Client-side events are triggered in the browser or app when customers interact with the checkout interface.
| Event name | Description |
| ---------------------------------- | ------------------------------------------ |
| `cf_checkout_load` | Checkout loaded successfully. |
| `cf_checkout_transaction_initiate` | Customer initiated a transaction. |
| `cf_transaction_success` | Transaction completed successfully. |
| `cf_transaction_failure` | Transaction failed. |
| `cf_retry_checkout` | Redirected to checkout after failure. |
| `cf_return_to_merchant` | Customer redirected back to merchant page. |
#### Client-side payment link and payment form events
| Event name | Description |
| ----------------------- | ----------------------------------------------- |
| `cf_pl_load` | Payment link loaded successfully. |
| `cf_pf_load` | Payment form loaded successfully. |
| `cf_checkout_initiated` | Checkout initiated from a payment link or form. |
| `cf_purchase_completed` | Payment completed successfully. |
### One click checkout (OCC) events
Use these events to track customer interactions in the One Click Checkout (OCC) flow. OCC events are available for server-side and client-side tracking.
#### Server-side events
Server-side events are pushed to Google Analytics 4 (GA4) and Meta Facebook.
| GA4 event | Meta Facebook event |
| ------------------------------------ | ------------------------------------ |
| `begin_checkout` (standard event) | `InitiateCheckout` (standard event) |
| `cf_checkout_login_otp_sent` | `cf_checkout_login_otp_sent` |
| `cf_checkout_login_verify` | `cf_checkout_login_verify` |
| `add_shipping_info` (standard) | `cf_checkout_address_collected` |
| `cf_checkout_payment_info_displayed` | `cf_checkout_payment_info_displayed` |
| `add_payment_info` (standard) | `AddPaymentInfo` (standard event) |
| `purchase` (standard) | `purchase` (standard event) |
#### Client-side events
Client-side events are triggered in the browser or app when customers interact with OCC pages.
| Event name | Description |
| ---------------------------------- | -------------------------------------------- |
| `cf_checkout_occ_load` | First page or login page loaded. |
| `cf_checkout_login_verify` | OTP verified. |
| `cf_checkout_login_otp_sent` | OTP sent. |
| `cf_checkout_address_load` | Addresses loaded. |
| `cf_checkout_address_collected` | Address save or continue clicked. |
| `cf_checkout_load` | Payment page opened. |
| `cf_checkout_transaction_initiate` | Order payment transaction initiated. |
| `cf_checkout_offer_apply` | Offer applied. |
| `cf_checkout_offer_remove` | Offer removed. |
| `cf_checkout_order_cancelled` | Order cancelled. |
| `cf_checkout_address_deleted` | Address deleted. |
| `cf_checkout_address_updated` | Address updated. |
| `transaction_success` | Triggered only for non-Shopify integrations. |
## Setup instructions
Follow the platform-specific instructions below to configure your analytics integration.
**Verification**:
* In GA4, go to **Reports > Realtime Overview**.
* Perform a test transaction.
* Events should appear in real time.
4. Generate an **Access Token**:
* Scroll to **Conversions API**.
* Select **Generate Access Token**.\
5. In Cashfree’s configuration modal, enter the Pixel ID and Access Token.
6. Select **Save**.
**Verification**:
1. Navigate to **Data Source** tab under Events Manager.
2. Select your particular Pixel ID, click on **Overview**.
Here, you see the list of events coming, if there is some activity on the OCC.
3. Select **Link** (top-right).
4. Choose **Google Ads accounts** and pick the account(s) you want to link.
5. Select the checkbox next to the account and choose **Confirm**.
6. On the next screen, ensure **Enable personalised advertising** and **Enable auto tagging** are turned on (they should be on by default). Keep both enabled where possible.
* Personalised advertising lets you use GA4 audiences for remarketing in Google Ads.
* Auto tagging adds the gclid parameter to your ad URLs so GA4 can attribute clicks and conversions to Google Ads campaigns.
7. Select **Next**, review the settings, then select **Submit**.
Allow up to 24 hours for data to start flowing between the two platforms.
### Step 3: Import the purchase conversion into Google Ads
After linking and once data has synced, import the GA4 conversion into Google Ads.
1. Sign in to your Google Ads account.
2. From the left menu, select **Goals**.
3. Under **Conversion**, select **Summary**.
4. Select **+ Create conversion action**.
5. Choose **Import**.
6. Select **Google Analytics 4 properties**, choose **Web**, then select **Continue**.
7. Select the **purchase** event (or other conversions you want to track) from the list of GA4 key events.
8. Select **Import and continue**, then select **Done**.
### Step 4: Configure the purchase conversion in Google Ads
1. On the **Conversions** summary page, find the purchase conversion you imported.
2. Select the conversion name to edit settings.
3. Set **Value** to **Use the value from Google Analytics** so the purchase amount is passed into Google Ads dynamically.
4. Set **Action optimisation** to **Primary action** so Google Ads can use this conversion for bidding optimisation.
When setup is complete, start analysing conversion data in both platforms.
## Abandoned orders report
You can view and download corresponding reports from the payment gateway dashboard > Reports section.
## Activation
You can reach out to us by filling out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for activation with the following details:
* Duration after which the message should be sent
* Offer details to nudge customer. The offer can be a flat amount or a percentage value (Optional).
# Go Live Checklist
Source: https://www.cashfree.com/docs/payments/checkout/checklist
Verify your One Click Checkout configurations with this checklist before you go live.
After Cashfree One Click Checkout is successfully integrated with your Shopify Preview Store, ensure and verify the following configurations to get the maximum conversions on the Checkout.
## Shopify dashboard
### Products
Ensure Cashfree is added as Sales Channel for all your products in Shopify.
1. Navigate to **Products** > All in your Shopify store admin.
2. Select all the products and click **Include in sales channels**.
3. Select **Cashfree-OCC-** sales channel and click **Include products** to save.
Once done, Cashfree Checkout will open for all these products when added in the cart and proceeding to checkout.
### Taxes
Ensure **Inclusive Taxes** is set up since Cashfree Checkout is compatible with this setting.
1. Navigate to **Settings > Taxes and duties** in your Shopify store admin.
2. Scroll to **Global settings** and select the **Include sales tax in product price and shipping rate** check box. Click **Save**.
## Cashfree dashboard
### Payments
* Verify **Online Payments** are set up for your account.
* Check that the Online Payment Gateway is activated. Note that Payment Gateway is shown in Products Activated section on Merchant Dashboard.
* Check that online payment methods like **UPI** and **Cards** are activated in the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)** and go to **Payment Gateway > Settings > Payment Methods**.
### COD and RTO
* Verify **COD** is set up for your account.
* Configure **COD** (or **Partial COD**) rules. Click [here](https://www.cashfree.com/docs/payments/checkout/cod/overview) to understand COD management.
* Set up **RTO Intelligence** and COD configurations to manage RTO. Click [here](https://www.cashfree.com/docs/payments/checkout/cod/blacklist-cod) to understand RTO tools.\
Reach out to [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for this configuration.
### Gift card and store credit apps
* OCC doesn't support Shopify or custom Gift Card and Store Credit Apps.
* Add a **custom CTA** above/below Checkout button to redirect shoppers to Shopify Checkout.
Reach out to [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for this configuration.
### Loyalty and rewards apps
* OCC doesn't support third-party Loyalty Apps.
* Add a **custom CTA** above/below Checkout button to redirect shoppers to Shopify Checkout.
Reach out to [Cashfree support](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for this configuration.
# Go Live Checklist
Source: https://www.cashfree.com/docs/payments/checkout/checklist-deprecated
Verify your One Click Checkout configurations with this checklist before you go live.
Have you checked if UPI and other payment modes are working?
Test this on your Preview Store in [Shopify](https://admin.shopify.com/).
Have you enabled COD/Partial COD, and is it working as expected?
You can set up COD on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/cod).
Have you set up any blocking on COD?
You can set up blocking on COD on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/cod/blacklist-details?blackListItem=customers).
Are you using RTO intelligence?
You can enable RTO intelligence from [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/cod).
Have you added shipping provider credentials for advanced RTO capability?
You can connect your shipping provider on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/cod).
Has Facebook Pixel, Google Analytics, or Google Ads been set up correctly and configured on the dashboard?
You can configure event tracking on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/developers/checkout-analytics).
Have additional tracking scripts been added in [Shopify](https://admin.shopify.com/) settings?
You can configure event tracking on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/developers/checkout-analytics).
Has the Google Analytics Server-to-Server setup been completed?
You can configure event tracking on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/developers/checkout-analytics).
Is conversion data being updated correctly on the dashboard?
You can check conversion data on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/analytics).
Is abandoned checkout data being pushed correctly?
Check this on the [Shopify](https://admin.shopify.com/) dashboard.
Are you using recovery campaign functionality?
You can set up a recovery campaign on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/recovery-campaign).
Are discounts working as expected?
You can check Cashfree offers and promotions on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/offersV2).
Are shipping rates correctly set up and visible to customers?
You can set up shipping rates on the [Merchant Dashboard](https://merchant.cashfree.com/merchants/pg/one-click-checkout-activated/shipping-delivery).
Is notifications and other messages working as expected?
You can check this on the [Shopify](https://admin.shopify.com/) dashboard.
Are checkout-related third-party apps working as expected?
You can check this on the [Shopify](https://admin.shopify.com/) dashboard.
Are supported bundling apps functioning correctly?
You can check this on the [Shopify](https://admin.shopify.com/) dashboard.
Are supported loyalty apps working as intended?
You can check this on the [Shopify](https://admin.shopify.com/) dashboard.
### To blacklist by product:
1. In the Add Product ID to Blacklist window:
* To block a single product, select Single Product ID and enter the product ID.
* To block multiple products, select Multiple Product IDs and upload a .csv file containing product IDs.
### To blacklist by pincode:
1. In the Add Pincodes to Blacklist window:
* To block a single pincode, select Single Pincode and enter the pincode.
* To block multiple pincodes, select Multiple Pincodes and upload a .csv file with pincode values.
# Configure Cash on Delivery
Source: https://www.cashfree.com/docs/payments/checkout/cod/configure
Learn more about configuring Cash on Delivery
Cashfree Payments lets you set rules for handling Cash on Delivery (COD) transactions. You can define rules based on transaction amount, specify COD types, apply handling fees, and enable partial payment collection. These configurations give customers more flexibility and help increase conversions.
## Key features
* **Partial COD support**: Collect a flat amount or a percentage of the order value upfront. This helps reduce RTOs, improve order reliability, and manage risk for high-value or first-time orders—while offering customers flexible payment options and protecting your business.
* **Flexible COD rules**: Set minimum and maximum order amounts to control COD eligibility.
* **Custom transaction types**: Choose between full COD or Partial COD based on your business needs.
* **Handling fee configuration**: Apply handling fees for COD orders to offset delivery risks or costs.
* **Tiered rule setup**: Create multiple slabs to apply different COD rules for different order ranges.
## Configuring COD
To configure COD:
1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/auth/login)**.
2. Under **One-Click Checkout**, select **Access**.
3. In the left pane, select **COD & RTO**.
4. Select the **Configuration** tab.
5. Under **Configure COD Rules**, do the following:
* In **Transaction Amount**, set the **Min Amount** and **Max Amount** for COD.
* Under **Transaction Type**, choose one of the following:
* **COD**: Enter a value in the **Handling Fee** field.
* **Partial COD**: Specify the advance amount to collect. Choose a **Flat Amount** or **Percentage** of the order value.
6. To define more COD rules, select **Add Another Slab**.
7. Select **Confirm** to save your settings.
# Customise Checkout
Source: https://www.cashfree.com/docs/payments/checkout/customise-checkout
Customise the checkout experience to match your brand identity and ensure a seamless transition for your customers.
The *Canvas* branding dashboard aims to enable you to customise every visual detail of all the components present in the checkout page to make it look like a true extension of your own platform. This helps in instilling trust in customers regarding the authenticity of the checkout page and makes the visual transition from your platform to checkout much smoother.