HitPay connector for AI agents

Tools your payments agent reaches for on HitPay, scoped per user.

CALL ANY TOOL

39 tools for payments in HitPay: create payment requests and invoices, run recurring billing and subscription plans, refund charges, charge saved cards, manage customers and orders, and look up products.

hitpay_charge_saved_card

Charge saved card

Charge the card or payment method saved on a recurring billing record for a given amount. Returns the payment id, recurring billing id, amount, currency, and status. Use this for on-demand charges against a saved payment method. The record must have been created with save_card enabled.

Parameters

Name

Type

Required

Description

amount

integer

Required

Amount to bill, as a whole number, in the plan or record currency. Maximum 999999.99. Example: 25.

currency

string

Required

The currency. Example: SGD.

recurring_billing_id

string

Required

ID of the recurring billing record. Get it from list_recurring_billings or create_recurring_billing.

hitpay_create_customer

Create customer

hitpay_create_invoice

Create invoice

Create an invoice for a customer, optionally with products, discounts, and partial payments. Returns the created invoice (the vendor reference documents no response body for this call). Use this to bill a customer for products or a fixed amount. Use create_payment_request for a one-off payment link.

Parameters

Name

Type

Required

Description

currency

string

Required

Three-letter currency code for the invoice. Example: SGD.

invoice_date

string

Required

Date the invoice is issued, in YYYY-MM-DD format. Example: 2026-01-15.

payment_by

string

Required

Whether the invoice is billed by product (send products) or by amount (send amount and subtotal). Example: product.

allow_partial_payments

string

Optional

Set to 1 to let the customer pay the invoice in instalments (also set partial_payments), or 0 for a single payment. Example: 0.

amount

number

Optional

Invoice total amount in the invoice currency. Only needed when payment_by is amount. Example: 90.00.

auto_invoice_number

string

Optional

Set to true to have HitPay assign the invoice number automatically instead of sending invoice_number. Example: true.

customer

object

Optional

New customer details for the invoice as an object with name, email, and an optional address. Use customer_id instead for a saved customer. Example: {"name": "Jane Tan", "email": "jane@example.com"}.

customer_id

string

Optional

ID of a saved customer to bill. Get it from list_customers. Use customer instead to enter new customer details. Example: 9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d.

due_date

string

Optional

Date the invoice is due, in YYYY-MM-DD format. Example: 2026-02-15.

footer

string

Optional

Text shown at the bottom of the invoice. Example: Thank you for your business.

invoice_number

string

Optional

Your own invoice number. Leave empty when auto_invoice_number is set. Example: INV-0001.

partial_payments

array

Optional

Instalment schedule as an array of objects, each with an amount and a due_date. Use with allow_partial_payments. Example: [{"amount": 50, "due_date": "2026-02-01"}, {"amount": 50, "due_date": "2026-03-01"}].

payment_methods

array

Optional

Payment methods the customer may use, as an array of method codes available on your HitPay account and currency. Example: ["card", "paynow_online"].

products

array

Optional

