Standard Reports

By default, each tenant on Eclipse can access one or more of a list of standard reports. A summary of each report is listed below, followed by a detailed description of the fields, mandatory API parameters, and data types included in each report.

Using the Reports API

Overview

The reports API provides programmatic access to reports in CSV, XML, or JSON format. Reports are identified by a unique reportId. Parameters are positionally named by type:

Parameter Prefix	Type	Example
`d#`	Date (ISO 8601 with milliseconds)	`d1=2024-01-01T00:00:00.000`
`s#`	String	`s1=SUCCESSFUL`
`n#`	Numeric	`n1=100`

So a report with a start date, end date, and a status filter would use d1, d2, and s1 respectively.

Timeout: Reports called synchronously have a 15-second timeout. For reports that may take longer, use Asynchronous Report Delivery.

API Endpoint:

GET /eclipse-conductor/rest/v1/tenants/{tenantId}/reports/{reportId}?d1=<start>&d2=<end>&format=<csv|json|xml>

curl example — fetch the Digital Wallet Transaction Detail Report in CSV format:

curl -s \
  "https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/11224145/reports/Report_digital_wallet_transaction_detail?d1=2024-01-01T00:00:00.000&d2=2024-02-01T00:00:00.000&format=csv" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -o wallet_transactions_jan2024.csv

Report Information

1. Digital Wallet Transaction Detail Report

Description: A ledger of all digital wallet transactions made over a specified period.

