Overview

Use this API to fetch the account statement for the virtual bank account by passing in the account_number.

Problem

Unable to reconcile transactions made on a virtual bank account in a systematic manner.

Solution

API to provide an account statement for the given virtual bank account & time period.
Provides insights on the activity of the virtual bank account.

Endpoint

HTTP Method	Resource
`GET`	/tax-payment/accounts/{account_number}/statement

Request

Follow the below guidelines to pass the virtual bank account number & date range to fetch the account statement.

Path Parameter

Param	type	Description	Example
account_number	`string`	Virtual account number. Max length: 40 characters	`HEY564578321596`

Query Parameter

Param	type	Description	Example
from	`date-time`	Unix timestamp of the date from when you want the account statement.	`1640005642539`
to	`date-time`	Unix timestamp of the date till when you want the account statement till.	`1671541642539`

Sample CURL Request

curl --request GET \
     --url 'https://api.sandbox.co.in/tax-payment/accounts/HEY564578321596/statement?from=1656673970&to=1659006775' \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxxxxxxxxxxxx' \
     --header 'x-api-key: xxxxxxxxxxxx'

❗️
Test Environment Not Available

Response

The API responds back in a sheet structure. An example response is shown below.

{
  "code": 200,
  "timestamp": 1671541642464,
  "transaction_id": "1ed50ca5-7a50-4abd-b812-ccbdb8ba753c",
  "data": {
    "sheets": [
      {
        "name": "transactions",
        "blocks": [
          {
            "@entity": "table",
            "name": "transactions",
            "header": [
              "transaction_id",
              "transaction_time",
              "amount",
              "type",
              "closing_balance",
              "bank_reference_number",
              "payer_name",
              "payer_account_number",
              "payee_name",
              "payee_account_number",
              "description"
            ],
            "rows": [
              [
                "e953896f-b1e4-4ee1-b7cb-11f761b6af0d",
                1671541443333,
                1,
                "Credit",
                1,
                "235492599586",
                "TONY STARK",
                "12345678@paytm",
                null,
                "HEY94958256XXXX",
                "adding funds"
              ],
              [
                "e953896f-b1e4-4ee1-b7cb-11f761b6af0d",
                1671541443936,
                1,
                "Credit",
                2,
                "235492599586",
                "TONY STARK",
                "12345678@paytm",
                null,
                "HEY94958256XXXX",
                "adding funds"
              ],
              [
                "15a19b46-ffe6-432f-8b57-8195c98072ea",
                1671541635586,
                1,
                "Debit",
                1,
                "235492612023",
                "BRUCE BANNER",
                "HEY49428565XXXX",
                null,
                "HEY94958256XXXX",
                "payment"
              ]
            ]
          }
        ]
      },
      {
        "name": "summary",
        "blocks": [
          {
            "@entity": "list",
            "name": "summary",
            "items": [
              [
                "opening_balance",
                0
              ],
              [
                "closing_balance",
                1
              ],
              [
                "credits",
                2
              ],
              [
                "credit_count",
                2
              ],
              [
                "debits",
                1
              ],
              [
                "debit_count",
                1
              ],
              [
                "from",
                1640005642539
              ],
              [
                "to",
                1671541642539
              ]
            ]
          }
        ]
      }
    ]
  }
}

Response Caching

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

Wallet Charges

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