Branch-Specific PIN Payments Accounts
HirePOS supports separate PIN Payments accounts per branch.
This allows different branches within the same HirePOS database to process payments into different PIN Payments merchant accounts.
Important Behaviour
Branch-specific PIN Payments settings only apply when working with a quote, booking, or invoice that is assigned to that branch.
The branch selected in the top-left corner of the invoice screen determines which PIN Payments account will be used.
If the branch has its own PIN Payments API credentials configured, that branch-specific PIN Payments account will be used.
If the branch does not have its own PIN Payments setup, the default/root PIN Payments account will be used instead.
Important Limitations and Rules
Customers are global across all branches
Customers in HirePOS are shared across the entire database and are not branch-specific.
Because of this:
Stored credit cards belong to the specific PIN Payments account they were originally stored against.
Stored cards cannot be shared between different PIN Payments accounts.
There is no cross-talk between PIN Payments accounts.
This means:
A card stored against the root/default PIN Payments account cannot be used by a branch-specific PIN Payments account.
A card stored against a branch-specific PIN Payments account cannot be used by the root/default account or other branches.
If HirePOS attempts to access a card stored in a different PIN Payments account, an error will occur.
A customer can only have one stored card at a time
A stored card will only exist in one PIN Payments account at a time.
Critical Requirement
NEVER use the Credit Card button in Customer Overview
Branches using branch-specific PIN Payments accounts should never use:
Sales/Hire > Customer Overview > (select customer) > Credit Card
Using this button stores the card against the root/default PIN Payments account instead of the branch-specific account.
This will cause card retrieval and charging issues for branch-level PIN Payments workflows.
Correct Workflow for Branch-Specific PIN Payments
To correctly use branch-specific PIN Payments accounts:
Open a quote, booking, or invoice assigned to the correct branch.
Confirm the correct branch is selected in the top-left corner of the invoice screen.
Click the dropdown menu beside the Payment button.
Select:
Card Payment (PIN Payments)
Enter card details or retrieve an existing stored card for that branch.
Optionally enable storing the card while processing the payment.
Complete the payment.
If the card is stored during this process:
The card is stored against that branch's PIN Payments account.
Future invoices for the same branch will be able to retrieve the stored card.
Link.HirePOS and Online Payments
This behaviour also applies to:
Link.HirePOS
View Button payments from emailed invoices
When a customer pays online:
The invoice branch determines which PIN Payments account is used.
If the customer chooses to store their card, the card is stored against that branch's PIN Payments account.
Required Customer Information for Stored Cards
Any customer that will have a stored card must have at minimum:
Email address
Company Name OR First Name + Last Name
Address
City
Country
Without this information, card storage may fail.
Setting Up a Branch-Specific PIN Payments Account
You must be an administrator to configure branch-level PIN Payments settings.
Step 1 - Create the Secondary PIN Payments Account
Create the additional PIN Payments account at:
Step 2 - Configure the Branch in HirePOS
Navigate to:
Setup > Branches
Select the branch that will use its own PIN Payments account.
Open the:
API / Integrations section
Enter the API Secret from the PIN Payments account.
This can be found in:
PIN Payments > Account > API Keys
Select the HirePOS bank account that payments should be recorded against.
It is recommended to create a separate bank account in HirePOS for each PIN Payments account to simplify reconciliation and reporting.
Save the branch.
Important Notes
Branch-level PIN Payments settings only apply when working with invoices assigned to that branch.
Existing HirePOS PIN Payments documentation generally assumes a single/root PIN Payments account.
Branch-specific workflows should follow the invoice-based payment workflow outlined in this document.
The branch selected on the invoice controls:
Which PIN Payments account is used
Which stored cards can be retrieved
Where online payments are processed
Where newly stored cards are saved
