Set up Pin Payments

Edited

In this guide, you will learn how to set up Pin Payments integration in HirePOS for seamless card payment processing and related features in Australia and New Zealand.

Create a Pin Payments Account

To get started, create a Pin Payments account by visiting https://pinpayments.com/get-started/hirepos.

After your account is created, you'll need to fill in your business and bank details.
Then, you will need to wait 3-5 Business days for Pin-Payments to run a check on your Business to make sure it is legitimate.

Once Pin-Payments has approved your business for live transactions, you can move to the next step.

Log into Pin Payments Portal

Log into your Pin Payments portal at https://dashboard.pin.net.au/login to obtain your API keys and configure your Bank Details and Business Details.

  1. Click on the Account menu option at the bottom left of the portal.

  2. Choose the API Keys menu option.

  3. Copy the Secret and Publishable.

Copy API Keys to HirePOS

Follow these steps to copy your API keys from Pin Payments to HirePOS:

  1. In HirePOS, navigate to Setup > Preferences > Accounting Integration & Other APIs and select Pin Payments.

  2. Copy the Secret key and Paste it into the API Secret field in HirePOS.

  3. Copy the Publishable key and Paste it into the API Publishable field in HirePOS.

  4. Click Save Changes in HirePOS.

Set Up a Pin Payments Bank Account

Record all payments against an account in HirePOS. Create a new bank account named Pin Payments under Setup > Bank Accounts and link it in Preferences > Accounting Integration & Other APIs > Pin Payments.

Card Surcharging

Card surcharging is a feature that allows for extra charges on sales/hire records when customers opt to pay by card. This feature is applicable for emailing sales records, in-person payments, and online store transactions. It is important to note that surcharges do not apply to invoices that are exported to external accounting systems.

When setting up a Card Surcharge item, ensure that the following requirements are met:

  • Must be a Non-Stock item

  • Must have a Non-time based Selling Unit (i.e. an 'Each' unit)

  • Must not be a percentage charge item

Create a Card Surcharge Item

To create a Card Surcharge item, follow these steps:

  1. Navigate to Setup > Items

  2. Click on New Item

  3. Provide a Description and set the Item Type to Misc

  4. Enable Non-Stock in the Configuration pane

  5. Set the unit, set 0.00 as either the Sell Ex or Sell Inc value and save changes

Enable Pin Payment Surcharging

To activate surcharging via the Pin Payments API, follow these steps:

  1. Navigate to Setup > Preferences > Accounting Integration & Other API's > Pin Payments

  2. Check the Enable Surcharging box

  3. Select the Card Surcharge item as the Surcharge % Item

  4. Enter Surcharge (%) and/or Fee ($) values

When using Branches and separate Pin Payments accounts the surcharge item and charge amounts are shared by all Pin Payment accounts.

Process a Test Payment

Before accepting payments from customers, perform a $1 test payment to ensure Pin Payments integration is correctly set up.

Pin Payments via Email

Add a View Invoice button to email templates for customers to view sales records and pay via card through a link. Monitor the status in the Sent column on the Sales screens.

Add View Button to Email Template

Customize email templates by adding a View Button using the following steps:

  1. Go to Setup > Preferences > Email Templates & Settings.

  2. Select the {ViewButton} placeholder from the Insert Placeholder dropdown.

  3. Ensure all template details are filled in and click Save Settings.

Display Pay Now Button for Invoice Mode Only

Adjust the global setting for the Pay Now button to appear only for Invoices by following these steps:

  1. Go to Setup > Preferences > Email Templates & Settings.

  2. Click Placeholder Settings and check the Display 'Pay Now' button for Invoice mode only checkbox.

  3. Save Changes to apply the setting.

By following these steps, you can efficiently set up Pin Payments integration in HirePOS to streamline your payment processes.

Was this article helpful?

Sorry about that! Care to tell us more?

Thanks for the feedback!

There was an issue submitting your feedback
Please check your connection and try again.