Skip to main content
POST
/
gc
/
transactions
/
emulate
Simulate funding to mimic scenario when payment hits the virtual account
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

Successfully simulated funding

ā€‹
status
string
Example:

"SUCCESS"

ā€‹
subCode
string
Example:

"200"

ā€‹
message
string
Example:

"success_message"