Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Next »

Groov API catalog and planned endpoints we are working on vs whats available.

Catalog






Connection Sources (ROADMAP)
Unified data entityWhat does it doLink to Swagger/modelUpdatedStripeSumUpWorldpay

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 endpointFeb 23Y (Live)Y (Live)Y (Live)

Global Payments/DoJo/Elavon/Zettle: Q1 23

Rest: Q2 23

TBC
ledger accountUse 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 endpointsLedger account endpointsFeb 22Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBC
paymentUse 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 endpointsNov 21Y (Live)Y (Live)Y (Live) - Switched offQ1/Q2 2023TBC
transaction
Transaction endpointsNov 21Y (Live)Y (Live)Y (Live) - Switched offQ1/Q2 2023TBC
settlement
Settlement endpointsNov 21Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBC
dispute
Dispute endpointsNov 21Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBC
external account (/Bank; /Card; /Others)
External accounts endpointsDec 21Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBC
customer
Customer endpoints

Feb 23; Dec 21

Y (Live) - Switched OffNANA
TBC
billing invoices (aka Statements as pdfs)
Billing Invoice endpointsFeb 23NANAY (Live)Q1/Q2 2023TBC
product catalog
Backlog-TBCNANATBC-
orders
Backlog-TBCNANATBC-
subscription
Backlog-TBCNANATBC-
insights - settlement summaryUse 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/providersettlement summary endpointOct 22Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBC
Insights - others
BacklogTBCTBCTBCTBCTBCTBC


Refer to the following Core Model/Data Dictionary page for additional documentation on the schema/models


Access our Swagger documentation here


On this page:


  • No labels