---
canonical_url: "https://docs.composio.dev/toolkits/hitpay"
markdown_url: "https://docs.composio.dev/toolkits/hitpay.md"
product: "platform"
version: null
last_updated: null
---

# HitPay

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

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

## Tools

### Get Account Status

**Slug:** `HITPAY_GET_ACCOUNT_STATUS`

Check the connected HitPay business's verification, bank-account, and payment-provider readiness.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Balances

**Slug:** `HITPAY_GET_BALANCES`

Return available, pending, deposit, and reserve balances by currency and wallet provider.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Location

**Slug:** `HITPAY_GET_LOCATION`

Retrieve one HitPay business location by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_id` | string | Yes | UUID of the HitPay business location to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment Request

**Slug:** `HITPAY_GET_PAYMENT_REQUEST`

Retrieve the current status and details of one HitPay payment request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_request_id` | string | Yes | UUID of the payment request to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer ("5" | "10" | "20" | "25" | "50" | "100") | No | Customers per page: 5, 10, 20, 25, 50, or 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keywords` | string | No | Location name keywords or an exact location UUID. |
| `page_size` | integer | No | Maximum locations to return on this page (at least 1). |
| `next_cursor` | string | No | Page cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Requests

**Slug:** `HITPAY_LIST_PAYMENT_REQUESTS`

Search hosted payment requests and inspect their current payment status.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Categories

**Slug:** `HITPAY_LIST_PRODUCT_CATEGORIES`

Browse or search active and nested HitPay product categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Filter categories by active state. |
| `keywords` | string | No | Filter categories by name keywords. |
| `page_size` | integer | No | Maximum categories to return on this page (at least 1). |
| `parent_id` | string | No | Return subcategories of this parent category ID. |
| `next_cursor` | string | No | Page cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `HITPAY_LIST_PRODUCTS`

Search the HitPay product catalog using product, inventory, location, and sales-channel filters.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Recurring Billings

**Slug:** `HITPAY_LIST_RECURRING_BILLINGS`

Find recurring billing records by customer, reference, plan, or status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("active" | "scheduled" | "retrying" | "inactive" | "canceled") | No | Billing status: active, scheduled, retrying, inactive, or canceled. |
| `reference` | string | No | Filter by merchant reference number. |
| `customer_email` | string | No | Filter by customer email address. |
| `subscription_plan_id` | string | No | Filter by subscription-plan UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Staff

**Slug:** `HITPAY_LIST_STAFF`

Return staff members visible to the connected HitPay business account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscription Plans

**Slug:** `HITPAY_LIST_SUBSCRIPTION_PLANS`

List recurring-payment plans configured for the connected HitPay business.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum plans to return on this page (at least 1). |
| `next_cursor` | string | No | Page cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |