Pin Payments (On-Charging Fees with Payment Link)
Updated 2 years ago
The HirePOS Pin Payments integration allows for 2 distinct methods of handling the fees associated with a Pin Payments transaction.
- Absorb the fees as a part of your service to the customer (using the Pin Payments API and the {ViewButton} in your email templates)
- On-charge your Pin Payments fees to the customer (see below)
Whilst we see most of our customers electing to absorb the fees, and make use of the API, there are select cases where on-charging the fees is a requirement. If you wish to on-charge the fees, keep reading.
To on-charge your pin-payments fees, you will need to log into your Pin Payments account and change some settings. You will also need to adjust your setup in HirePOS.
On-Charging Pin Payments Fees to the Customer
Setting up Pin Payments
- Log into your Pin Payments account at https://dashboard.pinpayments.com/login
- In the menu tabs on the left side of the screen, click Account.
- Click on the Payment page option in the centre of the screen in blue.
- Enable Surcharging via the Enable radial button.
- Copy the Link provided.
Setting up HirePOS to use the Pin Payments Payment Link
- In HirePOS, go to Setup > Preferences > Accounting Integration & Other API's > Pin Payments
- Paste the Link you copied into the Payment Link field.
- It is highly recommended that you remove any API keys or API secrets from this page (if present)
- Press Save
It is highly recommended that you only use either the Payment Link (for on-charging fees) OR the API Key (for absorbing fees). Using both at the same time will result in the customer being able to pay using either method, and you getting unpredictable results.
Payment Link in Email Templates
- From the main menu strip at the top, go to Setup > Preferences > Email Templates/Settings.
- Use the Insert Placeholder drop down to the right of the Default Email Message box.
- Select the Payment Link option.
This will insert the text {PaymentLink} into the Default Email Message box.
By default, when emailing, the placeholder is automatically replaced with the Pin Payment link, and the invoice number and balance due are passed as parameters which will automatically populate these fields in the Pin Payments web page.