The Reports resource defines a generic reporting framework which allows you to associate a set of named reporting endpoints with an origin. Various platform features (like transaction reporting, economy reserve, settlements between stakeholders and others) will use these endpoints to deliver feature-specific reports in a consistent manner.
Reports of all transactions that occur between the different stakeholders of the economy can be retrieved using the Transactions endpoint.
How filters work-
type: refers to the type or name of the transaction. The type of transactions depend from project to project and are defined in the project configuration file. Filtering bytypecan help generate reports for a specific transaction type.group: refers to a class of transaction types having in common the functionality of the transaction. For example, the transaction types ‘qr-charge’, ‘cash-charge’ and ‘creditcard-charge’ can be grouped together under the group ‘charge’. Filtering bygroupcan help generate reports for a generic transaction type.start: refers to the start date that is used for querying transactions. Start date is inclusive.end: refers to the end date that is used for querying transactions. End date is non-inclusive.target-1: refers to a specific participant in the transactions. Filtering bytypecan help generate reports for a specific user in the economy....: This is for filtering by additional participants in the transaction.
Reconciliation is a crucial step in maintaining a healthy economy. The Reconciliations endpoint is used for verification where the target data (external entity such as a payment gateway, SSNB, and others) is compared against original source data ( Orb DLT stack) to ensure that the data is consistent. In the event that there is inconsistency, the Irreconcilable records endpoint can be used to fetch details of the conflicting data.
The report specifies:
- Total number of transactions both on the Orb DLT stack and the target entity
- Total transaction amount both on the Orb DLT stack and the target entity
- Status of the reconciled data. 'OK' indicates a sign of consistency in the reconciled data. 'NG' indicates a sign of inconsistency in the reconciled data.
Successful payments are collected into merchant accounts, which are then paid out according to the settlement schedule decided by the economy creator. It includes all batches closed in the chosen period, summarized by merchant id.
The report specifies:
- Net settlement amount- Which transactions will be paid out, and how much
- Fee totals
- Deposit corrections
- Total payout amount
The settlement endpoint can be run both on merchant account and issuer level. This report can be used by merchants to validate funds received and clear their accounts receivable balance. It can also be used by the issuer to view payout details.
The currency in circulation can be determined by the Economy balance endpoint. It helps provide a quantitative summary of the issuer’s coin economy condition at a specific point in time, including issuances, withdrawals, and net worth.
The report specifies:
1.Total issuance by type
2. Total withdrawals by type