Standard Reports

Every Eclipse tenant has access to the following standard reports. Each report is executed via the Reports API using its reportId. Parameters are positionally typed — d# for dates, s# for strings, n# for numbers — and each report uses a specific subset of them in the order listed.

For format options, async delivery, and how to scope results to a single organisation using organisationId, see the Reports API reference.

1. Digital Wallet Transaction Detail

Report ID: Report_digital_wallet_transaction_detail

A ledger of all digital wallet transactions processed for the tenant over a given period. Use this for reconciliation, transaction dispute resolution, or feeding downstream data pipelines.

Parameters:

Parameter	Description	Format
`d1`	Start date (inclusive)	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date (inclusive)	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`transaction_date`	Date and time of the transaction	DATE	N
`organisation_name`	Organisation through which the transaction was processed	STR	N
`organisation_id`	ID of that organisation	INT	N
`wallet_id`	Wallet that initiated the transaction	INT	N
`wallet_name`	Name of the initiating wallet	STR	Y
`other_wallet_id`	Recipient wallet ID	INT	Y
`transaction_type`	Transaction type — e.g. `tfr.credit`, `tfr.debit`	STR	N
`amount`	Transaction amount	FLOAT	N
`description`	Transaction description	STR	Y
`location`	Source IP address	STR	Y
`external_transaction_id`	External transaction reference	STR	Y
`unit_type`	Unit type — e.g. `ZAR`, `BTC`	STR	Y
`wallet_closing_balance`	Initiating wallet balance after the transaction	FLOAT	N
`unique_id`	Globally unique transaction ID — e.g. `CR-SHOEPAYMENT-230498739`	STR	N

2. Digital Wallet Balance

Report ID: Report_digital_wallet_balance

A point-in-time snapshot of balances across all wallets on the tenant. If no date is supplied, current balances are returned.

Parameters:

Parameter	Description	Format
`d1`	Balance date	`YYYY-MM-DDTHH:mm:ss.SSS`

📘
Note
The balance date parameter does not apply to wallets that have never been funded. Those wallets are always returned with their created date as the balance date.

Fields:

Field	Description	Type	Nullable
`created`	Date and time the wallet was created	DATE	N
`wallet_id`	Unique wallet ID	INT	N
`wallet_name`	Wallet name	STR	Y
`user_id`	ID of the wallet owner	INT	Y
`external_id`	External identifier for the wallet	STR	N
`currency`	Wallet currency — e.g. `ZAR`	STR	N
`wallet_implementation_class`	Wallet implementation class — e.g. `closedLoopSimpleWallet`	STR	N
`wallet_type_name`	Wallet type — e.g. `System Wallet`	STR	N
`balance_date`	Date used to determine the balance	DATE	N
`current_balance`	Wallet balance at the balance date	FLOAT	N

3. VAS Sales

Report ID: Report_vas_sales

A ledger of all Value-Added Service sales (airtime, data, electricity, etc.) made over a given period.

Parameters:

Parameter	Description	Format
`d1`	Start date	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`network_provider`	Network provider	STR	Y
`recipient_number`	Recipient phone number	STR	N
`voucher_id`	Unique voucher ID	STR	N
`voucher`	Voucher name	STR	N
`payment_id`	Payment ID	INT	N
`transaction_date`	Date and time of the sale	DATE	N
`gateway`	Gateway that processed the transaction	STR	N
`status`	Transaction status	STR	N
`wallet_history_id`	Wallet history ID	INT	N
`wallet_id`	Wallet ID	INT	N
`amount`	Sale amount	FLOAT	N
`description`	Transaction description	STR	Y

4. API Activity

Report ID: Report_api_activity

A log of all Eclipse API calls made against the tenant over a given period. Useful for auditing integration activity, tracking event volumes, and debugging.

Parameters:

