Core Models/Data Dictionary

Groov Data Model

Explore our core data models/schema/data dictionary and understand what the API objects mean in the context of the seller and buyer commerce/payments/partner dataset.

Data Dictionary Catalogue

Unified data entity	Details of the API Object	Link to API endpoints
CONNECT Consent (Authorisation)	Use "/v.../auth/consent/page" to request a CONNECT consent URL Use "/v.../auth/consent/ledgerAccountId" to look up and retrieve the Groov generated ledger account identifier using your institution platform identifier Use "/v.../auth/consent/status" to look up and retrieve the status of various partner connections for a speciific account using Groov generated ledger account identifier or your institution platform identifier. The status values returned will be from the enum list below {“Active”,“Revoked”,"Denied”,"Inactive”,“Lost Connection”,“Not Authorised”); where "Active" represents an authorised and an alive connection to the partner account	[Connect endpoints]
ledger account	Click for details of data dictionary	[Ledger account endpoints]
payment	Click for details of data dictionary	[Payment endpoints]
transaction	Click for details of data dictionary	[Transaction endpoints]
settlement	Click for details of data dictionary	[Settlement endpoints]
dispute	Click for details of data dictionary	[Dispute endpoints]
external account	Click for details of data dictionary	[External accounts endpoints]
customer	Click for details of data dictionary	[Customer endpoints]
product catalog	TBC	Backlog
orders	TBC	Backlog
subscription	TBC	Backlog
billing invoice	Click for details of data dictionary	[Billing Invoice endpoints]
billing invoice line item	Click for details of data dictionary	[Billing Invoice endpoints]
customer invoice	TBC	Backlog
Insights - Settlement Summary	Click for details of insights model	[Settlement summary endpoint]
Insights - Others	TBC	Q4 2024