POST
/
simulate
curl --request POST \
--url https://sandbox.cashfree.com/pg/simulate \
--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 '{
"entity": "PAYMENTS",
"entity_id": "14934289844",
"entity_simulation": {
"payment_status": "FAILED",
"payment_error_code": "ISSUER_NOT_AVAILABLE"
}
}'
{
  "simulation_id": "sim_2900842gV18Lhh7owswLj5XF0uHHUn1CX",
  "entity": "PAYMENTS",
  "entity_id": "14934289844",
  "entity_simulation": {
    "payment_status": "FAILED",
    "payment_error_code": "ISSUER_NOT_AVAILABLE"
  }
}

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 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

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

Request Body to Make Simulation

simulate payment request object

Response

200
application/json

Payment Simulated Response

Simulation response object