Line items as an array of objects, each with a product_id and optional quantity, variation_id, and discount. Get product ids from list_products. Example: [{"product_id": "9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "quantity": "2"}].

recipients

array

Optional

People who receive the invoice, as an array of objects with an email or a customer_id. Example: [{"email": "jane@example.com"}].

reference

string

Optional

Your own reference for the invoice, used to match it to your internal systems. Example: ORDER-1001.

send_email

integer

Optional

Set to 1 to have HitPay email receipts to the customer, or 0 for no email. HitPay defaults to 0. Example: 1.

stackable_discounts

array

Optional

Discounts applied in sequence, as an array of objects, each with a name, a discount amount, a percentage_discount, and an order. Example: [{"name": "Early bird", "discount": "5", "percentage_discount": "0", "order": "1"}].

subtotal

number

Optional

Subtotal before discounts and tax. Needed when payment_by is amount. Example: 90.00.

tax_setting

string

Optional

ID of the tax to apply to the invoice, taken from the tax settings in the HitPay dashboard. Example: 9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d.

webhook

string

Optional

URL HitPay calls with a POST when the invoice is paid. Example: https://yourshop.example.com/hitpay/webhook.

hitpay_create_order

Create order

hitpay_create_recurring_billing

Create recurring billing

Create a recurring billing subscription for a customer, from a plan or with custom amount and cycle. Returns the created recurring billing record (the vendor reference documents no response body for this call). Use this to subscribe a customer. Use create_subscription_plan first to define a reusable plan.

Parameters

Name

Type

Required

Description

customer_email

string

Required

Customer's email. Example: jane@example.com.

amount

integer

Optional

Amount to bill, as a whole number, in the plan or record currency. Maximum 999999.99. Example: 25.

customer_name

string

Optional

Customer's name. Example: Jane Tan.

cycle

string

Optional

Billing frequency: weekly, monthly, yearly, or custom. Required when plan_id is empty; otherwise the plan cycle is used. Example: monthly. One of: `weekly`, `monthly`, `yearly`, `custom`.

cycle_frequency

string

Optional

It is required field when the cycle is custom. For cycle = custom, set the frequency for cycle repeat field options [day, week, month, year]. One of: `day`, `week`, `month`, `year`.

cycle_repeat

integer

Optional

It is required field when cycle is custom. New cycle will only be affective at the end of the current cycle.

name

string

Optional

Name of the subscription. Required when save_card is true or plan_id is empty; otherwise the plan name is used. Example: Premium membership.

payment_methods

array

Optional

Payment methods allowed for the subscription, as an array containing card, giro, or shopee_recurring. Example: ["card"].

plan_id

string

Optional

Subscription plan id created from Create a Subscription Plan API. If you would like to create a subscription without a plan, plan_id should be null. Example: 9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d.

redirect_url

string

Optional

URL where HitPay redirects the user after the users enters the card details and the subscription is active. Query arguments reference (subscription id) and status are sent along. Example: https://yourshop.example.com/order/123/complete.

reference

string

Optional

Your own reference for this record, used to match it to your internal systems. Example: ORDER-1001.

save_card

string

Optional

Only set the value “true” if you wish to save the card and charge the customer later on. More details in “Save Card” section. One of: `true`, `false`.

save_payment_method

string

Optional

It's new field that will replace save_card field in the future. Only set the value “true” if you wish to save the payment method and charge the customer later on. More details in “Save Payment Method” section. One of: `true`, `false`.

send_email

string

Optional

HitPay to send email receipts to the customer. Default value is false. One of: `true`, `false`.

start_date

string

Optional

Required when save_card is not true. Billing start date (YYYY-MM-DD) in SGT. Must be today or a future date. Example: 2026-02-01.

start_date_method

string

Optional

It's an optional field and only applicable when save_payment_method is true. By default, the start_date_method is null. Options are sign_up_date or no_initial_charge. One of: `sign_up_date`, `no_initial_charge`.

times_to_be_charged

number

Optional

It's time to be charged. Default value is 1.

hitpay_create_refund

Refund create

hitpay_delete_customer

Delete customer

hitpay_delete_invoice

Delete invoice

hitpay_delete_order

Delete order

hitpay_delete_product

Delete product

hitpay_delete_recurring_billing

Delete recurring billing

hitpay_get_business_info

Get business info

hitpay_get_charge

Get charge

hitpay_get_customer

Get customer

hitpay_get_order

Get order

hitpay_get_product

Get product

hitpay_get_recurring_billing

Get recurring billing

hitpay_get_refund

Refund get

hitpay_list_charges

List charges

hitpay_list_customers

List customers

hitpay_list_invoices

List invoices

hitpay_list_orders

List orders

hitpay_list_product_categories

List product categories

hitpay_list_products

List products

hitpay_list_recurring_billings

List recurring billings

hitpay_update_customer

Update customer

hitpay_update_invoice

Update invoice

Replace the details of an existing invoice. Returns the updated invoice (the vendor reference documents no response body for this call). Use this to fix an invoice before it is paid. Use create_invoice for a new one.

Parameters

Name

Type

Required

Description

currency

string

Required

Three-letter currency code for the invoice. Example: SGD.

invoice_date

string

Required

Date the invoice is issued, in YYYY-MM-DD format. Example: 2026-01-15.

invoice_id

string

Required

ID of the invoice. Get it from list_invoices.

payment_by

string

Required

Whether the invoice is billed by product (send products) or by amount (send amount and subtotal). Example: product.

allow_partial_payments

string

Optional

Set to 1 to let the customer pay the invoice in instalments (also set partial_payments), or 0 for a single payment. Example: 0.

amount

number

Optional

Invoice total amount in the invoice currency. Only needed when payment_by is amount. Example: 90.00.

auto_invoice_number

string

Optional

Set to true to have HitPay assign the invoice number automatically instead of sending invoice_number. Example: true.

customer

object

Optional

New customer details for the invoice as an object with name, email, and an optional address. Use customer_id instead for a saved customer. Example: {"name": "Jane Tan", "email": "jane@example.com"}.

customer_id

string

Optional

ID of a saved customer to bill. Get it from list_customers. Use customer instead to enter new customer details. Example: 9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d.

due_date

string

Optional

Date the invoice is due, in YYYY-MM-DD format. Example: 2026-02-15.

footer

string

Optional

Text shown at the bottom of the invoice. Example: Thank you for your business.

invoice_number

string

Optional

Your own invoice number. Leave empty when auto_invoice_number is set. Example: INV-0001.

partial_payments

array

Optional

payment_methods

array

Optional

Payment methods the customer may use, as an array of method codes available on your HitPay account and currency. Example: ["card", "paynow_online"].

products

array

Optional

recipients

array

Optional

People who receive the invoice, as an array of objects with an email or a customer_id. Example: [{"email": "jane@example.com"}].

reference

string

Optional

Your own reference for the invoice, used to match it to your internal systems. Example: ORDER-1001.

send_email

integer

Optional

Set to 1 to have HitPay email receipts to the customer, or 0 for no email. HitPay defaults to 0. Example: 1.

stackable_discounts

array

Optional

subtotal

number

Optional

Subtotal before discounts and tax. Needed when payment_by is amount. Example: 90.00.

tax_setting

string

Optional

ID of the tax to apply to the invoice, taken from the tax settings in the HitPay dashboard. Example: 9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d.

webhook

string

Optional

URL HitPay calls with a POST when the invoice is paid. Example: https://yourshop.example.com/hitpay/webhook.

hitpay_update_order

Update order

hitpay_update_payment_request

Update payment request

Update an existing payment request that has not been paid yet. Returns the updated payment request. Use this to change the amount, buyer details, expiry, or payment methods. Use create_payment_request for a new request.

Parameters

Name

Type

Required

Description

currency

string

Required

Currency related to the payment. Example: SGD.

request_id

string

Required

ID of the payment request. Get it from create_payment_request or list_payment_requests.

add_admin_fee

string

Optional

If set to true, the admin fee will be included in total. One of: `true`, `false`.

address

object

Optional

Postal address as an object. Example: {"line1": "1 Raffles Place", "city": "Singapore", "state": "Singapore", "country": "SG", "postal_code": "048616"}. Required keys inside the object are line1, city, state, country, and postal_code for payment requests; customers use street, city, state, and postal_code.

allow_repeated_payments

string

Optional

If set to true, multiple payments can be paid on a payment request link. Default value is false. One of: `true`, `false`.

amount

number

Optional

It's required field. Amount related to the payment.

string

Optional

Buyer’s email. Example: jane@example.com.

expires_after

string

Optional

E.g "30 mins" Other supported keys are "mins", "hours", "days". Example: 30 mins.

expiry_date

string

Optional

Time after which the payment link will be expired(time in SG with YYYY-MM-DD HH:mm:ss format). Applicable for repeated payments. Default is Null. Example: 2026-12-31 23:59:59.

generate_qr

boolean

Optional

Only valid for payment methods: paynow_online, qrph_netbank, doku_qris and shopee_pay if generate_qr was true.

name

string

Optional

Buyer’s name. Example: Jane Tan.

payment_methods

array

Optional

Payment method type (paynow_online , card, wechat, alipay, grabpay_direct, grabpay_paylater, shopee_pay, zip, fpx). If we don't pass, use the available methods.

phone

string

Optional

Buyer’s phone number. Example: +6591234567.

purpose

string

Optional

Purpose of the Payment request. Example: Order 123.

redirect_url

string

Optional

URL where we redirect the user after a payment. Query arguments reference (payment request id) and status are sent along. Example: https://yourshop.example.com/order/123/complete.

reference_number

string

Optional

Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer. Example: ORDER-1001.

send_email

string

Optional

It's "true" or "false". If set to true, an email receipt will be sent to the customer after the payment is completed. Default is false. One of: `true`, `false`.

send_sms

string

Optional

It's "true" or "false". If set to "true", SMS will be sent to the customer after the payment is completed. Default is false. One of: `true`, `false`.

staff_id

string

Optional

It's active staff id from the dashboard. Example: 9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d.

webhook

string

Optional

URL where our server do POST request after a payment If done. Example: https://yourshop.example.com/hitpay/webhook.

hitpay_update_recurring_billing

Update recurring billing

Update a recurring billing subscription's plan, amount, cycle, or customer details. Returns the updated recurring billing record. Use this to change a subscription. Use delete_recurring_billing to cancel it.

Parameters

Name

Type

Required

Description

recurring_billing_id

string

Required

ID of the recurring billing record. Get it from list_recurring_billings or create_recurring_billing.

amount

number

Optional

New amount to bill each cycle in the record currency. Example: 25.

customer_email

string

Optional

Customer's email. Example: jane@example.com.

customer_name

string

Optional

Customer's name. Example: Jane Tan.

cycle

string

Optional

Billing frequency (weekly / monthly / yearly / custom). One of: `weekly`, `monthly`, `yearly`, `custom`.

cycle_frequency

string

Optional

It is required field when the cycle is custom. For cycle = custom, set the frequency for cycle repeat field options [day, week, month, year]. One of: `day`, `week`, `month`, `year`.

cycle_repeat

integer

Optional

It is required field when cycle is custom. New cycle will only be affective at the end of the current cycle.

description

string

Optional

The description of subscription plan. Example: Monthly premium membership.

name

string

Optional

Plan name. Example: Premium membership.

payment_methods

array

Optional

Payment methods allowed for the subscription, as an array containing card, giro, or shopee_recurring. Example: ["card"].

plan_id

string

Optional

The plan ID, if plan_id is not null it will update [cycle, cycle_repeat, cycle_frequency and amount] with the values from Subscription plan. if plan_id is null you can update each field individually. When save_card is true, you disallow to set plan_id. Example: 9a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d.

redirect_url

string

Optional

reference

string

Optional

Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer. Example: ORDER-1001.

save_card

string

Optional

Only set the value “true” if you wish to save the card and charge the customer later on. More details in “Save Card” section. One of: `true`, `false`.

save_payment_method

string

Optional

send_email

string

Optional

Whether HitPay emails the customer about this subscription. Use true or false. Example: true. One of: `true`, `false`.

start_date

string

Optional

The start date must be a date after or equal to today and Billing start date (YYYY-MM-DD) in SGT, only possible to change start date for recurring billing ID with status = scheduled or active. Example: 2026-02-01.

start_date_method

string

Optional

For more tools, view docs.

Build your Agent

Same auth pattern across LangChain, OpenAI, Anthropic, and Google ADK.

import { ScalekitClient } from "@scalekit-sdk/node";
import { createReactAgent } from "@langchain/langgraph/prebuilt";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);

// HitPay tools scoped to this user
const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["hitpay"], toolNames: [
    "hitpay_create_payment_request",
    "hitpay_list_charges",
    "hitpay_create_refund"] },
  pageSize: 100,
});

