Telr Developer Documentation

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

{
  "message": "bad URL, please check API documentation",
  "code": "request_failed",
  "type": "invalid_request_error"
}

{
  "message": "authentication Failed",
  "code": "request_failed",
  "type": "authentication_error"
}

{
  "message": "something is not found",
  "code": "somethind_not_found",
  "type": "invalid_request_error"
}

{
  "message": "Too many requests from IP. Check headers",
  "code": "request_failed",
  "type": "rate_limit_error"
}

{
  "message": "internal Server Error",
  "code": "internal_error",
  "type": "api_error"
}

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

{
  "message": "bad URL, please check API documentation",
  "code": "request_failed",
  "type": "invalid_request_error"
}

{
  "message": "authentication Failed",
  "code": "request_failed",
  "type": "authentication_error"
}

{
  "message": "something is not found",
  "code": "somethind_not_found",
  "type": "invalid_request_error"
}

{
  "message": "Too many requests from IP. Check headers",
  "code": "request_failed",
  "type": "rate_limit_error"
}

{
  "message": "internal Server Error",
  "code": "internal_error",
  "type": "api_error"
}

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:2023-08-01

required

API version to be used

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

Request Body to Make Simulation

simulate payment request object

entity

enum<string>

required

Entity type should be PAYMENTS, SUBS_PAYMENTS OR VBA_TRANSFER only.

Available options:

PAYMENTS,

SUBS_PAYMENTS,

VBA_TRANSFER

entity_id

string

required

If the entity type is PAYMENTS, the entity_id will be the cf_payment_id. If the entity type is SUBS_PAYMENTS, the entity_id will be the payment_id. If the entity type is VBA_TRANSFER, the entity_id will be vba_account_number

entity_simulation

entity_simulation · object

Entity Simulation contains payment_status and payment_error_code

Show child attributes

Example:

{
  "payment_status": "FAILED",
  "payment_error_code": "ISSUER_NOT_AVAILABLE"
}

vba_simulation

vba_simulation · object

VBA Simulation contains VBA and Remitter information for simulation

Show child attributes

Example:

{
  "vba_ifsc": "YESB0CMSNOC",
  "utr": "utr",
  "amount": 10,
  "remitter_account": "808081pxqp242614HW",
  "remitter_ifsc": "IFSC",
  "remitter_name": "Test",
  "phone": "1234567891"
}

Response

Payment Simulated Response

Simulation response object

simulation_id

string

entity

string

entity_id

string

entity_simulation

entity_simulation · object

Entity Simulation contains payment_status and payment_error_code

Show child attributes

Example:

{
  "payment_status": "FAILED",
  "payment_error_code": "ISSUER_NOT_AVAILABLE"
}