triPOS Cloud Beta/Pilot FAQ

Document created by dourada on Nov 23, 2016Last modified by jeff.gross@vantiv.com on Apr 7, 2017
Version 21Show Document
  • View in full screen mode
  • What do I do after receiving the Mx915 device?

The Mx915 is configured for DHCP and hardwired Ethernet. You should be able to just plug it in, and after it boots, the PIN pad will display an activation code, which the POS software application will then use to pair the device.  Ensure that the Ethernet cable is plugged into the appropriate Ethernet port in the communication module in the back of the Mx915 PIN pad (see image below).

 

 

triPOS Cloud now supports API endpoints allowing the PIN pad to be paired with your account. To pair the device, you will send a POST request that includes the laneId, terminalId, model, description, and the activationCode shown on the PIN pad.

 

Integrating to triPOS Cloud is very similar to integrating to triPOS Distributed. You can see documentation on differences in the API at API Differences between triPOS Cloud and triPOS Distributed

 

  • triPOS Distributed vs. triPOS Cloud

API Differences between triPOS Cloud and triPOS Distributed

 

  • What happens when I lose Internet connectivity?  Or if there is a timeout when sending a txn to the cloud?

Users of triPOS Cloud are encouraged to have a transaction processing backup solution in the event of the loss of Internet connectivity. The use of Vantiv's Virtual Terminal Plus on a mobile Internet connected device is one such option. If Internet connectivity loss is expected to be frequent, or the need to seamlessly process transactions when offline is critical, you may want to consider triPOS Distributed and its offline Store and Forward capability.

 

The procedure for a timeout with triPOS Cloud is the same as the procedure for a timeout with triPOS Distributed or a direct to Express integration. Namely, the attempted transaction should be reversed until a Not Found or Reversed response is received, and then the transaction can be attempted again. The Vantiv Developer Integrations group can provide more information on this recommended approach.

 

  • How does logging work with triPOS cloud?  If I do not receive an expected response where do I find more information to allow troubleshooting?  With triPOS distributed I would have looked in the file system for the verbose triPOS text log.  Is there something like this for triPOS cloud?

Troubleshooting for errors in a triPOS request should start by examining the error messages on the response itself. In the event that these errors do not reveal the issue, the Vantiv Developer Integrations team can work with you to conduct a detailed trace of the transaction and determine a root cause.

 

  • Is there a triPOS.config in the cloud?  How do I configure lanes and attributes of those lanes?

The triPOS Cloud solution does not have the concept of a triPOS config. The triPOS.config file provides two primary functions for the triPOS Distributed product: transaction handling configuration and lane configuration. In triPOS Cloud, transaction handling configuration options will be sent in the configuration options section of the request itself. Lane configuration will be handled by a set of cloud-specific lane endpoints at https://triposcert.vantiv.com/cloudapi/swagger/ui/index#/.

 

  • What data structure is supported when communicating with triPOS Cloud?

triPOS Cloud will only support JSON requests going forward.

 

  • What HTTPS endpoint do I use for triPOS Cloud?

 

triposcert.vantiv.com is the base URL and then you add methods exactly like triPOS distributed.  So, to send a sale, you would post to this URL: triposcert.vantiv.com/api/v1/sale

 

Add headers:

tp-express-account-id

tp-express-acceptor-id

tp-express-account-token

tp-request-id

tp-application-id

tp-application-name

tp-application-version

tp-authorization: Version=2.0

 

Add a payload:

{

    "laneId":"9999",

    "transactionAmount":"1.22"

}

 

And that's all you need to do to process a transaction to triPOS Cloud. Please note that the tp-authorization header will be unnecessary on a future release.

 

Documentation is available using the following links:

 

API: https://triposcert.vantiv.com/cloudapi/swagger/ui/index

Lane API: https://triposcert.vantiv.com/api/swagger-ui-bootstrap/

 

  • How do I manage lanes?  What endpoint do I use for triPOS Cloud Lane Management

The lane management API is the cloud equivalent of the triPOS distributed lane API calls.  The lane management API will allow an integrator to pair a pinpad device to the Express API credentials.  When a device is received that has not been paired to Express API credentials it will boot up and display an Activation Code.  The POS should offer a pairing process to the POS operator where they enter the ActivationCode and then the POS will send the 'Add Device' command to the lane management API including the ActivationCode.

 

