Ledger APIs

21522152

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 MethodResourceDescription
GET/tax-payment/accounts/{account_number}/transactionsThis 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 MethodResourceDescription
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 MethodResourceDescription
GET/tax-payment/accounts/{account_number}/statementThis API can be used to fetch virtual payment account statement.

API EndpointAPI Endpoint

Response


Transaction Entity

ParamTypeDescriptionExample
idstringTransaction ID58sdKG-12e4-5d58-8c4s5654sw6898
payerPayer EntityPayer
payeePayee EntityPayee
amountnumberTransaction Amount1000
statusstringStatus of Transaction.Created, Processing, Successful, Failed
modestringMode of TransactionRTGS,NEFT,UPI,IMPS
typestringType of Transaction.Credit, Debit
bank_transaction_idstringBank Transaction ID1302656459
descriptionstringDescriptionThis is test transaction
notesjson objectUser notes{ "customer":"John",
"client":"quicko"}
transaction_timenumberTime of incurring transaction in unix timestamp format1630546813
failure_reasonstringfailure reason in case of failed transaction

Ledger Entry Entity

ParamTypeDescriptionExample
transaction_idstringTransaction ID58sdKG-12e4-5d58-8c4s5654sw6898
descriptionstringDetails about the transactionThis is test transaction
payerPayer EntityPayer
payeePayee EntityPayee
amountnumberTransaction amount100
typestringType of Transaction.Credit, Debit
closing_balancenumberClosing balance of Virtual Payment Account1000
transaction_timenumberTime of incurring transaction in unix timestamp format1630486840