API Pricing Image

Overview

This API is used to create a new virtual account that can be used to receive payments using UPI or Bank Transfers.

Problem

Businesses face issues when tracking any payments.
Reconciling payments on a single account manually makes it a time-consuming, error-prone & expensive exercise for an accounts team.
Similar issues can occur when making a large number of tax payments.

Solution

API to create a virtual account, where users can make payments to their own accounts.
Allows reconciliation by separate accounts, making it easier & cost-effective for every accounts team.
Provides multiple payment methods to receive payments, enhancing customer experience.
Configure postbacks to know about the fund transfer to the virtual account.

Endpoint

HTTP Method	Resource
`POST`	/tax-payment/accounts

Request

Refer to the sample Request below for passing the filter_id and notes (optional). Otherwise, send an empty JSON body.

Sample CURL Request

curl --request POST \
     --url https://api.sandbox.co.in/tax-payment/accounts \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: xxxxxxxxxxxxx' \
     --data '
{
     "@entity": "virtual_bank_account",
     "notes": {
          "param1": "value1"
     },
     "filter_id": "filter1"
}
'

curl --request POST \
     --url https://api.sandbox.co.in/tax-payment/accounts \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: xxxxxxxxxxxxx' \
     --data '
{
     "@entity": "virtual_bank_account",
     "notes": {},
     "filter_id": "filter1"
}
'

curl --request POST \
     --url https://api.sandbox.co.in/tax-payment/accounts \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: xxxxxxxxxxxxx' \

❗️
Test Environment 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": {
      "param1": "value1"
    },
    "filter_id": "filter1",
    "opened_at": 1666155630494
  }
}

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since Create New Virtual Bank Account API 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