Parameter	Description	Format
`d1`	Start date	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`event_id`	Unique event ID	INT	N
`created`	Date and time the event occurred	DATE	N
`tenant_id`	Tenant ID	INT	Y
`event_type`	Event type	STR	N
`event_key`	Event key	STR	N
`unique_id`	Globally unique transaction ID	STR	Y
`data`	Event metadata	STR	Y

5. P2P Transfer

Report ID: Report_p2p_transfer

A ledger of all peer-to-peer wallet-to-wallet transfers made over a given period.

Parameters:

Parameter	Description	Format
`d1`	Start date	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`wallet_history_id`	Unique transaction ID	INT	N
`sender_name`	Name of the sending user	STR	Y
`recipient_name`	Name of the receiving user	STR	Y
`sender_wallet_id`	Sender wallet ID	INT	N
`sender_wallet_name`	Sender wallet name	STR	Y
`sender_wallet_description`	Sender wallet description	STR	Y
`recipient_wallet_id`	Recipient wallet ID	INT	N
`recipient_wallet_name`	Recipient wallet name	STR	Y
`recipient_wallet_description`	Recipient wallet description	STR	Y
`unique_id`	Globally unique transaction ID	STR	Y
`external_transaction_id`	External transaction reference	STR	Y
`transaction_date`	Date and time of the transfer	DATE	Y
`description`	Transaction description	STR	Y
`amount`	Transfer amount	FLOAT	N
`sender_wallet_balance`	Sender wallet balance after the transfer	FLOAT	N

6. User Detail

Report ID: Report_user_detail

A list of all registered users on the tenant, including identity and KYC fields. Useful for compliance exports and user data audits.

Parameters:

Parameter	Description	Format
`d1`	Start date (user creation date range)	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date (user creation date range)	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`user_id`	Eclipse user ID	INT	Y
`created`	Date and time the user was created	DATE	N
`first_name`	First name	STR	Y
`last_name`	Last name	STR	Y
`kyc_status`	KYC status	INT	N
`phone_number`	Phone number	STR	Y
`email`	Email address	STR	Y
`national_identity_number`	National identity number	STR	Y
`passport_number`	Passport number	STR	Y
`passport_expiry`	Passport expiry date	STR	Y
`asylum_ref_number`	Asylum reference number	STR	Y
`city_of_birth`	City of birth	STR	Y
`country_of_birth`	Country of birth	STR	Y
`external_id`	External identifier for the user	STR	Y
`gender`	Gender	STR	Y
`dob`	Date of birth	STR	Y
`address_line_1`	Address line 1	STR	Y
`address_line_2`	Address line 2	STR	Y
`address_line_3`	Address line 3	STR	Y

7. Failed Digital Wallet Payments

Report ID: Report_failed_digital_wallet_payments

A ledger of all failed payment attempts (EFT, ATM, card, etc.) over a given period. Includes gateway error details useful for diagnosing payment failures.

Parameters:

Parameter	Description	Format
`d1`	Start date	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`payment_id`	Unique payment ID	INT	N
`status`	Payment status	STR	N
`unique_id`	Globally unique transaction ID	STR	N
`user_id`	User who owns the wallet	INT	Y
`wallet_id`	Wallet ID	INT	Y
`amount`	Payment amount	FLOAT	Y
`fee`	Fee charged	FLOAT	Y
`created`	Date and time the failure occurred	DATE	N
`payment_type`	Payment type	STR	Y
`gateway_status`	Gateway status code	STR	Y
`gateway`	Gateway name	STR	N
`gateway_transaction_id`	Gateway transaction reference	STR	Y
`currency`	Wallet currency	STR	Y
`merchant_id`	Merchant ID	STR	Y
`merchant_name`	Merchant name	STR	Y
`description`	Transaction description	STR	Y
`error_description`	Detailed error message	STR	Y
`payment_reference`	Payment reference	STR	Y
`bank_name`	Payer's bank name	STR	Y
`bank_account`	Payer's bank account number	STR	Y
`other_wallet_id`	Recipient wallet ID	INT	Y
`card_last_4`	Last 4 digits of the card used	STR	Y
`qr_code`	QR code reference	STR	Y
`bank_response`	Bank response	STR	Y
`additional_fields`	Additional metadata	STR	Y
`gateway_state`	Gateway state	STR	Y

