Virtual Account APIs

About

  • A virtual account is a non-physical/online bank account linked to a physical bank account
  • It has a unique account number that makes it easy to trace transactions and helps to identify the source or the payer as well

Usecase

  • Virtual Bank accounts can be used as wallets.

Entities

Virtual Payment Account Entity

ParamTypeDescriptionExample
account_numberstringBank account number. Max length: 40 charactersHEY564578321596
ifscstring11-digit alpha-numeric code used to identify the bank branchesICIC0000103
statusstringVirtual Payment Account status.
Possible values :
- Active
- Inactive
Active
notesjson objectUser notes{ "customer":"John",
"client":"quicko"}
filter_idstringUser defined reference string which will be used while fetching accounts from Sandbox's databasefilter1,filter2
opened_atnumberTime of opening the account in Unix timestamp format in milliseconds1654410610000

Fetch Accounts

Endpoint

Used to fetch all accounts for given user

HTTP MethodResourceDescription
GET/tax-payment/accountsFetches all virtual accounts belonging to your sandbox subscription

API EndpointAPI Endpoint

Query Parameters

ParamDescriptionExample
statusUsed to retrieve only accounts that have a given status.
Possible values:
- Active
- Inactive
Active

Response


Fetch Account

Endpoint

Used to fetch a given virtual account.

HTTP MethodResourceDescription
GET/tax-payment/accounts/{account_number}Fetches account details for a given virtual payment account number.

API EndpointAPI Endpoint

Response


Create New Virtual Account

Endpoint

Used to create a fresh Virtual Account

HTTP MethodResourceDescription
POST/tax-payment/accountsCreate a new Virtual Account.

API EndpointAPI Endpoint

Request

  • This API takes filter_id and notes as optional parameters in case you want to add those to your virtual account otherwise you can send an empty JSON body.

Response


Fetch Account Balance

Endpoint

Used to fetch virtual payment account balance for a given account number

HTTP MethodResourceDescription
GET/tax-payment/accounts/{account_number}/balanceThis API can be used to fetch virtual account balances.

API EndpointAPI Endpoint

Response

paramTypeDescription
balancenumbervirtual account balance.