Fetch Virtual Account
Get details of a single virtual account
Overview
Fetch a virtual bank account by taking in its account_number
and receiving the account details.
Problem
- To fetch relevant account details associated with an account number.
Solution
- API that provides account details to facilitate a bank transfer.
Endpoint
HTTP Method | Resource |
---|---|
GET | /tax-payment/accounts/{account_number} |
Request
Follow the below guidelines to pass account_number
to fetch the virtual bank account
Path Parameter
Param | type | Description | Example |
---|---|---|---|
account_number | string | Virtual account number | HEY564578321596 |
Sample CURL request
curl --request GET \
--url https://api.sandbox.co.in/tax-payment/accounts/HEY564578321596 \
--header 'Accept: application/json' \
--header 'Authorization: xxxxxxxxxx' \
--header 'x-api-key: xxxxxxxx'
Test Enviroment Not Available
Response
The API responds back with Virtual Account Entity. An example response is shown below.
{
"code": 200,
"timestamp": 1631095323168,
"transaction_id": "8831d466-6fe7-48ed-b478-7d1cb4e92572",
"data": {
"@entity": "virtual_bank_account",
"account_number": "HEYSBX0****01",
"status": "Active",
"ifsc": "ICIC***25",
"notes": {},
"filter_id": "",
"opened_at": 1666155630494
}
}
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Fetch Virtual Bank Account is not a Paid API, no wallet charge will take place.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated 4 months ago