15 available actions
What your AI agent can do in HitPay
HitPay provides payment processing, commerce, invoicing, recurring billing, payout, and business-management APIs for merchants. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 15 actions.
Common starting points
- Get Payment RequestRetrieve the current status and details of one HitPay payment request.
- List Payment RequestsSearch hosted payment requests and inspect their current payment status.
Browse all 15 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 15 actions
- Get Account StatusCheck the connected HitPay business's verification, bank-account, and payment-provider readiness.
- Get BalancesReturn available, pending, deposit, and reserve balances by currency and wallet provider.
- Get LocationRetrieve one HitPay business location by ID.
- Get Payment RequestRetrieve the current status and details of one HitPay payment request.
- List ChargesSearch completed and attempted charges by status, date, amount, payment request, customer, or location.
- List CustomersList customer records stored by the connected HitPay business.
- List InvoicesFind invoices by customer email, status, or merchant reference.
- List LocationsList business locations, optionally filtering by name keywords or an exact location ID.
- List OrdersSearch HitPay commerce orders by version, status, date, or keywords.
- List Payment RequestsSearch hosted payment requests and inspect their current payment status.
- List Product CategoriesBrowse or search active and nested HitPay product categories.
- List ProductsSearch the HitPay product catalog using product, inventory, location, and sales-channel filters.
- List Recurring BillingsFind recurring billing records by customer, reference, plan, or status.
- List StaffReturn staff members visible to the connected HitPay business account.
- List Subscription PlansList recurring-payment plans configured for the connected HitPay business.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect HitPay
How does the agent connect to HitPay?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in HitPay?
The page above lists the 15 actions currently available through the HitPay connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is HitPay included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until HitPay is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put HitPay to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.