Fetch Multiple Virtual Accounts
Get a list of virtual accounts created for payments.
Overview
Use this API to fetch all virtual accounts belonging to your Sandbox subscription. Accounts to be fetched can be filtered by their status
or filter_id
associated with them.
Problem
- It is difficult to maintain a large list of virtual accounts
Solution
- This API will provide an array of virtual account details associated with your Sandbox Subscription.
- By passing the
filter_id
in the query parameters, you can fetch accounts that match the string requirements.
Endpoint
HTTP Method | Resource |
---|---|
GET | /tax-payment/accounts |
Request
If needed, you can pass the filter_id and status in the query parameters.
Query Parameters
Param | Type | Description | Example |
---|---|---|---|
status | string | Used to retrieve only accounts that have a given status. Possible values: - Active - Inactive | Active |
filter_id | string | Filter Id provided during creating virtual payment account | customer |
Sample CURL
curl --request GET \
--url 'https://api.sandbox.co.in/tax-payment/accounts?status=Active&filter_id=customer' \
--header 'Accept: application/json' \
--header 'Authorization: xxxxxxxxxxx' \
--header 'x-api-key: xxxxxxxxxxx'
Test Environment Not Available
Response
The API responds back with an array of Virtual Bank 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": "customer",
"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 Multiple Virtual Bank Accounts 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 about 1 month ago