Standard Reports

Catalogue of the 17 standard reports available on every Eclipse tenant, with parameters and field definitions.

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, 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:

ParameterDescriptionFormat
d1Start date (inclusive)YYYY-MM-DDTHH:mm:ss.SSS
d2End date (inclusive)YYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
transaction_dateDate and time of the transactionDATEN
organisation_nameOrganisation through which the transaction was processedSTRN
organisation_idID of that organisationINTN
wallet_idWallet that initiated the transactionINTN
wallet_nameName of the initiating walletSTRY
other_wallet_idRecipient wallet IDINTY
transaction_typeTransaction type — e.g. tfr.credit, tfr.debitSTRN
amountTransaction amountFLOATN
descriptionTransaction descriptionSTRY
locationSource IP addressSTRY
external_transaction_idExternal transaction referenceSTRY
unit_typeUnit type — e.g. ZAR, BTCSTRY
wallet_closing_balanceInitiating wallet balance after the transactionFLOATN
unique_idGlobally unique transaction ID — e.g. CR-SHOEPAYMENT-230498739STRN

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:

ParameterDescriptionFormat
d1Balance dateYYYY-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:

FieldDescriptionTypeNullable
createdDate and time the wallet was createdDATEN
wallet_idUnique wallet IDINTN
wallet_nameWallet nameSTRY
user_idID of the wallet ownerINTY
external_idExternal identifier for the walletSTRN
currencyWallet currency — e.g. ZARSTRN
wallet_implementation_classWallet implementation class — e.g. closedLoopSimpleWalletSTRN
wallet_type_nameWallet type — e.g. System WalletSTRN
balance_dateDate used to determine the balanceDATEN
current_balanceWallet balance at the balance dateFLOATN

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:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
network_providerNetwork providerSTRY
recipient_numberRecipient phone numberSTRN
voucher_idUnique voucher IDSTRN
voucherVoucher nameSTRN
payment_idPayment IDINTN
transaction_dateDate and time of the saleDATEN
gatewayGateway that processed the transactionSTRN
statusTransaction statusSTRN
wallet_history_idWallet history IDINTN
wallet_idWallet IDINTN
amountSale amountFLOATN
descriptionTransaction descriptionSTRY

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:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
event_idUnique event IDINTN
createdDate and time the event occurredDATEN
tenant_idTenant IDINTY
event_typeEvent typeSTRN
event_keyEvent keySTRN
unique_idGlobally unique transaction IDSTRY
dataEvent metadataSTRY

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:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
wallet_history_idUnique transaction IDINTN
sender_nameName of the sending userSTRY
recipient_nameName of the receiving userSTRY
sender_wallet_idSender wallet IDINTN
sender_wallet_nameSender wallet nameSTRY
sender_wallet_descriptionSender wallet descriptionSTRY
recipient_wallet_idRecipient wallet IDINTN
recipient_wallet_nameRecipient wallet nameSTRY
recipient_wallet_descriptionRecipient wallet descriptionSTRY
unique_idGlobally unique transaction IDSTRY
external_transaction_idExternal transaction referenceSTRY
transaction_dateDate and time of the transferDATEY
descriptionTransaction descriptionSTRY
amountTransfer amountFLOATN
sender_wallet_balanceSender wallet balance after the transferFLOATN

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:

