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 27 Current »

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/modelUpdatedStripeSumUpWorldpayDoJoGlobal PaymentsElavon

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)

Allows you to use Groov's white labelled consent flow for your customers to provide authroised access to their merchant/commerce/trading accounts


Connect endpointFeb 23LiveLiveLiveLiveLiveLiveLive

H2 2023

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 22LiveLiveLiveLiveLiveLiveLiveH2 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 21LiveLiveLive - DisabledBacklogBacklogBacklogBacklogH2 2023TBC
transactionUse 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 endpointsNov 21LiveLiveLive - DisabledBacklogBacklogBacklogBacklogH2 2023TBC
settlementUse 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 endpointsNov 21LiveLiveLiveLiveLiveLiveLiveH2 2023TBC
disputeUse this entity to understand Information on disputes/chargebacksDispute endpointsNov 21LiveLiveLiveNANANANAH2 2023TBC
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/sourceExternal accounts endpointsDec 21LiveLiveLiveLiveLiveLiveNAH2 2023TBC
customerUse this to view information about a merchant sellers/businesses customers i.e its buyers detail.Customer endpoints

Feb 23; Dec 21

Y (Live) - Switched OffNANANANANANAH2 2023TBC
billing invoices (aka Statements as pdfs)Use this to view the monthly invoices and download a pdf object of the sameBilling Invoice endpointsFeb 23NANALiveLiveLiveLiveNAH2 2023TBC
billing invoice line itemsUse 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 endpointJun 23NANALiveLiveLiveLiveNAH2 2023TBC
product catalog
Backlog-TBCNANANANANABacklogTBC-
orders
Backlog-TBCNANANANANABacklogTBC-
subscription
Backlog-TBCNANANANANANATBC-
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 22LiveLiveLiveLiveLiveLiveLiveH2 2023TBC
Insights - others
BacklogTBCTBCTBCTBC



TBCTBC


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