PATCH
/
pg
/
vba
/
{virtual_account_id}
curl --request PATCH \
  --url https://sandbox.cashfree.com/pg/vba/{virtual_account_id} \
  --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 '{
  "bank_codes": "YESB",
  "status": "ACTIVE"
}'
{
  "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": "user@cashfree.com",
        "virtual_account_phone": 9876543210
      },
      "kyc_details": {
        "gst": "29AAICP2912R1ZR",
        "pan": "ABCPV1234D",
        "aadhar": "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 id generated from the merchant dashboard

​
x-client-secret
string
required

client secret generated from 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 Payments.

Example:

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

Path Parameters

​
virtual_account_id
string
required

It is the unique ID you created to identify the virtual bank account.

Example:

"User01"

Body

application/json

PG VBA Manage Request

​
bank_codes
enum<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.

Available options:
YESB,
ICIC,
UTIB
​
status
enum<string>

It is the status to which you want to modify the virtual bank account.

Available options:
ACTIVE,
INACTIVE

Response

200
application/json
Success Response.
​
virtual_bank_accounts
object[]

It contains the details of the virtual bank account.

Was this page helpful?