ParameterDescriptionFormat
d1Start date (user creation date range)YYYY-MM-DDTHH:mm:ss.SSS
d2End date (user creation date range)YYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
user_idEclipse user IDINTY
createdDate and time the user was createdDATEN
first_nameFirst nameSTRY
last_nameLast nameSTRY
kyc_statusKYC statusINTN
phone_numberPhone numberSTRY
emailEmail addressSTRY
national_identity_numberNational identity numberSTRY
passport_numberPassport numberSTRY
passport_expiryPassport expiry dateSTRY
asylum_ref_numberAsylum reference numberSTRY
city_of_birthCity of birthSTRY
country_of_birthCountry of birthSTRY
external_idExternal identifier for the userSTRY
genderGenderSTRY
dobDate of birthSTRY
address_line_1Address line 1STRY
address_line_2Address line 2STRY
address_line_3Address line 3STRY

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:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
payment_idUnique payment IDINTN
statusPayment statusSTRN
unique_idGlobally unique transaction IDSTRN
user_idUser who owns the walletINTY
wallet_idWallet IDINTY
amountPayment amountFLOATY
feeFee chargedFLOATY
createdDate and time the failure occurredDATEN
payment_typePayment typeSTRY
gateway_statusGateway status codeSTRY
gatewayGateway nameSTRN
gateway_transaction_idGateway transaction referenceSTRY
currencyWallet currencySTRY
merchant_idMerchant IDSTRY
merchant_nameMerchant nameSTRY
descriptionTransaction descriptionSTRY
error_descriptionDetailed error messageSTRY
payment_referencePayment referenceSTRY
bank_namePayer's bank nameSTRY
bank_accountPayer's bank account numberSTRY
other_wallet_idRecipient wallet IDINTY
card_last_4Last 4 digits of the card usedSTRY
qr_codeQR code referenceSTRY
bank_responseBank responseSTRY
additional_fieldsAdditional metadataSTRY
gateway_stateGateway stateSTRY

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:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
withdrawal_idUnique withdrawal IDINTN
withdrawal_typeWithdrawal type — e.g. EFT, ATMSTRY
createdDate and time the failure occurredDATEN
statusWithdrawal statusSTRN
unique_idGlobally unique transaction IDSTRN
user_idUser who owns the walletINTY
wallet_idWallet IDINTY
amountWithdrawal amountFLOATN
feeFee chargedFLOATY
currencyWallet currencySTRN
gatewayGateway nameSTRN
gateway_transaction_idGateway transaction referenceSTRY
gateway_stateGateway stateSTRY
descriptionTransaction descriptionSTRY

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:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
user_idEclipse user IDINTN
user_nameFull name of the userSTRY
user_createdDate the user account was createdDATEN
kyc_dateDate and time the KYC attempt occurredDATEN
result_dataKYC result metadataSTRY

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:

FieldDescriptionTypeNullable
wallet_idWallet the QR code is mapped toINTN
created_dateDate the QR code was createdDATEN
qr_codeQR code stringSTRN
statusCurrent status: ACTIVE or CANCELLEDSTRN

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:

FieldDescriptionTypeNullable
MetricKey performance metric name — e.g. Total Registered UsersSTRN
TotalCurrent value of the metricINTN

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:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
wallet_nameSystem wallet credited with these feesSTRN
wallet_idWallet IDINTN
service_codeTransaction type — e.g. tfr.credit.monthly.feeSTRN
valueTotal fee value earned over the periodFLOATN
volumeNumber of fee transactions over the periodINTN

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:

FieldDescriptionTypeNullable
user_idEclipse user IDINTN
Dormancy ReasonWhy the user is classified as dormantSTRN
Last SeenDate the user was last activeDATEN

14. User Wallet Detail

Report ID: Report_user_wallet_detail

A combined view of each user's identity and KYC details alongside their primary wallet — the wallet flagged ACTIVE, or if none is active, the most recently created one. Useful for a single-screen customer-and-wallet export.

Parameters:

ParameterDescriptionFormat
d1Start date (user creation date range)YYYY-MM-DDTHH:mm:ss.SSS
d2End date (user creation date range)YYYY-MM-DDTHH:mm:ss.SSS
📘

Note

This report excludes users who hold an organisation position (staff/admin users) — only standalone customers are returned.

Fields:

FieldDescriptionTypeNullable
user_idEclipse user ID — sourced from the linked wallet's user_id (identical to the user's own ID); null if the user has no walletINTY
createdDate and time the customer's primary wallet was created — see note below, this is not the user record's own creation dateDATEY
first_nameFirst nameSTRN
last_nameLast nameSTRN
phone_numberPhone numberSTRN
emailEmail addressSTRN
national_identity_numberNational identity numberSTRN
passport_numberPassport numberSTRN
passport_expiryPassport expiry dateSTRN
asylum_ref_numberAsylum reference numberSTRN
city_of_birthCity of birthSTRN
country_of_birthCountry of birthSTRN
statusRaw numeric status of the customer's primary wallet — see note below, this is not the user's own status; null if the user has no walletINTY
external_idExternal identifier of the customer's primary wallet — see note below, this is not the user's own external_id; null if the user has no walletSTRY
genderGenderSTRN
dobDate of birthSTRN
otherFree-text metadata on the customer's primary wallet — see note below, this is not the user's own other field; null if the user has no walletSTRY
address_line_1Address line 1STRY
address_line_2Address line 2STRY
address_line_3Address line 3STRY
cityAddress citySTRY
stateAddress state/provinceSTRY
countryAddress countrySTRY
wallet_countTotal number of wallets the user holdsINTN
kyc_statusOnboarding status derived from the primary wallet: NO_WALLET, or <WALLET_STATUS>_WALLET — e.g. ACTIVE_WALLET, LOCKED_WALLET, BARRED_WALLET, PENDING_WALLET, JOINT_ACTIVE_WALLET, JOINT_PARTIAL_WALLET, CANCELLED_WALLETSTRN
wallet_idID of the customer's primary walletINTY
wallet_type_idWallet type ID of the primary walletINTY
balanceCurrent balance of the primary walletFLOATY
nameName of the primary walletSTRY
organisation_idOrganisation the primary wallet belongs toINTY
currencyCurrency of the primary walletSTRY
parent_wallet_idParent wallet ID, if the primary wallet is a sub-walletINTY
post_creation_callback_idsCallback IDs configured to run after wallet creationSTRY
friendly_idFriendly ID of the primary walletSTRY
credit_limitCredit limit of the primary walletFLOATY
preferencesWallet preferences metadataSTRY
promotion_codePromotion code applied to the primary walletSTRY
wallet_logic_set_idWallet logic set applied to the primary walletINTY
descriptionDescription of the primary walletSTRY
account_numberAccount number of the primary walletSTRY
last_activityDate and time of the primary wallet's last activityDATEY
📘

