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

Please browse through our catalog to see the rich estate of data, insights and services we have in offer for you.

Catalog Family Component

What does it do

Link 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 clientsCONNECT 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

Consent endpointFeb 23Y (Live)Y (Live)Y (Live)

Global Payments/DoJo/Elavon/Zettle: Q1 23

Rest: Q2 23

TBCledger accountUse this entity to look up details of the setup of one or more connected business customer as per

API/ endpoints

CONNECT (Authorisation)

Allows you to use Groov's white labelled Connect flow for your customers to provide authorised access to their merchant/commerce/trading accounts thus resulting in a connected account on Groov platform. It also includes endpoints for you to provide deep integration to Groov without using Groovs hosted page instead calling the various Connect partners whilst keeping the merchant experience in your application. Also has endpoints to manage authorisation like ability to revoke, getting status of connected accounts.


Authorisation & Connect API endpoints

ledger account

Use this API family endpoints to look up the business account details/ merchant account details of your connected account as per whats available with their merchant/commerce/trading account providers. You can query for your customers MID, terminal setup, merchant account hierarchy, business details, address details using the listed endpoints

Ledger account endpoints

Feb 22Y (Live)Y (Live)Y (Live)Q1/Q2 2023

TBC

payment

Use this

entity transactionTransaction endpointsNov 21Y (Live)Y (Live)Y (Live) - Switched offQ1/Q2 2023TBCsettlementSettlement endpointsNov 21Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBCdisputeDispute endpointsNov 21Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBC

API family endpoints to access the list of all payments as would appear on the merchant/commerce/trading accounts of one or more of your 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 21Y (Live)Y (Live)Y (Live) - Switched offQ1/Q2 2023TBCcustomerCustomer endpointsDec 21Y (Live)NANATBC

transaction

Use this API family endpoints to access information about any kind of funds that move through the ledger account's commerce platform or POS ecosystem (primarily merchant account). 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

settlement

Use this API family endpoints to understand the funding/payout your merchant business receives from their commerce/payment partner/provider, based on either an automated payout schedule or a manual orchestration, depending on the merchants county/industry setup with its commerce/payment partner provider. 

Settlement endpoints

dispute

Use this API family endpoints to understand Information on disputes/chargebacks

Dispute endpoints

external account (/Bank; /Card; /Others)

External accounts endpointsDec 21Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBCproduct catalogBacklog-TBCNANATBC-ordersBacklog-TBCNANATBC-subscriptionBacklog-TBCNANATBC-

Use this to understand the payout transfer destinations (Banks, Cards or wallets)  for a merchant (ledger account)

External accounts endpoints

customer

Use this to view information about a merchants/businesses customers i.e its buyers information

Customer endpoints

billing invoices (aka Statements as pdfs)

Use this to view and/or download the monthly VAT statements/ invoices that a merchant receives from its commerce/payment partner provider. This also provides the PSR mandated Summary Information for a merchant account

Billing Invoice endpoints

Feb 23NANAY (Live)Q1/Q2 2023TBC

billing invoice line items

Use this to access the line item level information within a monthly statement/invoice to see transaction charge split, miscellaneous fees, VAT info and any other charges that exist.

Billing invoice line item endpoint

insights - settlement summary

Use this

entity 

as an easy way to get an aggregated/rolled up view of a

seller's

merchants (account ledger)

payout/funding received from its commerce/payment partner/providersettlement summary endpointOct 22Y (Live)Y (Live)Y (Live)Q1/Q2 2023TBCInsights - othersBacklogTBCTBCTBCTBCTBCTBC

business health score, business analytics, MI data and statistical information as available

Insights endpoints

Webhooks

Use this to set webhook's and subscribe to various events generated on the Groov platform for all your connected accounts including platform events wherever provided

Webhook

Events

product catalog


Backlog

orders


Backlog

subscription


Backlog


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:

Table of Contents



Related pages

Filter by label (Content by label)
showLabelsfalse
spacesGroovDocs
showSpacefalse
sorttitle
typepage
cqllabel in ( "api-setup-landing" , "get-started-developer" , "core-model" ) and type = "page" and space = "GroovDocs"
labelsdocumentation-space-sample