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, Connection”,“Not Authorised”); where "Active" represents an authorised and an alive connection to the partner account| DoJo | Global Payments | Elavon | Zettle by Paypal Jun 23 | Barclaycard, AIBMS, 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 Allows you to use Groov's white labelled consent flow for your customers to provide authroised access to their merchant/commerce/trading accounts
| Connect endpoint | Feb 23 |
Y (Live) | Y (Live) | Y (Live) | Global Payments/DoJo/Elavon/Zettle: Q1 23
Rest: Q2 23Q1/Q2 | Live | Live | Live | Live | Live | Live | Live | H2 2023 | 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) | | Live | Live | Live | Live | Live | Live | Live | H2 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 ()Y ()Y () - Switched off| - Disabled | Backlog | Backlog | Backlog | Backlog | Q1/Q2 2023 | TBC |
| transaction | Use this entity to access information about any kind of funds that move through the ledger account's commerce platform or POS system. This will not only includes charges and refunds but will also cater to adjustments, payment exceptions, fees/charges, other costs associated during the payment processing cycle. | Transaction endpoints | Nov 21 |
Y ()Y ()Y () - Switched off| - Disabled | Backlog | Backlog | Backlog | Backlog | Q1/Q2 2023 | TBC |
| settlement | Use this entity to understand the funding/payout a seller (account ledger) receives from their commerce/payment partner/provider, based on either an automated payout schedule or a manual orchestration, depending on the sellers county/industry setup with its commerce/payment partner provider. | Settlement endpoints | Nov 21 |
Y (Live) | Y (Live) | Y (Live) | Live | Live | Live | Live | Live | Live | Live | Q1/Q2 2023 | TBC |
| dispute | Use this entity to understand Information on disputes/chargebacks | Dispute endpoints | Nov 21 |
Y ()Y ()Y (Live)Y (Live)| Live | NA | NA | NA | NA | Q1/Q2 2023 | TBC |
| external account (/Bank; /Card; /Others) | Use this to understand the payout transfer destinations (Banks, Cards or wallets) for a seller/ledger account or are accounts that relate to a customers saved payment method/source | External accounts endpoints | Dec 21 |
Y (Live) | Y (Live) | | Live | Live | Live | Live | Live | Live | NA | Q1/Q2 2023 | TBC |
| customer | Use this to view information about a merchant sellers/businesses customers i.e its buyers detail. | Customer endpoints | Feb 23; Dec 21 | Y (Live) - Switched Off | NA | NA | NA | NA | NA | NA |
| TBC |
| billing invoices (aka Statements as pdfs) | Use this to view the monthly invoices and download a pdf object of the same | Billing Invoice endpoints | Feb 23 | NA | NA |
Y (Live) | Live | Live | Live | Live | NA | Q1/Q2 2023 | TBC |
| billing invoice line items | Use this entity to access the line item level information within a monthly invoice to see transaction charge split, miscellaneous fees, VAT info and any other charges that appears on an invoice/statement | Billing invoice line item endpoint | Jun 23 | NA | NA | Live | Live | Live | Live | NA |
|
|
| product catalog |
| Backlog | - | TBC | NA | NA | NA | NA | NA | Backlog | TBC | - |
| orders |
| Backlog | - | TBC | NA | NA | NA | NA | NA | Backlog | TBC | - |
| subscription |
| Backlog | - | TBC | NA | NA | NA | NA | 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) | Live | Live | Live | Live | Live | Live | 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