POST
/
gc
/
transactions
/
emulate
curl --request POST \
  --url https://sandbox.cashfree.com/gc/transactions/emulate \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-partner-api-key: <x-partner-api-key>' \
  --header 'x-partner-merchantid: <x-partner-merchantid>' \
  --data '{
  "vAccountNumber": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "fundingActions": "<string>",
  "remitterAccountNumber": "<string>"
}'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "success_message"
}

Based on who you are, consider the below values in the API requests

Cashfree MerchantCashfree Partner
x-client-idx-partner-api-key
x-client-secretx-partner-merchantid

Headers

x-partner-api-key
string
required

Enter partner API keygit

x-partner-merchantid
string
required

Enter the merchant reference id used while creating merchant during onboarding

x-api-version
string
required

API version

Body

application/json
vAccountNumber
string
required

Pass the receiving bank account number for which you want to simulate the funding.

amount
string
required

Enter the amount for which the funding has to be simulated.

currency
string
required

Enter the three character ISO.

fundingActions
string
required

Provide the action you want to do with the funding.

remitterAccountNumber
string
required

Provide the remitter account number.

Response

200
application/json
Successfully simulated funding
status
string
Example:

"SUCCESS"

subCode
string
Example:

"200"

message
string
Example:

"success_message"