Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Groov API catalog and planned endpoints we are working on vs whats available.
Catalog
| Connection Sources (ROADMAP) | ||||||||
| Unified data entity | What does it do | Link to Swagger/model | Updated | Stripe | SumUp | Worldpay | Barclaycard, Global payments, Elavon, DoJo (Payment Sense), AIBMS, iZettle, Paypal | Amazon, Shopify, WooCommerce, Magento, Square, eBay, Wix, BigCommerce, Marketplaces/Other eCommerce platforms (eg: Etsy;NOTHS; Others) as requested/prioritised by our clients |
|---|---|---|---|---|---|---|---|---|
| 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 endpoint | Feb 23 | Y (Live) | Y (Live) | Y (Live) | Global Payments/DoJo/Elavon/Zettle: Q1 23 Rest: Q2 23 | TBC |
| ledger account | Use this entity to look up details of the setup of one or more connected business customer as per their merchant/commerce/trading account providers. You can query for your customers MID, terminal setup, merchant account hierarchy, business details using the listed endpoints | Ledger account endpoints | Feb 22 | Y (Live) | Y (Live) | Y (Live) | Q1/Q2 2023 | TBC |
| payment | Use this entity to access the list of all payments as would appear on the merchant/commerce/trading accounts of one or more connected business customers. You can view details of the payments like the currency, amount, type, payment method, payment type, linked disputes and any other related granular information | Payment endpoints | Nov 21 | Y (Live) | Y (Live) | Y (Live) - Switched off | Q1/Q2 2023 | TBC |
| transaction | Transaction endpoints | Nov 21 | Y (Live) | Y (Live) | Y (Live) - Switched off | Q1/Q2 2023 | TBC | |
| settlement | Settlement endpoints | Nov 21 | Y (Live) | Y (Live) | Y (Live) | Q1/Q2 2023 | TBC | |
| dispute | Dispute endpoints | Nov 21 | Y (Live) | Y (Live) | Y (Live) | Q1/Q2 2023 | TBC | |
| external account (/Bank; /Card; /Others) | External accounts endpoints | Dec 21 | Y (Live) | Y (Live) | Y (Live) | Q1/Q2 2023 | TBC | |
| customer | Customer endpoints | Feb 23; Dec 21 | Y (Live) - Switched Off | NA | NA | TBC | ||
| billing invoices (aka Statements as pdfs) | Billing Invoice endpoints | Feb 23 | NA | NA | Y (Live) | Q1/Q2 2023 | TBC | |
| product catalog | Backlog | - | TBC | NA | NA | TBC | - | |
| orders | Backlog | - | TBC | NA | NA | TBC | - | |
| subscription | Backlog | - | TBC | NA | NA | TBC | - | |
| insights - settlement summary | Use this entity an easy way to get an aggregated/rolled up view of a seller's (account ledger) payout/funding received from its commerce/payment partner/provider | settlement summary endpoint | Oct 22 | Y (Live) | Y (Live) | Y (Live) | Q1/Q2 2023 | TBC |
| Insights - others | Backlog | TBC | TBC | TBC | TBC | TBC | TBC | |
Refer to the following Core Model/Data Dictionary page for additional documentation on the schema/models
Access our Swagger documentation here
| Panel | |
|---|---|
On this page:
|
Related pages
| Filter by label (Content by label) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|