Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titlePrerequisites

This feature must be switched on for your site by Commerce Vision. 


Excerpt
hiddentrue

Extend the Point of Sale (POS) functionality of your website by connecting your online application to a physical in-store payment terminal.


Multiexcerpt
hiddentrue
MultiExcerptNameFeature Title

Albert Terminal Payment Integration


Multiexcerpt
MultiExcerptNameFeature Overview

Extend the Point of Sale (POS) functionality of your website by connecting your online application to a physical in-store payment terminal. 


This example shows you how to integrate a physical POS terminal with your online application using SignalR technology. SignalR allows your ecommerce system to push web content to connected clients in real-time; in this case, a CommBank Albert Payment Terminal to process payments. 

Step-by-step guide


IMPORTANT - An Albert Terminal must already be connected and operating correctly in your environment.

  1. In the CMS, navigate to SettingsFeature Management → Payment & Checkout → Terminal Payment. You can also search for Terminal Payment.


  2. Toggle ON Terminal Payment, then click Configure.

  3. In Configuration Settings, toggle ON Enable Terminal Payment.

  4. Toggle ON Enable Terminal Payment and Enable Terminal Payment for Trade Docket. Or use the Overrides option to control what Roles will see the Terminal Payment option.


  5. To save your changes, click Save and Exit.

  6. Navigate to the Checkout Template: Content → Pages & Templates → Checkout.

  7. Find the Checkout Payment Options widget and click Edit. In our example, it is in the Step2 Zone.
  8. Select the Terminal Payments tab. TIP - If you don't see it, review Steps 2 to 6 to ensure you have enabled Terminal Payments. 
  9. You don't need to alter any parameters within this tab for the Albert Terminal functionality to work, you may want to customise the messages.

  10. To define the text for the button users will click when selecting a SignalR client, e.g., a printer enabled to print orders/invoices in PDF format, add the SignalR Group Message Selector widget to the Checkout template. You don't have to add it to a specific zone. We will add ours to the Step2 zone.

  11. You don't have to change any options here for the functionality to work correctly. However, you may want to change Client Group Select Prompt to something more meaningful.  We've changed ours to reflect what the action will do: Select a Terminal.
  12. To edit more options, see: SignalR Group Message Selector widget help.

  13. To save your changes, click Save.

Test Albert Payment Terminal Functionality

You can test the set up by making a purchase on your website. 


  1. On your website, follow your standard procedures to purchase a product and head to checkout. 

  2. In the Payment section, you should see a new Terminal tab and your prompt to select the terminal. 
  3. Ensure your Albert Terminal is turned on and connected to your provider.

  4. Click  Send Order to Terminal
  5. A Payment Processing message will display. Follow any prompts on your terminal.


  6. The system will display a Successful Order Confirmation message if the payment processes correctly.
  7. Should the payment fail, you will receive a Payment Not Processed message. You can click the View Cart link and retry your payment.



Additional Information

Info

We recommend testing this functionality in your staging site before taking it live.

Contact Commerce Vision if you want to configure this functionality for your site.


Multiexcerpt
hiddentrue
MultiExcerptNameAdditional Info

--




Minimum Version Requirements


Multiexcerpt
MultiExcerptNameMinimum Version Requirements

4.13.00


Prerequisites


Multiexcerpt
MultiExcerptNamePre reqs

POS Terminal and SignalR functionality configured and working.


Self Configurable


Multiexcerpt
MultiExcerptNameSelf Configurable

No; needs API development; 


Business Function


Multiexcerpt
MultiExcerptNameBusiness Function

Payment Types


BPD Only?


Multiexcerpt
MultiExcerptNameBPD Only

Yes


B2B/B2C/Both


Multiexcerpt
MultiExcerptNameB2B/B2C/Both

Both


Third Party Costs


Multiexcerpt
MultiExcerptNameThird Party Costs

Fees apply


--

Excerpt
hiddentrue

API expectations

Print Order

Send

{

Data: {

                FileName: “file name string including website URL”

},

MessageType: “PrintOrder”,

ResponseToken: “secure string we require on a response”

}


Response – Received

We accept a response indicating the client has received our data sent, fields to be sent

  • the response token from the original request is required
  • successful boolen
  • additional message


Response – Processed

We accept a response indicating the client has received our data sent, fields to be sent

  • the response token from the original request is required
  • successful boolen
  • additional message
    • this will include the file name so that we can delete the file



Related help

Content by Label
showLabelsfalse
max10
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
excludeCurrenttrue
cqllabel = "payment" and type = "page" and space = "KB" and title ~ "'payment types'"
labelshow-to