Requirements
HitPay requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]
Get your HitPay credentials
- API KeypasswordRequired
- EnvironmentselectRequired
Connect HitPay in WEXTL
- Log in to your WEXTL account, add the HitPay node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your HitPay account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
HitPay node modules
The list below is a reference of every HitPay node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every HitPay node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch EventsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Business ID | text |
| Channel | text |
| Customer ID | text |
| Status | text |
| Customer | object |
| Name | text |
| text | |
| Phone number | text |
| Address | object |
| Currency | text |
| Amount | number |
| Refunded amount | number |
| Refunded at | text |
| Fixed fee | number |
| Discount fee | number |
| Discount fee rate | number |
| Failed reason | text |
| Order | object |
| ID | text |
| Order display number | number |
| Business ID | text |
| Channel | text |
| Version | text |
| Customer ID | text |
| Business customer ID | text |
| Customer | object |
| Customer pickup | boolean |
| Currency | text |
| Order ID | text |
| Remark | text |
| Payment intents | array |
| Payment request ID | text |
| Payment request | text |
12other output fields
Get a ChargeAction
Input fields[3]
| Field | Type |
|---|---|
Charge IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Currency | text |
| Home currency | text |
| Exchange rate | text |
| Amount | number |
| Fixed fee | number |
| Discount fee | number |
| Discount fee rate | number |
| Remark | text |
| Status | text |
| Payment method | object |
| Name | text |
| Display logo | object |
| Method logo | object |
| Data | object |
| Customer ID | text |
| Customer | object |
| Name | text |
| Phone number | text |
| Payment request ID | text |
| Webhook status | boolean |
| Order reference number | text |
| Executor | text |
| Location | object |
| ID | text |
| Name | text |
| Address | text |
| Channel | text |
| Admin fee | boolean |
3other output fields
Get a CustomerAction
Get a Payment Request StatusAction
Input fields[3]
| Field | Type |
|---|---|
Payment Request IDRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Phone | text |
| Amount | text |
| Currency | text |
| Is currency editable | boolean |
| Status | text |
| Purpose | text |
| Reference number | text |
| Payment methods | array |
| URL | url |
| Redirect URL | url |
| Webhook | text |
| Send sms | boolean |
| Send email | boolean |
| Sms status | text |
| Email status | text |
| Allow repeated payments | boolean |
| Expiry date | text |
8other output fields
Get a ProductAction
Input fields[3]
| Field | Type |
|---|---|
Product IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Business ID | text |
| Category ID | array |
| Name | text |
| Headline | text |
| Description | text |
| Currency | text |
| Price | number |
| Price display | text |
| Price stored | number |
| Tax ID | text |
| Is manageable | number |
| Is pinned | boolean |
| Status | text |
| Product weight | number |
| Delivery method required | boolean |
| Has variations | boolean |
| Is shopify | boolean |
| Product URL | url |
| Variations count | number |
10other output fields
List CustomersSearch
List InvoicesSearch
List Payment RequestsSearch
Input fields[3]
| Field | Type |
|---|---|
| Limit | number |
Search ChargesSearch
Input fields[3]
| Field | Type |
|---|---|
| Keywords | text |
| Status | choice |
| Location IDs | array |
| User IDs | array |
| Statuses | array |
| Date From | text |
| Date To | text |
| Amount From | number |
| Amount To | number |
| Payment Request ID | text |
| Customer ID | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Currency | text |
| Home currency | text |
| Exchange rate | text |
| Amount | number |
| Fixed fee | number |
| Discount fee | number |
| Discount fee rate | number |
| Remark | text |
| Status | text |
| Payment method | object |
| Name | text |
| Display logo | object |
| Method logo | object |
| Data | object |
| Customer ID | text |
| Customer | object |
| Name | text |
| Phone number | text |
| Payment request ID | text |
| Webhook status | boolean |
| Order reference number | text |
| Executor | text |
| Location | object |
| ID | text |
| Name | text |
| Address | text |
| Channel | text |
| Admin fee | boolean |
3other output fields
Search ProductsSearch
Input fields[3]
| Field | Type |
|---|---|
| Statuses | array |
| Categories | array |
| Category ID | text |
| Source | array |
| Inventory | array |
| Location IDs | array |
| Location ID | text |
| Channels | array |
| Keywords | array |
| Keyword | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Business ID | text |
| Category ID | array |
| Name | text |
| Headline | text |
| Description | text |
| Currency | text |
| Price | number |
| Price display | text |
| Price stored | number |
| Tax ID | text |
| Is manageable | number |
| Is pinned | boolean |
| Status | text |
| Product weight | number |
| Delivery method required | boolean |
| Has variations | boolean |
| Is shopify | boolean |
| Product URL | url |
| Variations count | number |
10other output fields
Create a CustomerAction
Input fields[3]
| Field | Type |
|---|---|
EmailRequired | |
Phone NumberRequired | text |
| Address | object |
CityRequired | text |
StateRequired | text |
StreetRequired | text |
Postal CodeRequired | text |
| Country | text |
| Name | text |
| Phone Number Country Code | text |
| Remark | text |
| Birth Date | date |
| Gender | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Birth date | text |
| Gender | text |
| Phone number | text |
| Address | object |
| City | text |
| State | text |
| Street | text |
| Postal code | text |
| Country | text |
| Remark | text |
| Phone number country code | text |
| Created at | date |
| Updated at | date |
Create a Payment RequestAction
Input fields[3]
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | choice |
| Payment Methods | array |
| Purpose | text |
| Buyer’s Name | text |
| Reference Number | text |
| Redirect URL | url |
| Webhook URL | url |
| Allow Repeated Payments | boolean |
| Expiry Date | date |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Phone | text |
| Amount | text |
| Currency | text |
| Status | text |
| Purpose | text |
| Reference number | text |
| Payment methods | array |
| URL | url |
| Redirect URL | url |
| Webhook | text |
| Send sms | boolean |
| Send email | boolean |
| Sms status | text |
| Email status | text |
| Allow repeated payments | boolean |
| Expiry date | text |
| Created at | date |
1other output field
Create a ProductAction
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
PriceRequired | number |
| Description | text |
| Barcode | text |
| Headline | text |
| Stock Keeping Unit | text |
| Quantity | number |
| Quantity Alert Level | number |
| Currency | choice |
| Category IDs | array |
| Category ID | choice |
| Channels | array |
| Location IDs | array |
| Location ID | text |
| Locations | array |
| Open Amount | choice |
| Is Manageable | choice |
| Is Pinned | choice |
| Product Weight | number |
| Delivery Method Required | boolean |
| Variations | array |
| Image | array |
1other input field
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Business ID | text |
| Category ID | array |
| Name | text |
| Headline | text |
| Description | text |
| Currency | text |
| Price | number |
| Price display | text |
| Price stored | number |
| Tax ID | text |
| Is manageable | number |
| Is pinned | boolean |
| Status | text |
| Product weight | number |
| Delivery method required | boolean |
| Has variations | boolean |
| Is shopify | boolean |
| Product URL | url |
| Variations count | number |
10other output fields
Create an InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
Invoice DateRequired | date |
CurrencyRequired | choice |
| Payment Methods | array |
Payment ByRequired | choice |
| Customer | object |
| Customer Name | text |
| Customer Email | |
| Customer Address | object |
| Customer ID | choice |
| Due Date | date |
| Auto Invoice Number | text |
| Invoice Number | text |
| Subtotal | number |
| Tax Setting | text |
| Send Email | number |
| Webhook | url |
| Reference | text |
| Footer | text |
| Allow Partial Payments | choice |
| Partial Payments | array |
| Stackable Discounts | array |
| Recipients | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
Delete a CustomerAction
Input fields[3]
| Field | Type |
|---|---|
Customer IDRequired | choice |
Delete a Payment RequestAction
Input fields[3]
| Field | Type |
|---|---|
Payment Request IDRequired | text |
Delete a ProductAction
Input fields[3]
| Field | Type |
|---|---|
Product IDRequired | choice |
Delete an InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Make an API Calluniversal
Print a Charge ReceiptAction
Refund a ChargeAction
Input fields[3]
| Field | Type |
|---|---|
AmountRequired | number |
Payment IDRequired | text |
| Webhook URL | url |
| Send Email | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Refunded by | text |
| Payment ID | text |
| Amount refunded | number |
| Total amount | number |
| Currency | text |
| Status | text |
| Payment method | text |
| Provider fee | text |
| Provider fee currency | text |
| Refunded at | date |
| Created at | date |
Update a CustomerAction
Input fields[3]
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Phone Number | text |
| Address | object |
| City | text |
| State | text |
| Street | text |
| Postal Code | text |
| Country | text |
| Name | text |
| Phone Number Country Code | text |
| Remark | text |
| Birth Date | date |
| Gender | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Birth date | text |
| Gender | text |
| Phone number | text |
| Address | object |
| City | text |
| State | text |
| Street | text |
| Postal code | text |
| Country | text |
| Remark | text |
| Phone number country code | text |
| Created at | date |
| Updated at | date |
Update a Payment RequestAction
Input fields[3]
| Field | Type |
|---|---|
Payment Request IDRequired | text |
AmountRequired | number |
CurrencyRequired | text |
| Address | object |
Address Line 1Required | text |
CityRequired | text |
CountryRequired | text |
StateRequired | text |
Postal CodeRequired | text |
| Address Line 2 | text |
| Payment Methods | array |
| Name | text |
| Phone | text |
| WiFi Terminal ID | text |
| Staff ID | text |
| Purpose | text |
| Reference Number | text |
| Redirect URL | url |
| Webhook URL | url |
| Allow Repeated Payments | choice |
| Expiry Date | date |
| Expires After | text |
| Add Admin Fee | choice |
| Send Email | choice |
| Send SMS | choice |
1other input field
Update a ProductAction
Input fields[3]
| Field | Type |
|---|---|
Product IDRequired | choice |
| Name | text |
| Price | number |
| Description | text |
| Barcode | text |
| Headline | text |
| Stock Keeping Unit | text |
| Quantity | number |
| Quantity Alert Level | number |
| Currency | choice |
| Category IDs | array |
| Category ID | choice |
| Channels | array |
| Location IDs | array |
| Location ID | text |
| Locations | array |
| Open Amount | choice |
| Is Manageable | choice |
| Is Pinned | choice |
| Product Weight | number |
| Delivery Method Required | boolean |
| Variations | array |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Business ID | text |
| Category ID | array |
| Name | text |
| Headline | text |
| Description | text |
| Currency | text |
| Price | number |
| Price display | text |
| Price stored | number |
| Tax ID | text |
| Is manageable | number |
| Is pinned | boolean |
| Status | text |
| Product weight | number |
| Delivery method required | boolean |
| Has variations | boolean |
| Is shopify | boolean |
| Product URL | url |
| Variations count | number |
10other output fields
Update an InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Invoice Date | date |
| Currency | choice |
| Payment Methods | array |
| Payment By | choice |
| Customer | object |
| Customer Name | text |
| Customer Email | |
| Customer Address | object |
| Customer ID | choice |
| Due Date | date |
| Auto Invoice Number | text |
| Invoice Number | text |
| Subtotal | number |
| Tax Setting | text |
| Send Email | number |
| Webhook | url |
| Reference | text |
| Footer | text |
| Allow Partial Payments | choice |
| Partial Payments | array |
| Stackable Discounts | array |
| Recipients | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
Templates
Look for HitPay templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Chargebee[2]Subscription billing for customers, plans, invoices, and payments.
- AdyenGlobal payment platform for online, in-person, and unified commerce transactions.
- BillduInvoice creation, billing, and payment management for small businesses.
- BillogramDigital invoicing and billing platform that sends invoices and collects payments from customers.
- BlueSnapGlobal payment gateway for accepting cards, local payment methods, and managing subscriptions.
References
- WEXTL® HitPay Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for HitPay.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:11