const agent = createReactAgent({ llm, tools });
await agent.invoke({ messages: [{ role: "user", content: "Create a SGD 250 payment link for the workshop and list this week's charges" }] });

import OpenAI from "openai";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);
const openai = new OpenAI();

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["hitpay"] }, pageSize: 100,
});

const res = await openai.chat.completions.create({
  model: "gpt-5",
  messages: [{ role: "user", content: "Create a SGD 250 payment link for the workshop and list this week's charges" }],
  tools,
});

// Execute the tool call with the user's vaulted HitPay OAuth token
await sk.tools.executeTool(res.choices[0].message.tool_calls[0], "user_123");

import Anthropic from "@anthropic-ai/sdk";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);
const anthropic = new Anthropic();

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["hitpay"] }, pageSize: 100,
});

const msg = await anthropic.messages.create({
  model: "claude-sonnet-5",
  max_tokens: 1024,
  messages: [{ role: "user", content: "Create a SGD 250 payment link for the workshop and list this week's charges" }],
  tools,
});

// Tool call runs with the user's vaulted HitPay OAuth token
await sk.tools.executeTool(msg.content, "user_123");

import { Agent } from "@google/adk/agents";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["hitpay"] }, pageSize: 100,
});

const agent = new Agent({
  name: "payments_agent",
  model: "gemini-2.5-pro",
  instruction: "HitPay tools scoped to this user",
  tools,
});