Note

The underlying query selects both user and wallet columns, and five of them share a name: user_id, created, status, external_id, and other. Because the wallet columns are selected last, their values overwrite the user columns of the same name in the JSON response — so created, status, external_id, and other reflect the customer's primary wallet, not the user record (user_id is unaffected, since it is identical for both). If the user has no wallet, all five of these fields are returned as null, even though the underlying user record has a value.


15. Postilion Cards

Report ID: Report_postilion_cards

A list of all Postilion-issued cards on the tenant, with the wallet each card is mapped to as its primary card and the tenant it belongs to.

Parameters: None

Fields:

FieldDescriptionTypeNullable
postilion_card_idUnique Postilion card IDINTN
createdDate and time the linked wallet was created — not the card's own creation dateDATEN
unique_idGlobally unique card referenceSTRN
tenant_idTenant IDINTY
tenantTenant nameSTRY
card_pack_idCard pack/product IDSTRN
user_idID of the card holderINTN
eclipse_wallet_idWallet ID the card is linked to in Postilion's own recordsINTY
device_typeCard device typeSTRY
statusCard statusSTRY
expiry_dateCard expiry date, MMYYSTRY
📘

Note

Only cards mapped as a wallet's primary Postilion card (PrimaryPostilionCard) are returned. Cards without that mapping are excluded from this report entirely.


16. Postilion Card Transactions

Report ID: Report_postilion_card_transactions

A ledger of system-wallet transactions tagged with a Postilion service code over a given period. Use this to reconcile card scheme settlement against Eclipse's own ledger.

Parameters:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
wallet_history_idUnique transaction IDINTN
system_wallet_idID of the system wallet the transaction was posted toINTN
wallet_nameName of the system walletSTRY
tenant_idTenant IDINTY
tenantTenant nameSTRY
wallet_descriptionDescription of the system walletSTRY
ledger_unique_idGlobally unique transaction IDSTRY
external_transaction_idExternal transaction referenceSTRY
transaction_dateDate and time the transaction endedDATEY
transaction_typeTransaction type — the underlying service code, e.g. containing postilionSTRN
descriptionTransaction descriptionSTRY
transaction_amountTransaction amountFLOATN
closing_balanceSystem wallet balance after the transactionFLOATN
other_wallet_idID of the counterparty wallet, as a stringSTRY
other_wallet_nameName of the counterparty walletSTRY
card_pack_idCard pack ID of the Postilion card linked to the counterparty wallet, if anySTRY
📘

Note

Only wallets flagged as system wallets are included — either by implementation_class or by an includeInSystemWalletMovements wallet type config entry.


17. Postilion Reservations

Report ID: Report_postilion_reservations

A list of fund reservations created against wallets by Postilion (identified by a PSTD- unique ID prefix) over a given period. Use this to see funds held against a card that haven't yet settled.

Parameters:

ParameterDescriptionFormat
d1Start dateYYYY-MM-DDTHH:mm:ss.SSS
d2End dateYYYY-MM-DDTHH:mm:ss.SSS

Fields:

FieldDescriptionTypeNullable
reservation_idUnique reservation IDINTN
unique_idReservation reference — prefixed PSTD- for Postilion reservationsSTRY
createdDate and time the reservation was createdDATEN
tenantTenant nameSTRY
tenant_idTenant IDINTY
expiresDate and time the reservation expiresDATEN
descriptionReservation descriptionSTRY
wallet_idWallet the funds are reserved againstINTY
amountReserved amountFLOATN
infoReservation metadataSTRY

Did this page help you?