Ledger APIs

About

  • Ledger APIs help users to reconcile their account's activity. Users can fetch things like account statements, a list of transactions, etc.
  • It is a supporting API for the Virtual Account APIs

Use case

  • Used for fetching account statement for reviewing previous transactions done from the account

Fetch Transactions

Endpoint

Used to request for fetching all transactions done on an account.

HTTP Method

Resource

Description

GET

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

This API fetches all the transactions on the given account number between a given time period.

API EndpointAPI Endpoint

Response


Fetch Transaction

Endpoint

Request to fetch a transaction for a given transaction Id.

HTTP Method

Resource

Description

GET

/tax-payment/accounts/{account_number}/transactions/{transaction_id}

This API can be used to fetch a transaction for a given transction_id.

API EndpointAPI Endpoint

Response


Fetch Account Statement

Endpoint

📘

Use cases of Fetch Transaction API

  • This API can be used to fetch the latest status of a pending transaction, such as that in the case of UPI Collect Payment API.
  • This API can be used as a Polling API to fetch the latest transaction status when funding Virtual Account using UPI Collect payment and UPI Dynamic QR payments.

Used to request the leger/statement of a specific virtual payment account.

HTTP Method

Resource

Description

GET

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

This API can be used to fetch virtual payment account statement.

API EndpointAPI Endpoint

Response


Transaction Entity

Param

Type

Description

Example

id

string

Transaction ID

58sdKG-12e4-5d58-8c4s5654sw6898

payer

Payer Entity

Payer

payee

Payee Entity

Payee

amount

number

Transaction Amount

1000

status

string

Status of Transaction.

Created, Processing, Successful, Failed

mode

string

Mode of Transaction

RTGS,NEFT,UPI,IMPS

type

string

Type of Transaction.

Credit, Debit

bank_transaction_id

string

Bank Transaction ID

1302656459

description

string

Description

This is test transaction

notes

json object

User notes

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

transaction_time

number

Time of incurring transaction in unix timestamp format

1630546813

failure_reason

string

failure reason in case of failed transaction

Ledger Entry Entity

Param

Type

Description

Example

transaction_id

string

Transaction ID

58sdKG-12e4-5d58-8c4s5654sw6898

description

string

Details about the transaction

This is test transaction

payer

Payer Entity

Payer

payee

Payee Entity

Payee

amount

number

Transaction amount

100

type

string

Type of Transaction.

Credit, Debit

closing_balance

number

Closing balance of Virtual Payment Account

1000

transaction_time

number

Time of incurring transaction in unix timestamp format

1630486840


Did this page help you?