Skip to main content
HitPay logo
  • Category: payment processing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 15
  • Triggers: 0
  • Slug: HITPAY
  • Version: 20261101_00

Tools

Slug: HITPAY_GET_ACCOUNT_STATUSCheck the connected HitPay business’s verification, bank-account, and payment-provider readiness.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_GET_BALANCESReturn available, pending, deposit, and reserve balances by currency and wallet provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_GET_LOCATIONRetrieve one HitPay business location by ID.

Input Parameters

string
required
UUID of the HitPay business location to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_GET_PAYMENT_REQUESTRetrieve the current status and details of one HitPay payment request.

Input Parameters

string
required
UUID of the payment request to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_CHARGESSearch completed and attempted charges by status, date, amount, payment request, customer, or location. Returns one page and an opaque continuation cursor.

Input Parameters

string ("succeeded" | "failed" | "refunded")
Charge status to match: succeeded, failed, or refunded.
string
Inclusive end date accepted by HitPay.
string
Search by amount, charge ID, customer email, or remark.
number
Maximum charge amount.
string
Inclusive start date accepted by HitPay.
integer ("10" | "15" | "20" | "25" | "40" | "50" | "75" | "99")
Charges per page: 10, 15, 20, 25, 40, 50, 75, or 99.
number
Minimum charge amount.
string
Customer UUID to match.
string
Opaque cursor returned by a previous call; omit for the first page.
array
Location UUIDs to match. Accepts an array, one UUID, or a comma-separated string.
string
Payment-request UUID to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_CUSTOMERSList customer records stored by the connected HitPay business. Returns one provider-selected page because continuation input has not been verified.

Input Parameters

integer ("5" | "10" | "20" | "25" | "50" | "100")
Customers per page: 5, 10, 20, 25, 50, or 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_INVOICESFind invoices by customer email, status, or merchant reference. Returns one provider page; continuation is unavailable because HitPay’s cursor input has not been verified.

Input Parameters

string ("draft" | "sent" | "pending" | "overdue" | "paid")
Invoice status to match: draft, sent, pending, overdue, or paid.
integer ("5" | "10" | "20" | "25" | "50" | "100" | "1000")
Invoices per provider page: 5, 10, 20, 25, 50, 100, or 1000.
string
Filter by merchant invoice reference.
string
Filter by customer email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_LOCATIONSList business locations, optionally filtering by name keywords or an exact location ID. Returns one page and a cursor for the next page.

Input Parameters

string
Location name keywords or an exact location UUID.
integer
Maximum locations to return on this page (at least 1).
string
Page cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_ORDERSSearch HitPay commerce orders by version, status, date, or keywords. Returns one provider page because continuation input is not verified.

Input Parameters

string
Inclusive end date in YYYY-MM-DD format.
string ("products" | "charges" | "products,charges")
Related details to include: products, charges, or products,charges.
string ("1.0" | "2.0")
Order version 1.0 or 2.0; omit to include both.
string
Search by amount, creation date, order ID, remark, or customer name.
array
Order statuses to include: completed, sent, draft, expired, or canceled.
string
Inclusive start date in YYYY-MM-DD format.
integer
Maximum orders in the provider-selected page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_PAYMENT_REQUESTSSearch hosted payment requests and inspect their current payment status.

Input Parameters

Partial match against payment-request email, ID, or reference number.
integer
Maximum payment requests to return on this page (1-100).
boolean
When set, return only default custom or link payment requests.
string
Page cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_PRODUCT_CATEGORIESBrowse or search active and nested HitPay product categories.

Input Parameters

boolean
Filter categories by active state.
string
Filter categories by name keywords.
integer
Maximum categories to return on this page (at least 1).
string
Return subcategories of this parent category ID.
string
Page cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_PRODUCTSSearch the HitPay product catalog using product, inventory, location, and sales-channel filters.

Input Parameters

array
Product sources to include: shopify or wooCommerce. Accepts an array, one source, or a comma-separated string.
array
Sales channels to include: pos, invoice, or online_store. Accepts an array, one channel, or a comma-separated string.
array
Product search keywords. Accepts an array or a single keyword; a keyword is never split on commas.
array
Product statuses to include: draft or published. Accepts an array, one status, or a comma-separated string.
integer
Maximum products to return on this page (at least 1).
string
Page cursor returned by a previous call; omit for the first page.
array
Category IDs to include. Accepts an array, one ID, or a comma-separated string.
array
Location UUIDs to include. Accepts an array, one UUID, or a comma-separated string.
array
Inventory states to include: in_stock or out_of_stock. Accepts an array, one state, or a comma-separated string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_RECURRING_BILLINGSFind recurring billing records by customer, reference, plan, or status. Status defaults to active; results contain one provider-selected page with no continuation input.

Input Parameters

string ("active" | "scheduled" | "retrying" | "inactive" | "canceled")
Billing status: active, scheduled, retrying, inactive, or canceled.
string
Filter by merchant reference number.
string
Filter by customer email address.
string
Filter by subscription-plan UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_STAFFReturn staff members visible to the connected HitPay business account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HITPAY_LIST_SUBSCRIPTION_PLANSList recurring-payment plans configured for the connected HitPay business.

Input Parameters

integer
Maximum plans to return on this page (at least 1).
string
Page cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not