Skip to main content
GET
/
simulate
/
settlement
/
{simulation_id}
Fetch Settlement Simulation
curl --request GET \
  --url https://sandbox.cashfree.com/pg/simulate/settlement/{simulation_id} \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "simulation_id": "sim_103332852xk16dlG9zsoySmOVWTUW2t7FDv",
  "entity": "SETTLEMENTS",
  "settlement_ids": [
    "14934289844"
  ],
  "simulation_status": "SUCCESS"
}

Authorizations

ā€‹
x-client-id
string
header
required

Client app ID. You can find your app id in the merchant dashboard.

ā€‹
x-client-secret
string
header
required

Client secret key. You can find your secret key in the merchant dashboard.

Headers

ā€‹
x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD.

ā€‹
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

ā€‹
x-idempotency-key
string<UUID>

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

ā€‹
simulation_id
string
required

Provide the SimulationId for which the details have to be fetched.

Response

Fetched simulated response.

Object to simulate a settlement request.

ā€‹
simulation_id
string

A unique identifier for the simulation request.

ā€‹
entity
string

Entity type for which the simulation is performed. Example: "SETTLEMENTS".

ā€‹
settlement_ids
number[]

List of simulated settlement IDs.

ā€‹
simulation_status
string

Status of the simulation request. Example: "SUCCESS/FAILED/PENDING".