The HoopAI Platform Payments API gives developers full programmatic control over the commerce layer of any account. Use it to list and record payments against orders, retrieve transaction history, manage subscriptions, create and delete discount coupons, and configure 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
OAuth scopes
All Payments API endpoints use the Location-Access scheme. Request only the scopes your integration requires.
| Scope | Access |
|---|
payments/orders.readonly | Read orders |
payments/orders.write | Create and update orders |
payments/orders.collectPayment | Record payments against orders |
payments/transactions.readonly | Read transaction records |
payments/subscriptions.readonly | Read subscription records |
payments/coupons.readonly | Read coupons |
payments/coupons.write | Create, update, and delete coupons |
payments/custom-provider.readonly | Read custom provider configuration |
payments/custom-provider.write | Create, 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
| Method | Path | Description |
|---|
GET | /payments/orders | List Orders |
GET | /payments/orders/{orderId} | Get Order by ID |
POST | /payments/orders/{orderId}/record-payment | Record Order Payment |
POST | /payments/orders/{orderId}/fulfillments | Create order fulfillment |
GET | /payments/orders/{orderId}/fulfillments | List fulfillment |
GET | /payments/orders/{orderId}/notes | List Order Notes |
GET | /payments/transactions | List Transactions |
GET | /payments/transactions/{transactionId} | Get Transaction by ID |
GET | /payments/subscriptions | List Subscriptions |
GET | /payments/subscriptions/{subscriptionId} | Get Subscription by ID |
GET | /payments/coupon/list | List Coupons |
POST | /payments/coupon | Create Coupon |
PUT | /payments/coupon | Update Coupon |
DELETE | /payments/coupon | Delete Coupon |
GET | /payments/coupon | Fetch Coupon |
POST | /payments/custom-provider/provider | Create new integration |
DELETE | /payments/custom-provider/provider | Deleting an existing integration |
GET | /payments/custom-provider/connect | Fetch given provider config |
POST | /payments/custom-provider/connect | Create new provider config |
POST | /payments/custom-provider/disconnect | Disconnect existing provider config |
PUT | /payments/custom-provider/capabilities | Custom-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 5, 2026
