Skip to main content
The HoopAI Platform Payments API gives developers full programmatic control over the commerce layer of any sub-account. Use it to list and record payments against orders, retrieve transaction history, manage subscriptions, create and delete discount coupons, and configure white-label or custom payment provider integrations — all from a single authenticated REST API.

​
Base URL

https://services.leadconnectorhq.com

​
Authentication

Every request must include a Bearer token and the API version header. 
Authorization: Bearer <access_token>
Version: 2021-07-28
See OAuth 2.0 for details on obtaining an access token.

​
OAuth scopes

All Payments API endpoints use the Location-Access scheme. Request only the scopes your integration requires.
ScopeAccess
payments/orders.readonlyRead orders
payments/orders.writeCreate and update orders
payments/orders.collectPaymentRecord payments against orders
payments/transactions.readonlyRead transaction records
payments/subscriptions.readonlyRead subscription records
payments/coupons.readonlyRead coupons
payments/coupons.writeCreate, update, and delete coupons
payments/integration.readonlyRead white-label integration providers
payments/integration.writeCreate white-label integration providers
payments/custom-provider.readonlyRead custom provider configuration
payments/custom-provider.writeCreate, update, and disconnect custom providers

​
Quick start

List the most recent orders for a location: 
curl -X GET "https://services.leadconnectorhq.com/payments/orders?locationId=<locationId>&limit=10" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"

​
Endpoints

MethodPathDescription
POST/payments/integrations/provider/whitelabelCreate White-label Integration Provider
GET/payments/integrations/provider/whitelabelList White-label Integration Providers
GET/payments/ordersList Orders
GET/payments/orders/{orderId}Get Order by ID
POST/payments/orders/{orderId}/record-paymentRecord Order Payment
POST/payments/orders/{orderId}/fulfillmentsCreate order fulfillment
GET/payments/orders/{orderId}/fulfillmentsList fulfillment
GET/payments/orders/{orderId}/notesList Order Notes
GET/payments/transactionsList Transactions
GET/payments/transactions/{transactionId}Get Transaction by ID
GET/payments/subscriptionsList Subscriptions
GET/payments/subscriptions/{subscriptionId}Get Subscription by ID
GET/payments/coupon/listList Coupons
POST/payments/couponCreate Coupon
PUT/payments/couponUpdate Coupon
DELETE/payments/couponDelete Coupon
GET/payments/couponFetch Coupon
POST/payments/custom-provider/providerCreate new integration
DELETE/payments/custom-provider/providerDeleting an existing integration
GET/payments/custom-provider/connectFetch given provider config
POST/payments/custom-provider/connectCreate new provider config
POST/payments/custom-provider/disconnectDisconnect existing provider config
PUT/payments/custom-provider/capabilitiesCustom-provider marketplace app update capabilities
  • Products API — Manage products and pricing linked to orders
  • Invoices API — Create and send invoices and payment requests
  • Store API — Configure shipping zones, carriers, and store settings
Last modified on March 4, 2026