8. Failed Digital Wallet Withdrawals

Report ID: Report_failed_digital_wallet_withdrawals

A ledger of all failed withdrawal attempts (EFT, ATM, etc.) over a given period.

Parameters:

Parameter	Description	Format
`d1`	Start date	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`withdrawal_id`	Unique withdrawal ID	INT	N
`withdrawal_type`	Withdrawal type — e.g. `EFT`, `ATM`	STR	Y
`created`	Date and time the failure occurred	DATE	N
`status`	Withdrawal status	STR	N
`unique_id`	Globally unique transaction ID	STR	N
`user_id`	User who owns the wallet	INT	Y
`wallet_id`	Wallet ID	INT	Y
`amount`	Withdrawal amount	FLOAT	N
`fee`	Fee charged	FLOAT	Y
`currency`	Wallet currency	STR	N
`gateway`	Gateway name	STR	N
`gateway_transaction_id`	Gateway transaction reference	STR	Y
`gateway_state`	Gateway state	STR	Y
`description`	Transaction description	STR	Y

9. KYC Failures

Report ID: Report_kyc_failures

A list of users who failed to complete registration due to failed or incomplete KYC checks. Includes the check type and result detail for each attempt.

Parameters:

Parameter	Description	Format
`d1`	Start date	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`user_id`	Eclipse user ID	INT	N
`user_name`	Full name of the user	STR	Y
`user_created`	Date the user account was created	DATE	N
`kyc_date`	Date and time the KYC attempt occurred	DATE	N
`result_data`	KYC result metadata	STR	Y

10. QR Code Status

Report ID: Report_qr_code_status

A list of all QR codes on the tenant, the wallets they are mapped to, and their current status. Useful for monitoring QR code issuance and identifying cancelled codes.

Parameters: None

Fields:

Field	Description	Type	Nullable
`wallet_id`	Wallet the QR code is mapped to	INT	N
`created_date`	Date the QR code was created	DATE	N
`qr_code`	QR code string	STR	N
`status`	Current status: `ACTIVE` or `CANCELLED`	STR	N

11. Tenant Program Summary

Report ID: Report_tenant_program_summary

A current snapshot of the tenant program — total users, verifications, active users, wallets issued, and transaction volumes. Useful for executive dashboards and MIS reporting.

Parameters: None

Fields:

Field	Description	Type	Nullable
`Metric`	Key performance metric name — e.g. `Total Registered Users`	STR	N
`Total`	Current value of the metric	INT	N

12. Digital Wallet Fees Summary

Report ID: Report_digital_wallet_fees_summary

A summary of transaction fees earned per service code over a given period. Useful for fee income reconciliation.

Parameters:

Parameter	Description	Format
`d1`	Start date	`YYYY-MM-DDTHH:mm:ss.SSS`
`d2`	End date	`YYYY-MM-DDTHH:mm:ss.SSS`

Fields:

Field	Description	Type	Nullable
`wallet_name`	System wallet credited with these fees	STR	N
`wallet_id`	Wallet ID	INT	N
`service_code`	Transaction type — e.g. `tfr.credit.monthly.fee`	STR	N
`value`	Total fee value earned over the period	FLOAT	N
`volume`	Number of fee transactions over the period	INT	N

13. Dormant Users

Report ID: Report_user_dormancy

A list of users who have been inactive for 6+ months — either registered over 6 months ago and never transacted, or have not transacted in the last 6 months. Used for dormancy monitoring and regulatory compliance.

Parameters: None

Fields:

Field	Description	Type	Nullable
`user_id`	Eclipse user ID	INT	N
`Dormancy Reason`	Why the user is classified as dormant	STR	N
`Last Seen`	Date the user was last active	DATE	N