await agent.run("Create a SGD 250 payment link for the workshop and list this week's charges");

Try these prompts

Copy any prompt into your agent. Each maps directly to a HitPay tool. Click to copy, paste into your agent, done.

Payments

Copy the prompt

Copied

Create a SGD 250 payment request for the workshop and give me the checkout link.

Copy the prompt

Copied

List failed charges from yesterday.

Copy the prompt

Copied

Refund SGD 40 of this charge.

Invoices and customers

Copy the prompt

Copied

Create an invoice for Mei Lin for 2 coaching sessions.

Copy the prompt

Copied

List unpaid invoices for jordan@example.com.

Copy the prompt

Copied

Add Tan and Co as a customer with their billing email.

Subscriptions

Copy the prompt

Copied

Create a monthly plan called Pro at SGD 49.

Copy the prompt

Copied

List recurring billings for the Pro plan.

Copy the prompt

Copied

Move Mei Lin's subscription to the annual cycle.

SEE HOW AUTH WORKS

Each user signs in to HitPay once, and Scalekit stores and refreshes their tokens. Credentials stay vaulted, every call is scope checked, and every action is logged.

Authorize

Your user connects

HitPay

once. We tie it to their identity and the meetings they approved — no shared bot account, no org-wide access

Who:

user ‘A’

