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

Param

Type

Description

Example

account_number

string

Bank account number. Max length: 40 characters

HEY564578321596

ifsc

string

11-digit alpha-numeric code used to identify the bank branches

ICIC0000103

status

string

Virtual Payment Account status.
Possible values :

  • Active
  • Inactive

Active

notes

json object

User notes

{ "customer":"John",
"client":"quicko"}

filter_id

string

User defined reference string which will be used while fetching accounts from Sandbox's database

filter1,filter2

opened_at

number

Time of opening the account in Unix timestamp format in milliseconds

1654410610000


Fetch Accounts

Endpoint

Used to fetch all accounts for given user

HTTP Method

Resource

Description

GET

/tax-payment/accounts

Fetches all virtual accounts belonging to your sandbox subscription

API EndpointAPI Endpoint

Query Parameters

Param

Description

Example

status

Used 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 Method

Resource

Description

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 Method

Resource

Description

POST

/tax-payment/accounts

Create 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 Method

Resource

Description

GET

/tax-payment/accounts/{account_number}/balance

This API can be used to fetch virtual account balances.

API EndpointAPI Endpoint

Response

param

Type

Description

balance

number

virtual account balance.



Did this page help you?