v2025-01-01
- Overview
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Easy-Split
- Payment Methods
- Offers
- Token Vault
- Disputes
- Settlements
- softPOS
- Simulation
- Subscription
- VBA
- Cross Border
- Utilities
Other Versions
- v2023-08-01
- End Points
- Release Notes
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Easy-Split
- Eligibility
- Offers
- Dispute
- Settlements
- Partners
- Token Vault
- softPOS
- Simulation
- Subscription
- VBA
- Manage VBA
- Payments
- Notification Group
- Cross Border
- v2022-01-01
Get VBA Payments
Use this API to get the details of the created virtual bank account by entering the virtual account ID.
curl --request GET \
--url https://sandbox.cashfree.com/pg/vba/{virtual_account_id} \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'
{
"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
client id generated from the merchant dashboard
client secret generated from the merchant dashboard
API version to be used. The accepted format is YYYY-MM-DD.
2024-07-10T00:00:00.000Z
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree Payments.
"4dfb9780-46fe-11ee-be56-0242ac120002"
Path Parameters
It is the unique ID you created to identify the virtual bank account.
"User01"
Response
It contains the details of the virtual bank account.
It displays the respective bank code you used to create the virtual bank account.
"UTIB"
It displays the account number of the virtual bank account.
94351020001772
It displays the IFSC information of the virtual bank account.
"UTIB0CCH274"
It displays the status of the virtual bank account.
"ACTIVE"
It displays the creation date and time of the virtual bank account.
"2019-08-24T14:15:22Z"
It displays the updation date and time of the virtual bank account.
"2019-08-24T14:15:22Z"
It contains the details of the virtual bank account.
It displays the unique ID of the virtual bank account.
"User01"
It displays the name of the virtual bank account.
"John Doe"
It displays the email address associated with the virtual bank account.
"user@cashfree.com"
It displays the phone number associated with the virtual bank account.
9876543210
It contains the KYC information of the virtual bank account holder.
It is the GSTIN information to associate with the virtual bank account.
"29AAICP2912R1ZR"
It is the PAN information to associate with the virtual bank account.
"ABCPV1234D"
It is the aadhaar information to associate with the virtual bank account.
"655675523712"
It contains the bank account information of the remitter.
It is the bank account number of the remitter.
"026291800001191"
It is the IFSC information associated with the bank account number.
"YESB0000262"
Was this page helpful?
curl --request GET \
--url https://sandbox.cashfree.com/pg/vba/{virtual_account_id} \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'
{
"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>"
}
]
}