POST
/
simulate
/
settlement
curl --request POST \
  --url https://sandbox.cashfree.com/pg/simulate/settlement \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "merchantOrderIds": [
    "7b6bd177-ce98-43bd-b4b2-0d341fbb0d63",
    "7b6bd2b7-c8h8-43bd-7g2h-9hc98h3482h2",
    "99bfb2b7-c8h8-0hbd-7g93-9uw9hg93bh93"
  ],
  "status": "SUCCESS"
}'
{
  "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.

Body

application/json

The request body for simulating a settlement.

Object to simulate a settlement request.

Response

Settlement simulation response.

Object to simulate a settlement request.