For the triPOS Cloud beta all of the devices were shipped with this pairing process already complete so to reset the device to an unpaired mode you will need to make a DELETE API request first.

 

The endpoint for the lane management API help/documentation is:

 

     https://triposcert.vantiv.com/cloudapi/swagger/ui/index

 

And the HTTPS POST URL for managing lanes is:

 

     triposcert.vantiv.com/cloudapi/v1/lanes

 

Use the same headers as specified above when accessing the lane management API.

 

Add device

Send a POST to /cloudapi/v1/lanes with the following body content:

{

  "laneId": "string",

  "description": "string",

  "terminalId": "string",

  "activationCode": "string"

}

 

Delete/Get/Get all device(s)

These are the most straightforward. For delete/get you'll provide an ID and each endpoint will perform the action on the lane(s) associated with their account.

 

Update

There is no update (PUT) endpoint at this time. In order to perform an "update" first delete then re-add.

 

  • How can I manage the sound/volume on the Mx915 PIN pad?

The volume is a config setting.  On the Administration tab, scroll all the way to right using the right arrow, and then choose the Audio tab. The default volume setting is 60%.

 

  • Are custom PIN pad forms supported with triPOS Cloud?

Feel free to use the Signature endpoint at GET /api/v1/signature/{laneId}. Most of our partner ISVs use the "contract" form for membership agreements. GET /api/v1/signature/1?form=contract&header=The%20Header&subHeader=The%20Subheader&text=A%20large%20text%20area

 

  • Can I set a custom idle message or custom idle logo?

Not at this time.  The ability to set a customer idle message or logo is currently being reviewed.

 

  • An activation code is display on the PIN pad.  What do I do with this activation code?

The intention is that the end user initiates the pairing by taking the activation code and entering it into the point of sale application, which would then include that activation code in the appropriate triPOS Cloud lane management endpoint request to add the new lane. Basically, your point of sale software could ask the user to enter the activation code shown on the PIN pad in order to pair the device to their account.

 

  • With regard to the lane activation endpoint, I see that the base URL is "cloudapi", whereas transactions use "api". Will all the requests eventually be consolidated under one base URL or will the lane requests always live separately under cloudapi?

Eventually the routes will be consolidated.  For the time being, our architecture requires the endpoints that were in triPOS distributed to be under /api and new cloud-specific endpoints to be under /cloudapi.

 

  • Once my triPOS Cloud integration is finished, is there a certification process I must complete?

Yes, like any integration to our platform (i.e. Express Direct, triPOS Distributed, or triPOS Mobile), you will work through our short certification process with our Developer Integrations team to ensure request data is being properly submitted to prevent errors, unnecessary transaction downgrades, etc.

 

  • As of March 27, 2017, ISV's using Mx915 test PINpads in the triPOS Cloud Cert environment should ensure their PINpad has been updated to point to the correct triPOS Cloud Cert URL (Hostip).  Details on how to verify and update the Mx915 test PINpad are included below.  This should be done prior to March 31, 2017.

In order to ensure continuity of service, you will need to update the hostip on your Mx PIN pad.

 

               On the PIN pad, perform the following steps:

 

      1. Press 1,5,9 at the same time
        • It may require multiple attempts depending on what the PIN pad is doing
      2. Enter 166832 and press Enter
      3. Tap Administration
      4. Tap Config
      5. Select config.usr1
      6. Scroll to hostip
        • It is located in the [reg] section
        • If you reach the [iab] section then you have gone too far
      7. Tap triposcert.westus.cloudapp.azure.com
        • Note: If your hostip URL already says device.triposcert.vantiv.com your device is updated already. Skip to step 11
      8. Clear the text by tapping the BACK button on the PIN pad screen or by pressing the physical PIN pad – the left facing (yellow angle bracket) button
      9. Enter the new hostip of: device.triposcert.vantiv.com
      10. Ensure correct spelling and press the Enter button on the PIN pad (green circle)
      11. Tap Home
      12. Tap Reboot
      13. PIN will connect to triPOS cloud and display:
          • The triPOS logo – the PIN pad has already been paired
          • An activation code – the PIN pad needs to be paired
    3 people found this helpful

    Attachments

      Outcomes