Cashfree Payments Developer Documentation

Create Virtual Bank Account

curl --request POST \
  --url https://sandbox.cashfree.com/pg/vba \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "virtual_account_details": {
    "virtual_account_id": "User01",
    "virtual_account_name": "John Doe",
    "virtual_account_email": "[email protected]",
    "virtual_account_phone": 9876543210
  },
  "kyc_details": {
    "gst": "29AAICP2912R1ZR",
    "pan": "ABCPV1234D",
    "aadhaar": 655675523712
  },
  "remitter_lock_details": {
    "allowed_remitters": [
      {
        "account_number": 26291800001191,
        "ifsc": "YESB0000262"
      }
    ]
  },
  "amount_lock_details": {
    "min_amount": 1000,
    "max_amount": 5000
  },
  "bank_codes": [
    "YESB"
  ],
  "notification_group": "finance_team"
}
'

{
  "virtual_bank_accounts": [
    {
      "vba_bank_code": "UTIB",
      "vba_account_number": 94351020001772,
      "vba_ifsc": "UTIB0CCH274",
      "vba_status": "ACTIVE",
      "vba_created_on": "2019-08-24T14:15:22Z",
      "vba_last_updated_on": "2019-08-24T14:15:22Z",
      "virtual_account_details": {
        "virtual_account_id": "User01",
        "virtual_account_name": "John Doe",
        "virtual_account_email": "[email protected]",
        "virtual_account_phone": 9876543210
      },
      "kyc_details": {
        "gst": "29AAICP2912R1ZR",
        "pan": "ABCPV1234D",
        "aadhaar": "655675523712"
      },
      "remitter_lock_details": {
        "allowed_remitters": [
          {
            "account_number": "026291800001191",
            "ifsc": "YESB0000262"
          }
        ]
      },
      "amount_lock_details": {
        "min_amount": 1000,
        "max_amount": 5000
      },
      "notification_group": "<string>"
    }
  ]
}

POST

vba

Create Virtual Bank Account

curl --request POST \
  --url https://sandbox.cashfree.com/pg/vba \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "virtual_account_details": {
    "virtual_account_id": "User01",
    "virtual_account_name": "John Doe",
    "virtual_account_email": "[email protected]",
    "virtual_account_phone": 9876543210
  },
  "kyc_details": {
    "gst": "29AAICP2912R1ZR",
    "pan": "ABCPV1234D",
    "aadhaar": 655675523712
  },
  "remitter_lock_details": {
    "allowed_remitters": [
      {
        "account_number": 26291800001191,
        "ifsc": "YESB0000262"
      }
    ]
  },
  "amount_lock_details": {
    "min_amount": 1000,
    "max_amount": 5000
  },
  "bank_codes": [
    "YESB"
  ],
  "notification_group": "finance_team"
}
'

{
  "virtual_bank_accounts": [
    {
      "vba_bank_code": "UTIB",
      "vba_account_number": 94351020001772,
      "vba_ifsc": "UTIB0CCH274",
      "vba_status": "ACTIVE",
      "vba_created_on": "2019-08-24T14:15:22Z",
      "vba_last_updated_on": "2019-08-24T14:15:22Z",
      "virtual_account_details": {
        "virtual_account_id": "User01",
        "virtual_account_name": "John Doe",
        "virtual_account_email": "[email protected]",
        "virtual_account_phone": 9876543210
      },
      "kyc_details": {
        "gst": "29AAICP2912R1ZR",
        "pan": "ABCPV1234D",
        "aadhaar": "655675523712"
      },
      "remitter_lock_details": {
        "allowed_remitters": [
          {
            "account_number": "026291800001191",
            "ifsc": "YESB0000262"
          }
        ]
      },
      "amount_lock_details": {
        "min_amount": 1000,
        "max_amount": 5000
      },
      "notification_group": "<string>"
    }
  ]
}

Headers

x-client-id

string

required

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret

string

required

Client secret key. You can find your secret key in the Merchant Dashboard.

x-api-version

enum<string>

required

API version to be used. The accepted format is YYYY-MM-DD.

Available options:

2024-07-10T00:00:00.000Z

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.

Example:

"4dfb9780-46fe-11ee-be56-0242ac120002"

Body

application/json

Request parameters for creating a virtual bank account.

virtual_account_details

object

It contains the details of the virtual bank account.

Show child attributes

virtual_account_details.virtual_account_id

string

It is the unique ID you create to identify a virtual bank account. The parameter allows only alphanumeric characters.

Example:

"User01"

virtual_account_details.virtual_account_name

string

It is the unique name you give to identify a virtual bank account. The parameter allows alphanumeric characters and whitespaces.

Example:

"John Doe"

virtual_account_details.virtual_account_email

string

It is the email ID to associate with the virtual bank account.

Example:

"[email protected]"

virtual_account_details.virtual_account_phone

string