Report ID: Report_digital_wallet_transaction_detail

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
transaction_date	The date and time of the transaction (e.g. 2020-01-01 10:00:00).	DATE	N	Y
organisation_name	The name of the tenant organisation through which the transaction was processed (e.g. John's Shoe Store).	STR	N
organisation_id	The ID of the tenant organisation through which the transaction was processed (e.g. 98765).	INT	N
wallet_id	The ID of the wallet that initiated the transaction (e.g. 12346).	INT	N
wallet_name	The name of the wallet the initiated the transaction (e.g. Sophia's Digital Wallet).	STR	Y
other_wallet_id	The ID of the recipient wallet (e.g. 2385).	INT	Y
transaction_type	The type of transaction (e.g. tfr.credit, tfr.debit)	STR	N
amount	The amount of the transaction (e.g. 985.53).	FLOAT	N
description	A detailed description of the transaction (e.g. Payment for shoe repairs).	STR	Y
location	The location (IP address) at which the transaction took place (e.g. 192.158.1.38).	STR	Y
external_transaction_id	The external ID of the transaction (e.g. a222235a-5add-11ed).	STR	Y
unit_type	The unit type of the transaction (e.g. ZAR, BTC)	STR	Y
wallet_closing_balance	The closing balance of the initiating wallet (e.g. 1003.26).	FLOAT	N
unique_id	The globally unique transaction ID (e.g. CR-SHOEPAYMENT-230498739).	STR	N

2. Digital Wallet Balance Report

Description: A list of all digital wallets belonging to the tenant, including the current balance of each wallet.

Report ID: Report_digital_wallet_balance

Parameters:

API Parameters	Description	Type	Format
d1	Balance Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

*Note: The balance date parameter does not apply to wallets that have never been funded.

Fields:

Field Name	Description	Data Type	Nullable	Parameter
created	The date and time at which the wallet was created (e.g. 2020-01-01 10:00:00).	DATE	N
wallet_id	The unique ID of the wallet (e.g. 12345).	INT	N
wallet_name	The name of the wallet (e.g. My Digital Card Wallet).	STR	Y
user_id	The ID of the user that owns the wallet (e.g. 45678).	INT	Y
external_id	The external ID of the wallet (e.g. 1A2B3C).	STR	N
currency	The currency of the value stored in the wallet (e.g. ZAR).	STR	N
wallet_implementation_class	The implementation class of the wallet (e.g. closedLoopSimpleWallet)	STR	N
wallet_type_name	Wallet type name (e.g. System Wallet)	STR	N
balance_date	The wallet balance date. *Note: This is either equal to the wallet's last transaction date OR the wallet's created date if the wallet was never funded.	DATE	N	Y
current_balance	The current balance of the wallet (e.g. 500.07).	FLOAT	N

3. VAS Sales Report

Description: A ledger of all VAS sales made over a specified period.

Report ID: Report_vas_sales

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
network_provider	The network provider of the transaction.	STR	Y
recipient_number	The recipient phone number of the transaction.	STR	N
voucher_id	The unique ID of the voucher.	STR	N
voucher	The name of the voucher.	STR	N
payment_id	The ID of the payment.	INT	N
transaction_date	The date and time of the transaction.	DATE	N	Y
gateway	The gateway through which the transaction was processed.	STR	N
status	The status of the transaction.	STR	N
wallet_history_id	The unique wallet history ID of the transaction.	INT	N
wallet_id	The unique ID of the wallet (e.g. 12345).	INT	N
amount	The amount of the transaction.	INT	N
description	A detailed description of the transaction (e.g. Payment for shoe repairs).	STR	Y

4. API Activity Report

Description: A ledger of all Eclipse API calls made by the tenant over a specified period.

Report ID: Report_api_activity

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
event_id	The unique ID of the event.	INT	N
created	The date and time at which the event occured (e.g. 2020-01-01 10:00:00).	DATE	N	Y
tenant_id	The tenant ID through which the event was processed.	INT	Y
event_type	The type of event.	STR	N
event_key	The event key.	STR	N
unique_id	The globally unique transaction ID (e.g. CR-SHOEPAYMENT-230498739).	STR	Y
data	The event metadata.	STR	Y

5. P2P Transfer Report

Description: A ledger of all P2P transfers (wallet-to-wallet transfers) made over a specified period.

Report ID: Report_p2p_transfer

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
wallet_history_id	The unique ID of the transaction.	INT	N
sender_name	The name of the user who is initiating the transaction.	STR	Y
recipient_name	The name of the user who is receiving the transaction.	STR	Y
sender_wallet_id	The wallet ID of the user who is initiating the transaction.	INT	N
sender_wallet_name	The wallet name of the user who is initiating the transaction.	STR	Y
sender_wallet_description	The wallet description of the user who is initiating the transaction.	STR	Y
recipient_wallet_id	The wallet ID of the user who is receiving the transaction.	INT	N
recipient_wallet_name	The wallet name of the user who is receiving the transaction.	STR	Y
recipient_wallet_description	The wallet description of the user who is receiving the transaction.	STR	Y
unique_id	The globally unique transaction ID (e.g. CR-SHOEPAYMENT-230498739).	STR	Y
external_transaction_id	The external ID of the transaction (e.g. a222235a-5add-11ed).	STR	Y
transaction_date	The date and time at which the wallet was created (e.g. 2020-01-01 10:00:00).	DATE	Y	Y
description	A detailed description of the transaction (e.g. Payment for shoe repairs).	STR	Y
amount	The amount of the transaction.	FLOAT	N
sender_wallet_balance	The sender wallet's balance after the transaction.	FLOAT	N

6. User Detail Report

Description: A list of all registered users belonging to the tenant.

Report ID: Report_user_detail

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
user_id	The ID of the user that owns the wallet (e.g. 45678).	INT	Y
created	The date and time at which the user was created (e.g. 2020-01-01 10:00:00).	DATE	N	Y
first_name	The first name of the user.	STR	Y
last_name	The last name of the user.	STR	Y
kyc_status	The KYC status of the user.	INT	N
phone_number	The phone number of the user. (e.g. 0826589712).	STR	Y
email	The email address number of the user. (e.g. 0826589712).	STR	Y
national_identity_number	The national ID number of the user.	STR	Y
passport_number	The passport number of the user.	STR	Y
passport_expiry	The passport expiry date of the user.	STR	Y
asylum_ref_number	The asylum reference number of the user.	STR	Y
city_of_birth	The user's city of birth.	STR	Y
country_of_birth	The user's country of birth.	STR	Y
external_id	The external ID of the wallet (e.g. 1A2B3C).	STR	Y
gender	The gender of the user.	STR	Y
dob	The user's date of birth.	STR	Y
address_line_1	The user's 1st line address.	STR	Y
address_line_2	The user's 2nd line address.	STR	Y
address_line_3	The user's 3rd line address.	STR	Y

7. Failed Digital Wallet Payments Report

Description: A ledger of all failed digital wallet payments (e.g. EFT, ATM) over a specified period.

Report ID: Report_failed_digital_wallet_payments

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
payment_id	The unique ID of the payment.	INT	N
status	Status of the payment.	STR	N
unique_id	The globally unique transaction ID (e.g. CR-SHOEPAYMENT-230498739).	STR	N
user_id	The ID of the user that owns the wallet (e.g. 45678).	INT	Y
wallet_id	The unique ID of the wallet (e.g. 12345).	INT	Y
amount	The payment amount.	FLOAT	Y
fee	The fee charged for the payment.	FLOAT	Y
created	The date and time at which the failed transaction occured (e.g. 2020-01-01 10:00:00).	DATE	N	Y
payment_type	The type of payment.	STR	Y
gateway_status	The third-party gateway status of the payment.	STR	Y
gateway	The third-party gateway name.	STR	N
gateway_transaction_id	The third-party gateway transaction ID.	STR	Y
currency	The currency of the store of value of the wallet (e.g. ZAR).	STR	Y
merchant_id	The ID of the merchant who received the payment.	STR	Y
merchant_name	The name of the merchant who received the payment.	STR	Y
description	A detailed description of the transaction (e.g. Payment for shoe repairs).	STR	Y
error_description	Detailed error description.	STR	Y
payment_reference	The payment reference.	STR	Y
bank_name	The payer's bank name.	STR	Y
bank_account	The payer's bank account number.	STR	Y
other_wallet_id	The wallet ID of the payment recipient.	INT	Y
card_last_4	The last 4 digits of the card used to make the payment.	STR	Y
qr_code		STR	Y
bank_response	The payment bank response.	STR	Y
additional_fields		STR	Y
gateway_state	The third-party gateway state.	STR	Y

8. Failed Digital Wallet Withdrawals Report

Description: A ledger of all failed digital wallet withdrawals (e.g. EFT, ATM) over a specified period.

Report ID: Report_failed_digital_wallet_withdrawals

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
withdrawal_id	The unique ID of the withdrawal transaction.	INT	N
withdrawal_type	The type of withdrawal (e.g. EFT, ATM)	STR	Y
created	The date and time at which the failed withdrawal occured (e.g. 2020-01-01 10:00:00).	DATE	N	Y
status	The status of the withdrawal.	STR	N
unique_id	The globally unique transaction ID (e.g. CR-SHOEPAYMENT-230498739).	STR	N
user_id	The ID of the user that owns the wallet (e.g. 45678).	INT	Y
wallet_id	The unique ID of the wallet (e.g. 12345).	INT	Y
amount	The withdrawal amount.	INT	N
fee	The fee charged for the transaction.	INT	Y
currency	The currency of the store of value of the wallet (e.g. ZAR).	STR	N
gateway	The third-party gateway name.	STR	N
gateway_transaction_id	The third-party gateway transaction ID.	STR	Y
gateway_state	The third-party gateway state.	STR	Y
description	A detailed description of the transaction (e.g. Withdrawing monthly salary).	STR	Y

9. KYC Failures Report

Description: A list of all users who have failed to complete registration as a result of failed or incomplete KYC checks. Includes a detailed view of each KYC check type in terms of whether the check was done and whether the check was passed.

Report ID: Report_kyc_failures

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable	Parameter
user_id	The Eclipse ID of the user (e.g. 45678).	INT	N
user_name	The first and last name(s) of the user.	STR	Y
user_created	The date and time at which the user was created (e.g. 2020-01-01 10:00:00).	DATE	N	Y
kyc_date	The date and time at which the KYC attempt occured (e.g. 2020-01-01 10:00:00).	DATE	N
result_data	The KYC result metadata.	STR	Y

10. QR Code Status Report

Description: A list of all QR codes belonging to the tenant, the wallets that they are mapped to, and the current status of each code (ACTIVE or CANCELLED).

Report ID: Report_qr_code_status

Parameters: None

Fields:

Field Name	Description	Data Type	Nullable
wallet_id	The wallet ID that the QR code is mapped to.	INT	N
created_date	The date that the QR code was created.	DATE	N
qr_code	The QR code string.	STR	N
status	The current status of the QR code.	STR	N

11. Tenant Program Summary Report

Description: A current snapshot of the tenant program in terms of user registrations, verifications, active users, issued wallets, and transaction volumes.

Report ID: Report_tenant_program_summary

Parameters: None

Fields:

Field Name	Description	Data Type	Nullable	Parameter
Metric	A key performance metric (E.g. Total Registered Users)	STR	N
Total	The current value of the metric.	INT	N

12. Digital Wallet Fees Summary Report

Description: A summary of digital wallet transaction fees earned over a specified period.

Report ID: Report_digital_wallet_fees_summary

Parameters:

API Parameters	Description	Type	Format
d1	Start Date	STR	YYYY-MM-DDTHH:mm:ss.SSS
d2	End Date	STR	YYYY-MM-DDTHH:mm:ss.SSS

Fields:

Field Name	Description	Data Type	Nullable
wallet_name	The name of the system wallet that is credited with fees (e.g. Monthly Fees).	STR	N
wallet_id	The Eclipse ID of the wallet (e.g. 12345).	INT	N
service_code	The transaction type (e.g. tfr.credit.monthly.fee).	STR	N
value	The value of fees earned over the specified period.	FLOAT	N
volume	The volume of fee transactions over the specified period.	INT	N

13. MCQR Code Status Report

Description: Provides the status of each MCQR code registered on the tenant program.

Report ID: Report_mcqr_status

Parameters: None

Fields:

Field Name	Description	Data Type	Nullable
wallet_id	The wallet ID that the MCQR code is mapped to.	INT	N
qr_code	The MCQR code.	STR	N
service_identitfier_type	Always "QRCode".	STR	N
status	The status of the code (either "Active" or "Cancelled").	STR	N

14. Dormant Users Report

Description: A list of all users who either registered over 6 months ago and never transacted, or have not transacted in the last 6 months.

Report ID: Report_user_dormancy

Parameters: None

Fields:

Field Name	Description	Data Type	Nullable
user_id	The user's unique identifier in the Eclipse system.	INT	N
Dormancy Reason	The reason that the user has been classified as dormant.	STR	N
Last Seen	The date the user was last active on the system.	DATE	N