Cashfree Payments Developer Documentation

Create Virtual Account

curl --request POST \
  --url https://sandbox.cashfree.com/payout/fundsources/connected/virtual-account \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Demo1",
  "accountPrefix": 1234
}
'

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "FundSource Details Retrieved",
  "data": {
    "id": 123,
    "fsDisplayType": "Bank Account",
    "fsDescription": "Main operational account",
    "accountHolderName": "John Doe",
    "bankName": "Bank of India",
    "balance": "1000.00",
    "availableBalance": "950.00",
    "fundsOnHold": "50.00",
    "overdraft": "0.00",
    "bankAccount": "1234567890",
    "ifsc": "BOFA0XXXXXX",
    "addedOn": "2024-01-01T12:00:00Z",
    "updatedOn": "2024-08-01T12:00:00Z",
    "fsName": "Operational Account",
    "displayName": "Main Account",
    "virtualAccount": "VA1234567890",
    "status": "ACTIVE"
  }
}

POST

fundsources

connected

virtual-account

Create Virtual Account

curl --request POST \
  --url https://sandbox.cashfree.com/payout/fundsources/connected/virtual-account \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Demo1",
  "accountPrefix": 1234
}
'

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "FundSource Details Retrieved",
  "data": {
    "id": 123,
    "fsDisplayType": "Bank Account",
    "fsDescription": "Main operational account",
    "accountHolderName": "John Doe",
    "bankName": "Bank of India",
    "balance": "1000.00",
    "availableBalance": "950.00",
    "fundsOnHold": "50.00",
    "overdraft": "0.00",
    "bankAccount": "1234567890",
    "ifsc": "BOFA0XXXXXX",
    "addedOn": "2024-01-01T12:00:00Z",
    "updatedOn": "2024-08-01T12:00:00Z",
    "fsName": "Operational Account",
    "displayName": "Main Account",
    "virtualAccount": "VA1234567890",
    "status": "ACTIVE"
  }
}

Body

application/json

Find the request parameters to create the virtual account

displayName

string

required

It is the name you want to display for the virtual account.

Example:

"Demo1"

accountPrefix

string

It is the account prefix as allocated by the bank. This paramete is mandatory during the first account creation.

Example:

1234

Response

Virtual account successfully created.

status

string

It displays the status of the request (SUCCESS/FAILURE).

Example:

"SUCCESS"

subCode

string

It displays the sub code of the request.

Example:

"200"

message

string

It displays the outcome of the request.

Example:

"FundSource Details Retrieved"

data

object

Response data.

Option 1
Option 2

Show child attributes

data.id

integer

It displays the unique ID of the fund source.

Example:

123

data.fsDisplayType

string

It displays the type of the fund source.

Example:

"Bank Account"

data.fsDescription

string | null

It displays the description of the fund source.

Example:

"Main operational account"

data.accountHolderName

string

It displays the name of the account holder.

Example:

"John Doe"

data.bankName

string

It displays the bank name.

Example:

"Bank of India"

data.balance

string<decimal>

It displays the balance amount in the fund source.

Example:

"1000.00"

data.availableBalance

string<decimal>

It displays the available balance amount in the fund source.

Example:

"950.00"

data.fundsOnHold

string<decimal>

It displays the amount on hold in the fund source.

Example:

"50.00"

data.overdraft

string<decimal>

It displays the overdraft amount of the fund source.

Example:

"0.00"

data.bankAccount

string

It displays the bank account information of the fund source.

Example:

"1234567890"

data.ifsc

string

It displays the IFSC information.

Example:

"BOFA0XXXXXX"

data.addedOn

string<date-time>

It displays the date and time of the fund source when added.

Example:

"2024-01-01T12:00:00Z"

data.updatedOn

string<date-time>

It displays the latest updation date and time of the fund source.

Example:

"2024-08-01T12:00:00Z"

data.fsName

string

It displays the name of the fund source.

Example:

"Operational Account"

data.displayName

string

It displays the display name of the fund source.

Example:

"Main Account"

data.virtualAccount

string

It displays the virtual account information.

Example:

"VA1234567890"

data.status

string

It displays the status of the fund source.

Example:

"ACTIVE"

Webhook Version V1 Transfer Funds Between VAs

⌘I

Payout APIs

V2

V1

One Escrow

Cashgram

Create Virtual Account

Body

Response