Log inStart free trial

HitPay Finance API: Watch Events, Create a Customer

Payment gateway for invoices, payment links, charges, and customer billing. 1 trigger, 9 searches, and 15 actions including Watch Events.

About this integration

Payment gateway for invoices, payment links, charges, and customer billing.

There are 1 trigger, 9 search modules and 15 actions available. The integration connects via basic authentication. Webhook-based triggers fire instantly without polling.

How to connect

The credential form asks for API Key and Environment.

Prefer the interactive builder form? Open it on the app page.

Paste your credentials once — WEXTL® stores them encrypted and reuses the connection across every workflow that needs it.

Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.

Connecting HitPay to WEXTL®

Connecting HitPay to WEXTL®

Field	Type	Help
API KeyRequired	password	—
EnvironmentRequired	select	—

Use it in workflow automation

Start with Watch Events, then add Create a Customer.

The canvas below runs Watch Events into Create a Customer — watch the video, then drop a node onto the canvas.

Select the Watch Events trigger and the workflow fires automatically when the event occurs — no polling required.

Then add Create a Customer as the next node. Branch, filter, or hand off to other integrations from there.

The integration includes 16 ready-made modules for finance work — each run logs its inputs and outputs for debugging.

HitPay workflow on the canvas: Watch Events then Create a Customer

HitPay workflow on the canvas: Watch Events then Create a Customer

Triggers, searches and actions

Open any HitPay trigger, search, or action to see its inputs and outputs — 1 trigger, 9 searchs, 15 actions.

Triggers

Use one of 1 trigger to kick off a workflow as soon as an event occurs in the app.

Watch Events

Searches

This integration includes 9 search modules for looking data up mid-run.

Get a Charge
Get a Customer
Get a Payment Request Status
Get a Product
List Customers

4more searches

Actions

Take action during a run with 15 available modules that write data back into the app.

Create a Customer
Create an Invoice
Create a Payment Request
Create a Product
Delete a Customer

10more actions

Explore the fields available for each HitPay trigger, search, and action.

Triggers

Output fields

Field	Type
ID	text
Business ID	text
Channel	text
Customer ID	text
Status	text
Customer	object
Name	text
Email	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

Searches

Input fields

Field	Type
Charge IDRequired	choice

Output fields

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
Email	email
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

Input fields

Field	Type
Customer IDRequired	choice

Output fields

Field	Type
ID	text
Name	text
Birth date	text
Gender	text
Email	email
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

Input fields

Field	Type
Payment Request IDRequired	text

Output fields

Field	Type
ID	text
Name	text
Email	email
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

Input fields

Field	Type
Product IDRequired	choice

Output fields

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

Input fields

Field	Type
Limit	number

Output fields

Field	Type
ID	text
Name	text
Birth date	text
Gender	text
Email	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

Input fields

Field	Type
Customer Email	email
Invoice Status	choice
Reference	text
Limit	number

Output fields

Field	Type
ID	text

Input fields

Field	Type
Limit	number

Input fields

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

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
Email	email
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

Input fields

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

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

Actions

Input fields

Field	Type
EmailRequired	email
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

Field	Type
ID	text
Name	text
Birth date	text
Gender	text
Email	email
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

Input fields

Field	Type
Invoice DateRequired	date
CurrencyRequired	choice
Payment Methods	array
Payment ByRequired	choice
Customer	object
Customer Name	text
Customer Email	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

Field	Type
ID	text

Input fields

Field	Type
AmountRequired	number
CurrencyRequired	choice
Payment Methods	array
Email	email
Purpose	text
Buyer’s Name	text
Reference Number	text
Redirect URL	url
Webhook URL	url
Allow Repeated Payments	boolean
Expiry Date	date

Output fields

Field	Type
ID	text
Name	text
Email	email
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

Input fields

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

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

Input fields

Field	Type
Customer IDRequired	choice

Input fields

Field	Type
Invoice IDRequired	choice

Input fields

Field	Type
Payment Request IDRequired	text

Input fields

Field	Type
Product IDRequired	choice

Input fields

Field	Type
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields

Field	Type
Body	text
Headers	object
Status code	number

Input fields

Field	Type
Charge IDRequired	choice
Terminal IDRequired	choice

Output fields

Field	Type
Data	text

Input fields

Field	Type
AmountRequired	number
Payment IDRequired	text
Webhook URL	url
Send Email	choice
Email	email

Output fields

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

Input fields

Field	Type
Customer IDRequired	choice
Email	email
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

Field	Type
ID	text
Name	text
Birth date	text
Gender	text
Email	email
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

Input fields

Field	Type
Invoice IDRequired	choice
Invoice Date	date
Currency	choice
Payment Methods	array
Payment By	choice
Customer	object
Customer Name	text
Customer Email	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

Field	Type
ID	text

Input fields

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
Email	email
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

Input fields

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

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