Browse Guides

Benji Pays Integration
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p id="isPasted"><strong>- What is the Benji Pays Integration?</strong></p><p><strong>- Connecting to Benji Pays</strong></p><p><strong>- Add Payment buttons to the Halo Portal</strong></p><p><strong>- Add Payment link to Email Template</strong></p><p><strong>- Use Halo invoice PDF when viewing Invoices in Benji Pays</strong></p><p><strong>- Additional Integration Features</strong></p><p><br></p><p><br></p><p><strong><em>Disclaimer: This is a third party integration, built by Benji Pays. Therefore should you have any queries we recommend directing these direct to the Benji Pays support team, however, our support team are always happy to help.&nbsp;</em></strong></p><p><br></p><p><br></p><p>If you are looking to use this integration we recommend checking out Benji Pay&#39;s documentation on this too:</p><ul><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000163865-halopsa-invoice-pdf-integration" id="isPasted" target="_blank" rel="noopener noreferrer">HaloPSA Invoice PDF Integration</a></li><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000199558-invoice-payment-buttons-in-halopsa" id="isPasted" target="_blank" rel="noopener noreferrer">Invoice Payment buttons in HaloPSA</a></li><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000033718-halopsa-integration-quickbooks-online" id="isPasted" target="_blank" rel="noopener noreferrer">HaloPSA integration - QuickBooks Online</a></li><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000040919-halopsa-integration-xero" id="isPasted" target="_blank" rel="noopener noreferrer">HaloPSA Integration - Xero</a></li><li><a target="_blank" rel="noopener noreferrer" data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000219174-halopsa-quotations-integration-guide" data-pasted="true">HaloPSA Quotations Integration Guide</a></li></ul><p><br></p><p><strong><span style="font-size: 14pt;">What is the Benji Pays Integration?</span></strong></p><p>The Benji Pays integration connects Halo invoices to your payment processor (e.g. Stripe). Customers can pay invoices directly from Halo emails (via pay now links) or from the Halo user portal (via a pay button). You can also use it to choose whether to show the Halo-generated invoice PDF in your Benji Pays portal &nbsp;or the one from your accounting system. For additional features available checkout the end of this guide.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Benji Pays</span></strong></p><p>Log in to Benji Pays and navigate to Settings &gt; Integrations.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY5NzIyZDQ5LTQ2NjctNGFjZC1iMDJmLWVmOGZkNjM4MjU5NyJ9.z1lNd5MlDCGl7b6VEEmU1urq6MsudbdRaJcReEeJ0WY" class="fr-fic fr-fil fr-dib" width="1310" style="width: 1312px; height: 652.196px;" height="652"></p><p><strong><span style="font-size: 10pt;">Fig 1. Integrations area in Benji Pays</span></strong></p><p><br></p><p>Select the &#39;Configure&#39; button on th integration to bring up the configuration page for the integration.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY5ZmUwYmVkLTFkODQtNGI2MS1hZDY4LTk1ZDgxNTUxMTcwNSJ9.a8E58zoU9oEnHtxOtWCrc4fMDqxoCqY77W-5W9OS95w" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 611.64px;" height="612"></p><p><strong><span style="font-size: 10pt;">Fig 2. Configure the HaloPSA integration</span></strong></p><p><br></p><p>On the configuration page you will need to enter your Halo Authorisation server Url, your Halo Tenant ID, and a client ID and secret for an application created in Halo.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQwYjdkNDUxLTgzMGMtNDQ3ZC04MWFiLTg5MzhlYWI0MTM5YSJ9.xP2uKcEsiOLtBHw8vs07kXq_3va-Iws3FA_ersv88a0" class="fr-fic fr-fil fr-dib" width="1096" style="width: 1098px; height: 698.65px;" height="699"></p><p><strong><span style="font-size: 10pt;">Fig 3. Integration connection settings</span></strong></p><p><strong><br></strong></p><p><strong><span style="font-size: 12pt;">Obtaining Credentials</span></strong></p><p>To obtain these credentials, head in Halo and head to Configuration &gt; Integrations &gt; HaloPSA API. The page here will display the Authorisation Server URL and your tenant name.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQxMDkxOTBkLTE1NzAtNDc0OS1iNThlLTAwMTFhZGJjNWUyNCJ9.GbGaH2lH2-txn135_9dq-xj3jORuMnK4xEQWcPMJaFA" class="fr-fic fr-fil fr-dib" width="1295" style="width: 1297px; height: 574.749px;" height="575"></p><p><strong><span style="font-size: 10pt;">Fig 4. Auth server URL and tenant in Halo</span></strong></p><p><br></p><p>Once you have these, you will need to create an API application in Halo.&nbsp;</p><p><br></p><p>On this same page use the &#39;View Applications&#39; button then hit &#39;New&#39; to create a new application. Give the application a name, choose &#39;Client ID and Secret (Services)&#39; as the authentication method, select the &#39;Login Type&#39; as &#39;Agent&#39; then choose an Agent to log in as.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk1Y2VkNmU2LTU4Y2YtNGQyYi1hY2NhLTNjYWZkNmNlZWMyOCJ9.xKcsRGhJ9HUtQwHyLrW1jlpkQJulB7wAfJFwhs9fuPU" class="fr-fic fr-fil fr-dib" width="1273" style="width: 1275px; height: 661.677px;" height="662"></p><p><strong><span style="font-size: 10pt;">Fig 5. API Application in Halo</span></strong></p><p><br></p><p>Ensure the agent chosen to log in as has permission in Halo to read and modify invoices.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA0NTk5MzYyLTg0MDAtNDU5OS1iYTY3LTk3MzcxMmI3MzNhMyJ9.7M9WoynSJxmvAAHfk1QrdCMAc2sTKy-UUWTVKwhgrS8" class="fr-fic fr-fil fr-dib" width="609" style="width: 611px; height: 395.561px;" height="396"></p><p><strong><span style="font-size: 10pt;">Fig 6. Invoices access level permission in Halo</span></strong></p><p><br></p><p>Give the application permissions in the &#39;Permissions&#39; tab. Add the following permissions:</p><ul><li>read:invoices</li><li>edit:invoices</li></ul><p><br></p><p>Save the application, copy and paste the Client ID and Secret into the integration connection settings in Benji Pays.&nbsp;</p><p><br></p><p>Now you have the credentials for connection there are a couple of settings to consider.</p><p><strong>Use Halo Invoice PDF when sending invoices and receipts</strong> - When enabled, this will use the Halo PDF for the invoice when users view their invoices in Benji Pays. If disabled the PDF from your integrated accounting tool will be used. &nbsp;</p><p><strong>Fallback to accounting invoice PDF</strong> - When enabled, if an invoice cannot be found in Halo, the PDF for the invoice in your accounting tool will be used. Enable this when you have invoices in your integrated accounting tool that are not in Halo.&nbsp;</p><p><br></p><p>Save the integration connection settings in Benji Pays and you should be connected.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Add Payment buttons to the Halo Portal</span></strong></p><p>Payment buttons can be added to invoices in the Halo portal that allow customers to pay for their invoices using Benji Pays. When used customers will not have to login to Benji Pays to complete the payment.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg2ZGE0YjA5LTNlYTYtNDgxNS05NjIyLWQ5NmMzNzg0ZTIwNyJ9.Bmp0cgIhntvB6lim7LVkSeSXWMDaCD3IK_Hj6HsWSBE" class="fr-fic fr-fil fr-dib" width="1290" style="width: 1292px; height: 378.542px;" height="379"></p><p><strong><span style="font-size: 10pt;">Fig 7. Payment buttons in the portal&nbsp;</span></strong></p><p><br></p><p>To setup this feature head to Benji Pays &gt; Settings &gt; Integrations &gt; &#39;Configure&#39; the HaloPSA integration &gt; ensure the &#39;Add Payment Button&#39; option is enabled and then click save.</p><p><br></p><p>In order for this to work the invoices must be syncing with your accounting tool. The link will be added automatically after the invoice is synced with your accounting tool.&nbsp;</p><p><br></p><p>Once enabled, any newly created invoices will have the &#39;Pay&#39; option in the Halo portal. If you would like the &#39;Pay&#39; button to be added to existing invoices select the &quot;Add Payment Links to Open Invoices&quot; button. This will update any existing unpaid invoices with a payment link.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRiZDJmZGVjLTcyMDQtNDllNC1iNWFlLWRmYWIxY2IzZTEyZCJ9.ukjfScdFEF7Y7id2qOc55l7_QJpFGi-E1fD2L2xI9vE" class="fr-fic fr-fil fr-dib" width="490" style="width: 492px; height: 276.182px;" height="276"></p><p><strong><span style="font-size: 10pt;">Fig 8. Option to add payment link to open invoices</span></strong></p><p><br></p><p>When the pay button is used the customer will be re-directed to the Benji Pays payment page where they can see the payment they need to complete payment for and make this payment.</p><p><br></p><p><strong><span style="font-size: 14pt;">Add Payment link to Email Template</span></strong></p><p>A payment link can be generated in Benji Pays and added to your email templates in Halo. Customers can then use this link to pay for the invoice when the invoice is emailed to them.&nbsp;</p><p><br></p><p>Setup for this differs slightly depending on the accounts tool you are using.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Obtaining the link - Quickbooks</span></strong></p><p>First in Benji Pays head to Settings &gt; Company Settings &gt; Customer Portal Settings &gt; enable &#39;Require transaction amount on Pay Now invoices to match the invoices total&#39; &gt; &#39;Save Portal Settings&#39;.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjkxNDU4NTcxLWZhODctNDBhYy04NjFlLTYwNGVlNWU3MTI1MyJ9.h8s7j9ics5z8Ok_BXycZYEE5DHqhi7DG_LAh3wwuuBs" class="fr-fic fr-fil fr-dib" width="755" height="271"></p><p><strong><span style="font-size: 10pt;">Fig 9. Require transaction amount on Pay Now invoices</span></strong></p><p><br></p><p>Now head to Settings &gt; Custom Payment Links &gt; find the link under the title &#39;Use this link in QuickBooks Online in your email templates&#39; &gt; copy this link.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjViMmEwNzY4LWU1MDMtNGFlNy1iMDE5LTM1Yjc2Y2QzOGJlMSJ9.S56PpkiYZ-Yw7Au35WU5ayjDNvMjpxgf8XSjlLkyddk" class="fr-fic fr-fil fr-dib" width="1303" style="width: 1305px; height: 655.592px;" height="656"></p><p><strong><span style="font-size: 10pt;">Fig 10. Payment link for QuickBooks</span></strong></p><p><br></p><p>You will need to adjust the link depending on which invoice number you are using in Halo:</p><ul><li>If you have enabled the setting to Sync Halo invoice number to QuickBooks Online, In the link, replace [Invoice No.] with $INVOICEID</li><li>If QuickBooks Online is setting the invoice numbers, replace [Invoice No.] with $THIRDPARTYINVOICENUMBER</li></ul><p><br></p><p><strong><span style="font-size: 12pt;">Obtaining the link - Xero</span></strong></p><p>To generate the payment link head to Benji Pays &gt; Settings &gt; Custom Payment Links &gt; PSA/ERP and other 3rd Party Payment Links section &gt; copy the link here.&nbsp;<img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU2MmY4ZTQ3LWVjZGUtNDIwYy05ZjhmLTNhZmJiODc4ZTlmMyJ9.5KrQtAYJZkdVZ9yVhv4TXZDOlFlT88G9Qhz3IIetwck" class="fr-fic fr-fil fr-dib" width="948" style="width: 950px; height: 110.977px;" height="111"></p><p><strong><span style="font-size: 10pt;">Fig 11. Payment link</span></strong></p><p><br></p><p>Add link to Email Templates</p><p>To add this to your email templates in Halo head to Configuration &gt; Email &gt; Email Templates &gt; select the template &#39;Invoice Email Subject&#39;, edit this template and paste in the payment link here.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjZmE0ZTk3LTY2ZDQtNDE2ZC05NDUxLWIxNzhjMzRiNzBkOCJ9.pwXcvLZryDldSNoQwwpExE3PrXjxZVqff5PdG_QkzRM" class="fr-fic fr-fil fr-dib" width="1316" style="width: 1318px; height: 749.329px;" height="749"></p><p><strong><span style="font-size: 10pt;">Fig 12. Add payment link to email template</span></strong></p><p><br></p><p><strong><em>Note: If you embed the payment link into your invoice PDF&#39;s, it&#39;s possible that some email filtering services will block the email.</em></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Use Halo invoice PDF when viewing Invoices in Benji Pays</span></strong></p><p>When customers view an invoice in Benji Pays you can choose whether the PDF of the invoice displayed uses the Halo PDF or the PDF from your accounting tool.&nbsp;</p><p><br></p><p>To allow the Halo PDF to be used ensure you enable &#39;Use Halo Invoice PDF when sending invoices and receipts&#39; when configuring the integration settings in Benji Pays.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Additional Integration Features</span></strong></p><p>Benji Pays offers some additional integration features not covered in this article. Such as:</p><ul><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000208472-how-to-enable-can-view-their-invoices-authorization-via-halo-psa-sso" id="isPasted" target="_blank" rel="noopener noreferrer">Sign into Benji Pays using Halo credentials (SSO)</a>&nbsp;</li><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000182849-halopsa-quickbooks-using-quickbooks-invoice-payment-terms-in-halopsa" id="isPasted" target="_blank" rel="noopener noreferrer">Use QuickBooks invoice payment terms in HaloPSA</a></li><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000167972-halopsa-how-to-skip-an-invoice-set-up-for-auto-processing" id="isPasted" target="_blank" rel="noopener noreferrer">Skip an invoice set up for Auto Processing</a></li><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000193506-add-a-custom-button-to-halo-on-the-client-record-to-link-back-to-benji-pays" id="isPasted" target="_blank" rel="noopener noreferrer">Add a custom button to Halo on the Client record to link back to Benji Pays</a></li><li><a data-fr-linked="true" href="https://support.benjipays.com/support/solutions/articles/150000203630-embed-the-benji-pays-portal-in-your-halopsa-self-serve-portal-via-an-iframe" id="isPasted" target="_blank" rel="noopener noreferrer">Add a custom button to Halo on the Client record to link back to Benji Pays</a></li></ul><p><br></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.