Product Guide

API Documentation

Dashboard

Support

Get Orders

Explore the capabilities of HitPay through our user-friendly documentation. For developers, our comprehensive API documentation provides clear guidance and code samples for easy integration.

Introduction

Account Setup

In this section we will explore the Business Verification Form, elaborate on Myinfo Verification for Singapore users, and detail the various verification statuses you might encounter.

Business Verification

A quick guide to the HitPay Web Dashboard for efficient back office management, including payments, sales, and e-commerce.

Web Dashboard

The User Management feature in HitPay allows you to efficiently control access and permissions for your team members within your HitPay account. This provides you with the tools to seamlessly invite new users, designate their roles, and customize their interactions with the system.

User Management (Staff)

HitPay's versatile payment solutions empower your customers to make secure and convenient payments. Whether it's on your Customer Portals or eCommerce platform, our integrated payment providers enable seamless transactions for sales orders, invoices, and recurring subscriptions.

By embedding multiple payment methods into your checkout process, you enhance the flexibility for your customers to pay using their preferred payment options. This not only improves user satisfaction but also increases the likelihood of conversions and  timely payments, benefiting both your customers and your business

Online Payments

Fully customise your online checkout experience

Checkout Customisation

Admin Fees

Guidelines for processing refunds and chargebacks with Hitpay

Refunds and Chargebacks

Guide to understanding payout cycles and methods with HitPay

Overview

Overview and usage guide for the HitPay Balance

HitPay Balance

Learn how you can change your Payout Schedule for HitPay Payouts

Payout Settings

Learn how you can top up your HitPay & Cards Balance

Balance Top Up

Guide to add or update bank account for payouts

Bank Account

Download App

The HitPay app offers a versatile range of features to streamline your payment and business management needs.

The HitPay app offers a versatile range of payment methods, including credit cards, mobile wallets, and contactless payments ensuring flexibility and convenience for your customers. Let customers pay with their preferred payment methods

Payment Methods

Learn how to efficiently checkout & process payments on the HitPay app. Explore detailed steps for a seamless payment experience.

Checkout

Explore the different aspects of managing products and categories on HitPay's Point of Sale system.

Products & Categories

Learn more about the Transaction History and Reports for Your POS App

Transactions & Reports

Learn how to manage and use multiple locations for your Point of Sale.

Locations

Surcharge

Discounts

Taxes

Tips

Guide for implementing deep linking in HitPay

Deep Linking

HitPay payment gateway integrates with various e-commerce platforms, allowing you to easily accept low-cost and alternative payment methods on your existing store

Integrate hitpay payments app into your Shopify store

Shopify

Integrate HitPay payment gateway into your WooCommerce store

WooCommerce

Integrate HitPay payment gateway into your Wix store

Integrate HitPay payment gateway into your Xero Invoices

Xero Invoices Payment

Integrate HitPay payment gateway into your PrestaShop store

PrestaShop

Integrate HitPay payment gateway into your Magento store

Magento

Integrate HitPay payment gateway into your OpenCart store

OpenCart

Integrate HitPay payment gateway into your Ecwid store

Ecwid

Integrate HitPay payment gateway into your EasyStore site

EasyStore

Integrate HitPay payment gateway into your Shopcada store

Shopcada

Integrate HitPay payment gateway into your Google Forms

Google Forms

Integrate HitPay payment gateway into your WHMCS store

WHMCS

Integrate HitPay payment gateway into your Odoo Store

Odoo

Integrate the HitPay payment gateway into your GiveWP forms

GiveWP

Collect payments, hold and manage cashflows and send payments using HitPay B2B Payments

Learn how to how to collect multi-currency payments using bank transfers

Collection

Learn how to send payments to suppliers, contractors, and other business vendors using HitPay

Send Payments

Creating and Setting Up an Online Store In HitPay

Setup Online Store

Orders

Products

Managing product categories in your online store

Discounts & Coupons

Customizing the design of your online store

Store Design

Connect your own domain name to the HitPay Online Store

Custom Domain

Configuring Shipping and Pickup Settings for Your Online Store

Shipping and Pickup

Integrating Google Analytics and Meta Pixel

Analytics

SEO Settings

Tax Settings

Customizing the Order Confirmation Page for your Online Store

Order Form Customization

Invoicing

Repeating Invoices

Payment Links

Payment Reports

Plans

Creating and Managing Recurring Billing Subscriptions

Subscriptions

