Skip to main content
Use this guide to access detailed sample data and inputs for testing your API integration across multiple scenarios.

​
Set up Easy Split in sandbox

You can enable Easy Split on your own merchant ID in sandbox without raising a request with Cashfree.
Before you start, make sure you have the following:
  • Sandbox API credentials (client ID and client secret).
  • The x-api-version header set on every API request. Use 2026-01-01, the version these endpoints are documented in.
  • A webhook endpoint configured to receive vendor settlement webhooks. For details, see Vendor Settlement Webhook.
Call the Enable Easy Split API only once for each merchant ID. The API is not idempotent, so each repeat call provisions another pair of sample vendors.
To set up and test Easy Split in sandbox, follow these steps:
  1. Call Enable Easy Split. The API returns 202 with an empty body and provisions two sample vendors asynchronously:
    • A bank account vendor.
    • A UPI vendor with VPA success@upi.
  2. Poll Fetch Easy Split Status until status is ACTIVE. The other possible values are HOLD, NOT_ACTIVE, RISK_APPROVAL_PENDING and RISK_REJECTED. If the status does not reach ACTIVE within a few minutes, see the troubleshooting section that follows these steps.
  3. Log in to the Merchant Dashboard, click Switch to Test to enter the test environment, and go to Payment Gateway Dashboard > Easy Split > Vendors. The Vendor ID column shows the merchant_vendor_id of each sample vendor. Copy these IDs, because you need them in the next two steps.
  4. Create an order with a vendor split by setting the order_splits field on the Create Order API, and complete the payment. For an example request, see Split a payment.
  5. Call Simulate Vendor Settlement to move the vendor settlement to INITIATED, SUCCESS or FAILED instead of waiting for the settlement cycle. Provide merchant_order_ids or txn_time. If you omit both, the API returns a 404 error. Unlike the Simulate Settlement API, txn_time has no 7-day limit. If you use txn_time, pass a time earlier than the payment’s transaction time. A value equal to the transaction time does not match.
You receive the VENDOR_SETTLEMENT_* webhook that corresponds to the status you simulated.
To receive the resulting VENDOR_SETTLEMENT_* webhooks, configure a webhook endpoint at Payment Gateway > Developers > Webhooks on the Merchant Dashboard. Subscribe to each event separately using webhook version 2025-01-01. This is the webhook subscription version you select per event, not the x-api-version header on your API calls. Vendor settlement webhooks are not delivered on any other webhook version.To test a reversal, settle to the bank account listed as Success (later reversed) in the bank account numbers table and let the settlement cycle run. Reversal is not available through the simulation API.

​
Troubleshooting

Use the following guidance if setup does not behave as expected.
Confirm that your webhook endpoint is configured and that you subscribed to each VENDOR_SETTLEMENT_* event separately with webhook version 2025-01-01. Subscribing to one event does not enable the others.
Onboarding runs asynchronously after you call the Enable Easy Split API, so allow a few minutes before you poll. If the status still does not reach ACTIVE, raise a request through the Support Form with your merchant ID and sandbox environment details.
The API returns 404 with the message No eligible vendor transactions found to settle when it finds no vendor transactions to settle. This usually means the request omits both merchant_order_ids and txn_time, or the merchant_vendor_id does not match a vendor on your account. Copy the vendor ID from the Vendor ID column under Payment Gateway Dashboard > Easy Split > Vendors, and provide merchant_order_ids or txn_time in the request.

​
Schedule options supported

The table below lists the available settlement schedule options you can configure with Easy Split payments. Each option specifies when funds will be settled based on the timing of transactions.

​
List of business types

Refer to the table below for supported business types to simulate and test various Easy Split payment scenarios during integration.

​
List of account types

Refer to the table below for supported account types to configure split payments. These account types allow you to specify the beneficiary accurately in your API integration and test various scenarios.

​
Sample bank account numbers, UPI and VPA

Use the bank accounts and VPAs listed below to force settlement outcomes through a real settlement cycle, as an alternative to the simulation API. Bank account numbers Refer to the table below for sample bank account numbers and IFSC codes to simulate various vendor settlement outcomes during bank transfer integration testing. UPI To test UPI transfers, specify the vendor’s UPI Virtual Payment Address (VPA) when adding the vendor. Refer to the table below for sample VPAs to simulate various UPI transfer outcomes during testing.

​
Test details

GSTIN details Refer to the sample GSTINs in the table below to simulate various tax validation scenarios during integration testing. PAN details Refer to the sample PAN details below to simulate identity verification and compliance scenarios during integration testing. Passport details Refer to the sample passport details below to simulate identity verification scenarios during integration testing. The video below provides a step-by-step guide to adding a new vendor via API.