> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# HitPay

> HitPay provides payment processing, commerce, invoicing, recurring billing, payout, and business-management APIs for merchants.

![HitPay logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/hitpay.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=1ae4dd836952ff63c77716ca08432b52)

* **Category:** payment processing
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 15
* **Triggers:** 0
* **Slug:** `HITPAY`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Account Status
>
> **Slug:** `HITPAY_GET_ACCOUNT_STATUS`
>
> Check the connected HitPay business's verification, bank-account, and payment-provider readiness.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Balances
>
> **Slug:** `HITPAY_GET_BALANCES`
>
> Return available, pending, deposit, and reserve balances by currency and wallet provider.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Location
>
> **Slug:** `HITPAY_GET_LOCATION`
>
> Retrieve one HitPay business location by ID.
>
> #### Input Parameters
>
> **location\_id** `string` *required*
>
> UUID of the HitPay business location to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment Request
>
> **Slug:** `HITPAY_GET_PAYMENT_REQUEST`
>
> Retrieve the current status and details of one HitPay payment request.
>
> #### Input Parameters
>
> **payment\_request\_id** `string` *required*
>
> UUID of the payment request to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Charges
>
> **Slug:** `HITPAY_LIST_CHARGES`
>
> Search completed and attempted charges by status, date, amount, payment request, customer, or location. Returns one page and an opaque continuation cursor.
>
> #### Input Parameters
>
> **status** `string ("succeeded" | "failed" | "refunded")`
>
> Charge status to match: succeeded, failed, or refunded.
>
> **date\_to** `string`
>
> Inclusive end date accepted by HitPay.
>
> **keywords** `string`
>
> Search by amount, charge ID, customer email, or remark.
>
> **amount\_to** `number`
>
> Maximum charge amount.
>
> **date\_from** `string`
>
> Inclusive start date accepted by HitPay.
>
> **page\_size** `integer ("10" | "15" | "20" | "25" | "40" | "50" | "75" | "99")`
>
> Charges per page: 10, 15, 20, 25, 40, 50, 75, or 99.
>
> **amount\_from** `number`
>
> Minimum charge amount.
>
> **customer\_id** `string`
>
> Customer UUID to match.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **location\_ids** `array`
>
> Location UUIDs to match. Accepts an array, one UUID, or a comma-separated string.
>
> **payment\_request\_id** `string`
>
> Payment-request UUID to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers
>
> **Slug:** `HITPAY_LIST_CUSTOMERS`
>
> List customer records stored by the connected HitPay business. Returns one provider-selected page because continuation input has not been verified.
>
> #### Input Parameters
>
> **page\_size** `integer ("5" | "10" | "20" | "25" | "50" | "100")`
>
> Customers per page: 5, 10, 20, 25, 50, or 100.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Invoices
>
> **Slug:** `HITPAY_LIST_INVOICES`
>
> Find 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
>
> **status** `string ("draft" | "sent" | "pending" | "overdue" | "paid")`
>
> Invoice status to match: draft, sent, pending, overdue, or paid.
>
> **page\_size** `integer ("5" | "10" | "20" | "25" | "50" | "100" | "1000")`
>
> Invoices per provider page: 5, 10, 20, 25, 50, 100, or 1000.
>
> **reference** `string`
>
> Filter by merchant invoice reference.
>
> **customer\_email** `string`
>
> Filter by customer email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Locations
>
> **Slug:** `HITPAY_LIST_LOCATIONS`
>
> List business locations, optionally filtering by name keywords or an exact location ID. Returns one page and a cursor for the next page.
>
> #### Input Parameters
>
> **keywords** `string`
>
> Location name keywords or an exact location UUID.
>
> **page\_size** `integer`
>
> Maximum locations to return on this page (at least 1).
>
> **next\_cursor** `string`
>
> Page cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Orders
>
> **Slug:** `HITPAY_LIST_ORDERS`
>
> Search HitPay commerce orders by version, status, date, or keywords. Returns one provider page because continuation input is not verified.
>
> #### Input Parameters
>
> **date\_to** `string`
>
> Inclusive end date in YYYY-MM-DD format.
>
> **include** `string ("products" | "charges" | "products,charges")`
>
> Related details to include: products, charges, or products,charges.
>
> **version** `string ("1.0" | "2.0")`
>
> Order version 1.0 or 2.0; omit to include both.
>
> **keywords** `string`
>
> Search by amount, creation date, order ID, remark, or customer name.
>
> **statuses** `array`
>
> Order statuses to include: completed, sent, draft, expired, or canceled.
>
> **date\_from** `string`
>
> Inclusive start date in YYYY-MM-DD format.
>
> **page\_size** `integer`
>
> Maximum orders in the provider-selected page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payment Requests
>
> **Slug:** `HITPAY_LIST_PAYMENT_REQUESTS`
>
> Search hosted payment requests and inspect their current payment status.
>
> #### Input Parameters
>
> **search** `string`
>
> Partial match against payment-request email, ID, or reference number.
>
> **page\_size** `integer`
>
> Maximum payment requests to return on this page (1-100).
>
> **is\_default** `boolean`
>
> When set, return only default custom or link payment requests.
>
> **next\_cursor** `string`
>
> Page cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Product Categories
>
> **Slug:** `HITPAY_LIST_PRODUCT_CATEGORIES`
>
> Browse or search active and nested HitPay product categories.
>
> #### Input Parameters
>
> **active** `boolean`
>
> Filter categories by active state.
>
> **keywords** `string`
>
> Filter categories by name keywords.
>
> **page\_size** `integer`
>
> Maximum categories to return on this page (at least 1).
>
> **parent\_id** `string`
>
> Return subcategories of this parent category ID.
>
> **next\_cursor** `string`
>
> Page cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products
>
> **Slug:** `HITPAY_LIST_PRODUCTS`
>
> Search the HitPay product catalog using product, inventory, location, and sales-channel filters.
>
> #### Input Parameters
>
> **sources** `array`
>
> Product sources to include: shopify or wooCommerce. Accepts an array, one source, or a comma-separated string.
>
> **channels** `array`
>
> Sales channels to include: pos, invoice, or online\_store. Accepts an array, one channel, or a comma-separated string.
>
> **keywords** `array`
>
> Product search keywords. Accepts an array or a single keyword; a keyword is never split on commas.
>
> **statuses** `array`
>
> Product statuses to include: draft or published. Accepts an array, one status, or a comma-separated string.
>
> **page\_size** `integer`
>
> Maximum products to return on this page (at least 1).
>
> **next\_cursor** `string`
>
> Page cursor returned by a previous call; omit for the first page.
>
> **category\_ids** `array`
>
> Category IDs to include. Accepts an array, one ID, or a comma-separated string.
>
> **location\_ids** `array`
>
> Location UUIDs to include. Accepts an array, one UUID, or a comma-separated string.
>
> **inventory\_states** `array`
>
> Inventory states to include: in\_stock or out\_of\_stock. Accepts an array, one state, or a comma-separated string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Recurring Billings
>
> **Slug:** `HITPAY_LIST_RECURRING_BILLINGS`
>
> Find 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
>
> **status** `string ("active" | "scheduled" | "retrying" | "inactive" | "canceled")`
>
> Billing status: active, scheduled, retrying, inactive, or canceled.
>
> **reference** `string`
>
> Filter by merchant reference number.
>
> **customer\_email** `string`
>
> Filter by customer email address.
>
> **subscription\_plan\_id** `string`
>
> Filter by subscription-plan UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Staff
>
> **Slug:** `HITPAY_LIST_STAFF`
>
> Return staff members visible to the connected HitPay business account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscription Plans
>
> **Slug:** `HITPAY_LIST_SUBSCRIPTION_PLANS`
>
> List recurring-payment plans configured for the connected HitPay business.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum plans to return on this page (at least 1).
>
> **next\_cursor** `string`
>
> Page cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