Automate your workflow and streamline payments and Order processes using Zapier

Zapier

Sync your payments data into your xero account

Xero Sync

Sync your payments data into your Quickbooks account

Quickbooks Sync

Connect your Shopify POS app to HitPay Wifi Card Reader

Shopify POS Connector

Stay informed about your transactions by configuring notification settings in HitPay

Notifications

Getting Started

Integrate the payment request APIs in 3 simple steps

Comprehensive guide on integrating and using Embedded QR Code payments through HitPay API.

Embedded QR Codes

Accept in-person card payments using the [wifi card reader](https://hitpayapp.com/terminal)

In Person Payments

Listen to key events in HitPay including payments, orders and more

Event Webhooks

Integrate the recurring billing APIs to automated your subscription payments

Recurring Billing

API to save the card details securely for billing

Save Card for Billing

Integrate HitPay into your platform with sub accounts

Platform APIs

Guide to using the APIs to payout to any of your beneficiaries

Payout APIs Overview

List of payout networks and rails supported by HitPay's payout APIs

Payout Network

This endpoint creates a new payment request. This is the first step of the payment flow, once you have all the details from the user and are ready to collect payment use this API to create a payment request.
Since this is a server-to-server communication, if you have a mobile or Web client that communicates with your REST API, you must have a new endpoint E.g. /create-order, or reuse an existing endpoint. This endpoint will be responsible for making the payment request API call to hitpay.

Create Payment Request

This is an optional API call, you may use this to get the status of a specific payment request.

Get Payment Status

Refund

This is an optional API call, you may use this to delete a specific payment request.

Delete Payment Request

A subscription plan consists of basic information like plan name, amount, and frequency. An example of a subscription plan could be “Spotify Premium Membership” which is SGD 9.90 monthly.

Create a Subscription Plan

Use this API to update the subscription plan, changes made to the plan will not affect current subscription. If you would like to make changes to the current subscriptions use the Update Recurring Billing API.

Update Subscription Plan

Use this API to get the subscription plan details, if you need to make any changes use the Update a Subscription Plan API

Get Subscription Plan Details

Use this API to get all subscription plans details.

Get All Subscription Plan

Delete Subscription Plan

Once your customer has decided to start the subscription this endpoint will create the recurring billing request.
Since this is a server-to-server communication, if you have a mobile or Web client that communicates with your REST API, you must have a new endpoint E.g. /create-subscription or reuse an existing endpoint. This endpoint will be responsible for making the recurring billing API call to hitpay.

Create Recurring Billing

Use this API to update the recurring billing, any changes made to the cycle will only be effective at the end of the current cycle.

Update recurring billing

Use this API to get the a list of all recurring billings

Get All Recurring Billing

Use this API to cancel the recurring billing subscription

Delete Recurring Billing

Once the card is saved you can charged the card anytime using the charge API

Charge the saved card

Use this API to get the detail of recurring billing with a saved card. If the card is saved the response will have the card details (The last 4 digits and card brand). You can use the card details to display it to the users so they are aware of which card is saved and give them the option to change the card by navigating to the “url”

Get saved card details

Get Charges

Get Account Status

Create Order with the given data. The order will be created with a `draft` status.

Create Order

Get Order Details

Update the order

Delete Order

This endpoint allows you to retrieve all products. You can also filter the products by name, category, and status.

Get All Products

This endpoint allows you to create a product.

Create a Product

This endpoint allows you to get a product.

Get a Product

This endpoint allows you to update a product.

Update a Product

This endpoint allows you to delete a product.

Delete a Product

This endpoint allows you to retrieve all customers

Get All Customers

This endpoint allows you to create a customer. The customer will be created with the provided details and will be returned in the response.

Create a customer

A customer is a person or a company that is registered with HitPay. This endpoint allows you to retrieve a customer's details.

Get Customer Detail

This endpoint allows you to update a customer's details.

Update Customer

This endpoint allows you to delete a customer.

Delete Customer

Create the invoice

Update the invoice

Delete Invoice

Get all invoice

This endpoint allows you to get a webhook event's details. You can use the `webhook_event_id` to get the webhook event's details.

Get Webhook Event Detail

This endpoint allows you to create a webhook event. The webhook event will listen to the event types that you specify and send a POST request to the URL that you specify.

Create a Webhook Event

This endpoint allows you to update a webhook event. You can use the `webhook_event_id` to update the webhook event's details.

Guides

API References

Get Orders

Headers

Query Parameters

Response