It is the phone number to associate with the virtual bank account.

Example:

9876543210

kyc_details

object

It contains the KYC information of the virtual bank account holder.

Show child attributes

kyc_details.gst

string

It is the GSTIN information to associate with the virtual bank account.

Example:

"29AAICP2912R1ZR"

kyc_details.pan

string

It is the PAN information to associate with the virtual bank account.

Example:

"ABCPV1234D"

kyc_details.aadhaar

string

It is the aadhaar information to associate with the virtual bank account.

Example:

655675523712

remitter_lock_details

object

It contains the bank account information of the remitter.

Show child attributes

remitter_lock_details.allowed_remitters

object[]

Show child attributes

remitter_lock_details.allowed_remitters.account_number

string

It is the bank account number of the remitter.

Example:

26291800001191

remitter_lock_details.allowed_remitters.ifsc

string

It is the IFSC information associated with the bank account number.

Example:

"YESB0000262"

amount_lock_details

object

It contains the details of the amount for the remittance at VBA account level.

Show child attributes

amount_lock_details.min_amount

integer

It is the minimum amount for the remittance.

Example:

1000

amount_lock_details.max_amount

integer

It is the maximum amount for the remittance.

Example:

5000

bank_codes

string[]

It is the respective code used to create a virtual bank account in the corresponding bank. UTIB - Axis Bank ICIC - ICICI Bank YESB - Yes Bank Each bank code corresponds to a specific bank name.

notification_group

string

It is the group you created with the recipients to receive notificiations regarding the payment details. The parameter allows alphanumeric characters, hyphen (-), underscore

Example:

"finance_team"

Response

Success response for creating a virtual bank account.

virtual_bank_accounts

object[]

It contains the details of the virtual bank account.

Show child attributes

virtual_bank_accounts.vba_bank_code

string

It displays the respective bank code you used to create the virtual bank account.

Example:

"UTIB"

virtual_bank_accounts.vba_account_number

string

It displays the account number of the virtual bank account.

Example:

94351020001772

virtual_bank_accounts.vba_ifsc

string

It displays the IFSC information of the virtual bank account.

Example:

"UTIB0CCH274"

virtual_bank_accounts.vba_status

string

It displays the status of the virtual bank account.

Example:

"ACTIVE"

virtual_bank_accounts.vba_created_on

string

It displays the creation date and time of the virtual bank account.

Example:

"2019-08-24T14:15:22Z"

virtual_bank_accounts.vba_last_updated_on

string

It displays the updation date and time of the virtual bank account.

Example:

"2019-08-24T14:15:22Z"

virtual_bank_accounts.virtual_account_details

object

It contains the details of the virtual bank account.

Show child attributes

virtual_bank_accounts.virtual_account_details.virtual_account_id

string

It displays the unique ID of the virtual bank account.

Example:

"User01"

virtual_bank_accounts.virtual_account_details.virtual_account_name

string

It displays the name of the virtual bank account.

Example:

"John Doe"

virtual_bank_accounts.virtual_account_details.virtual_account_email

string

It displays the email address associated with the virtual bank account.

Example:

"[email protected]"

virtual_bank_accounts.virtual_account_details.virtual_account_phone

string

It displays the phone number associated with the virtual bank account.

Example:

9876543210

virtual_bank_accounts.kyc_details

object

It contains the KYC information of the virtual bank account holder.

Show child attributes

virtual_bank_accounts.kyc_details.gst

string

It is the GSTIN information to associate with the virtual bank account.

Example:

"29AAICP2912R1ZR"

virtual_bank_accounts.kyc_details.pan

string

It is the PAN information to associate with the virtual bank account.

Example:

"ABCPV1234D"

virtual_bank_accounts.kyc_details.aadhaar

string

It is the aadhaar information to associate with the virtual bank account.

Example:

"655675523712"

virtual_bank_accounts.remitter_lock_details

object

It contains the bank account information of the remitter.

Show child attributes

virtual_bank_accounts.remitter_lock_details.allowed_remitters

object[]

Show child attributes

virtual_bank_accounts.remitter_lock_details.allowed_remitters.account_number

string

It is the bank account number of the remitter.

Example:

"026291800001191"

virtual_bank_accounts.remitter_lock_details.allowed_remitters.ifsc

string

It is the IFSC information associated with the bank account number.

Example:

"YESB0000262"

virtual_bank_accounts.amount_lock_details

object

It contains the details of the amount for the remittance.

Show child attributes

virtual_bank_accounts.amount_lock_details.min_amount

integer

It is the minimum amount for the remittance.

Example:

1000

virtual_bank_accounts.amount_lock_details.max_amount

integer

It is the maximum amount for the remittance.

Example:

5000

virtual_bank_accounts.notification_group

string

Webhooks Edit VBA

⌘I

Payments API

v2025-01-01

Other Versions

Create VBA

Headers

Body

Response