API Pricing Image

Overview

Fetch multiple transactions made by a virtual bank account by taking in the account_number and the time period.

Problem

Not able to view the details of transactions made on the virtual bank account for a given period of time.

Solution

API to provide details of multiple transactions for the given time period.

Endpoint

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

Request

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

Path Parameter

Param	Type	Description	Example
account_number	`string`	Virtual bank account number for which you want all transactions.	`HEY564578321596`

Query Parameter

Param	type	Description	Example
from	`date-time`	Unix timestamp of the date from when you want all the transactions	`165667397000`
status	`string`	Status of the direct tax transactions you want to fetch. You can fetch transactions for multiple statuses. Possible values are: `Successful` `Processing` `Failed` `Created`	`Successful`
to	`date-time`	Unix timestamp of the date till when you want the transactions	`1659006775000`

Sample CURL request

curl --request GET \
     --url 'https://api.sandbox.co.in/tax-payment/accounts/HEY564578321596/transactions?from=1656673970&status=Status%2CProcessing&to=1659006775' \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxxxxxxxxxxxx' \
     --header 'x-api-key: xxxxxxxxxxxxxxx'

❗️
Test Environment Not Available

Response

The API responds back with an array of Transaction entities. An example response is shown below.

{
  "code": 200,
  "timestamp": 1631095323168,
  "transaction_id": "8831d466-6fe7-48ed-b478-7d1cb4e92572",
  "data": [
    {
      "@entity": "transaction",
      "id": "58sdKG-12e4-5d58-8c4s5654sw6898",
      "payer": {
        "@entity": "payer",
        "name": "John",
        "bank_account": {
          "@entity": " bank_account",
          "account_number": "HEYSBX********82",
          "ifsc": "ICIC0000103"
        },
        "upi_id": null
      },
      "payee": {
        "@entity": "payee",
        "name": "Doe",
        "bank_account": {
          "@entity": " bank_account",
          "account_number": "265680056",
          "ifsc": "HDFC0000102"
        },
        "upi_id": null
      },
      "status": "Successful",
      "description": "Test Transaction",
      "amount": 100,
      "mode": "NEFT",
      "bank_transaction_id": "ICIC36564685",
      "type": "Debit",
      "notes": {},
      "transaction_time": 16373968890
    }
  ]
}

Response Caching

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

Wallet Charges

Since Fetch Multiple Transactions 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