when:

Once per user

access:

Limited to user

Store

Their

HitPay

token lives in a vault scoped to them. User A's meetings are never reachable by an agent acting for user B, even on the same connection

vault:

encrypted

scope:

per-user

tokens:

auto-refreshed

Resolve

When your agent calls a

HitPay

tool, we fetch the right token server-side. It never touches your agent, never appears in the LLM context, never shows up in your logs

speed:

~40ms

check:

before every call

seen by:

nobody

Audit

Every

HitPay

tool call is logged — who triggered it, which meeting was fetched, what came back. 90 days of history, tied to the user who authorized it

history:

90 days

export:

SIEM-ready

logged:

every call

Test other agents

See the same per-user auth pattern across other accounting and finance connectors.

GTM and RevOps Teams

Revenue forecast commentary

Pulls open pipeline from Salesforce and HubSpot, calculates coverage against quota, flags at-risk stages, posts commentary to Slack, and logs every snapshot to Google Sheets.

GTM and RevOps Teams

CRM AI agent

Reads the Granola transcript after every call, extracts next steps and updates the HubSpot record, drafts the follow-up in Gmail, and confirms in Slack, all on the rep's own delegated OAuth.

Why Scalekit

Secure your agent's access. Connectors ship in minutes

01.

Shared tokens break per-user analytics

A shared HitPay token looks fine in a demo. In production every refund and payment request looks like one service account, and you cannot tell which user triggered it. Scalekit resolves the credential of the actual user who triggered the agent, never a shared bot.

// shared token
audit → bot_service_account

// scalekit
audit → user_abc ✓

02.

Authentication is not authorization

03.

Multi-tenancy is architectural

04.

HitPay today. Ten connectors tomorrow.

“Our agents act across Salesforce, Gong, Google Drive, and more, on behalf of every customer. Scalekit behind the scenes meant we can keep adding tools without ever rebuilding how credentials or tool calling work.”

Venu Madhav Kattagoni

Head of Engineering / Von

FAQs

Frequently Asked Questions

Does the agent access HitPay as the user or through a shared service account?

As the user. Each user signs in to HitPay once, and Scalekit stores and refreshes their tokens. Payment requests, refunds, and subscription changes the agent makes are attributed to that user in your audit trail, not a shared service account.

Where is the HitPay OAuth token stored?

In Scalekit's managed AES-256 token vault, namespaced per tenant. Refresh is automatic. Revocation is a single dashboard action. Credentials never appear in prompts, logs, or LLM context.

Can I limit what the agent does in HitPay?

Yes. Filter by tool name in listScopedTools to expose only what you want, for example the list and get tools without hitpay_create_refund or hitpay_charge_saved_card, which move money, or hitpay_delete_recurring_billing, which cancels a subscription. Scalekit also enforces scope checks before every API call.

What happens when a user revokes HitPay access?

The connection is invalidated on the next tool call. Subsequent requests for that user fail closed with a clear error. Other users in the tenant remain unaffected. The event is logged for audit.

Which HitPay business does the agent act on?

The business the signed-in HitPay account belongs to. hitpay_get_business_info returns that business's profile, and the charge, invoice, order, and subscription tools act on its data.