Ledger APIs
Ledger API includes Fetch Transactions and Account Statement API
Introduction
Ledger APIs allow you to get details of the financial transaction on a given virtual bank account. These APIs help users track virtual account transactions and provide account statements that act as a central source of truth during reconciliation.
Available Ledger APIs
- Fetch Transaction API: helps in getting a transaction for the given Transaction ID
- Fetch Multiple Transactions API: to fetch multiple transactions for the given time period.
- Fetch Account Statement API: to get the statement of a virtual bank account.
Entities
Transaction
| 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/UTR Number | 1302656459 |
| description | string | Description | This is a 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 a failed transaction |
Updated 5 months ago