Fetch Account Balance

Check the balance of a Virtual Account before making any payments.

API Pricing Image

Overview

Fetch a virtual account's balance by taking in the account_number

Problem

  • Before making any payments, it is important to know if the virtual account has a sufficient balance.

Solution

  • API that provides the balance for the given virtual account.

Endpoint

HTTP MethodResource
GET/tax-payment/accounts/{account_number}/balance

API Endpoint  Contact Us  Free Trial

Request

Follow the below guidelines to pass account_number to fetch the account balance.

Path Parameter

ParamtypeDescriptionExample
account_numberstringVirtual account numberHEY564578321596

Sample CURL Request

curl --request GET \
     --url https://api.sandbox.co.in/tax-payment/accounts/HEY564578321596/balance \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'x-api-key: xxxxxxxx'

❗️

Test Environment Not Available

Response

paramTypeDescription
balancenumbervirtual account balance.

Response Caching

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

Wallet Charges

Since Fetch Account Balance 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