iPOS Transact

The iPOS Transact API empowers merchants to streamline their payment processes by enabling void, full or partial refunds, and sale transactions using card tokens directly from their own CRM or billing software. With this API, merchants can bypass the need to log in to the iPOSpays portal for many transaction types, improving efficiency and integration with third-party applications.

However, the API is not a replacement for a Hosted Payment Page (HPP) or Freedom to Design (FTD) solutions. While void and refund transactions can be executed directly, sale transactions require a card token. These tokens can only be generated through Hosted Payment Pages or SPIn (Semi-integrated Payments).

For example, a merchant running a gym membership program can use the Hosted Payment Page to collect the first payment via a payment link. Upon successful payment, the card token is returned as part of the response. The merchant can store this token in their system and later use the iPOS Transact API to charge the customer for recurring payments without further intervention.

It is also worth noting that the Hosted Payment Page and WooCommerce plugin utilize the iPOS Transact API as their underlying payment mechanism.

Use Cases

Here are some scenarios where the iPOS Transact API can provide significant value to merchants:

1. Void or Refund Transactions in Semi-Integrated Payments

Merchants using semi-integrated setups (e.g., cash registers paired with POS terminals) can perform void or refund transactions directly from their system without requiring the card used in the original transaction.

2. Integration for Membership-Based Services

Merchants managing membership-based services (e.g., gyms) can integrate the Hosted Payment Page to collect the initial payment and save the card token. The iPOS Transact API can then be used for future charges, voids, or refunds without requiring manual intervention.

3. Simplified Payment Operations

The API enables merchants to streamline operations by integrating payment functionality directly into their existing software solutions, reducing the need for multiple tools or platforms.

Version History

Prerequisites

• For Sandbox (UAT)

Users should be Onboarded on iPOSpays sandbox(UAT) environment as a merchant and have a valid TPN.

• For Production (Live)

Users should be onboarded on iPOSpays production environment as a merchant and have a valid TPN.

Supported Transaction Types

The iPOS Transact API allows you to perform the following transactions:

• Sale - A sale transaction is a regular transaction where the entered amount is processed and sent to the processor after the batch has been settled.

• Pre Auth - A Pre Auth transaction allows the user to temporarily reserve a specific amount of money for a transaction.

• Zero Dollar Pre Auth: If you want to obtain a card token without processing a transaction, submit a Zero Dollar Pre-Authorization request. Use the same request parameters as a standard Pre-Authorization transaction, but set the transaction amount to 0.00. This allows the card to be validated and tokenized without charging the customer.

• Void - A Void transaction is used to cancel a previously authorized transaction before the batch is closed and sent to the processor.

• Refund - A Refund transaction is used to refund the amount back to the customer after the batch has been settled. The refund amount is then sent to the processor.

• Ticket - A Ticket transaction is used to retrieve and process the amount that was temporarily held in the Pre Auth transaction.

• Tip Adjust - Tip Adjust enables users to modify the tip amount on a transaction before the batch is settled and sent to the processor.

• Zero Dollar Tip Adjust: Use a Zero Dollar Tip Adjust to remove a previously adjusted tip amount. For example, if a $2 tip was added using Tip Adjust, submitting a Zero Dollar Tip Adjust will remove the$2 tip and restore the transaction to its original amount.

• Incremental Auth - Incremental Authorization allows merchants to easily adjust a Pre Auth transaction when a customer exceeds the initial amount, without having to void and reprocess the transaction.

• Open Batch - An Open Batch allows merchants to view all transactions, review the batch summary, and void transactions before they are settled and sent to the processor.

• Batch Settlement - Batch settlement is the process of consolidating and submitting all authorized transactions at the end of the business day to the payment processor. This ensures timely reconciliation and transfer of funds to the merchant’s bank account.

• Gift - A Gift Transaction refers to a transaction where a customer uses a gift card balance as a payment method to complete a purchase.

• Level 3 / VISA CEDP (Sale): - A Level 3 / VISA CEDP sale transaction enables you to include detailed line-item information in the sale requests. By providing this enhanced transaction data, you can qualify for better interchange rates offered by the card networks.

---

Supported Fee Types

The iPOS Transact API supports the following fee types:

• Custom Fee

• Surcharge

• Tender-Based Pricing

• Dual Pricing

• True Cash Discount

Error Codes and Their Meaning

For a complete list of error codes and their explanations, please visit our Error Codes Reference Page.