developer:posdevices

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
developer:posdevices [2013/07/30 16:20]
tem [Example Application]
developer:posdevices [2015/08/03 08:53] (current)
tem
Line 1: Line 1:
-====== POS Device Server ====== +This page [[developer:​middleware:standalone|has moved]]
- +
-In a traditional point of sale (POS) environment, ​ the developer deploys software on the cash register computer which communicates directly with devices such card swipers and pinpads via usb or serial. ​ Sensitive card data is transmitted from the swiper device to the cash register machine and point of sale before being forwarded to the credit card processor.  ​This makes the POS software and the cash register computer a point of vulnerability to compromise. ​  +
- +
-The POS Device Server offloads all communication with pos devices. ​  The POS device communicates directly with the PCI environment hosted by gateway SSL encrypted connection. ​ The POS software sends instructions to the gateway to prompt the customer for payment and the gateway handles the entire process of handling card swipe, ​ capturing signature and processing the payment. ​ No sensitive card data ever touches the POS software or the computer its installed on.  This greatly reduces risk for the merchant and simplifies the PCI audit process. ​  +
- +
-===== Terms ===== +
- +
-==== POS Software ==== +
-This is the third party software being integrated. ​ The following documentation assumes that this is a merchant ​ facing application,​ although this is not necessarily required. ​ Other applications could include customer facing kiosks, ​ self service applications,​ etc. +
- +
-==== POS Device ==== +
-A point of sale hardware accessory such as a pin pad, card swiper, or combination unit.  +
- +
- +
-===== API Methods ===== +
- +
-[[developer:​posdevices:​changelog|Change History]] +
- +
- +
-^ Rest ^ Soap ^ Description ^ +
-| GET /​api/​posdevice/​registration | [[developer:​soap-1.6:​methods:​getRegistrationPin]] | Get a device registration pin |  +
-| DELETE /​api/​posdevice/​registration | [[developer:​soap-1.6:​methods:​deletePosDeviceRegistration]] | Remove device registration | +
-| GET /​api/​posdevice | [[developer:​soap-1.6:​methods:​getPosDevice]] | Retrieve information about connected pos device | +
-| GET /​api/​posdevice/​screen | [[developer:​soap-1.6:​methods:​getPosDeviceScreen]] | Retrieve name of screen currently display on device | +
-| PUT /​api/​posdevice/​screen | [[developer:​soap-1.6:​methods:​displayPosDeviceScreen]] | Display screen and/or custom message on pos device | +
-| DELETE /​api/​posdevice/​screen | [[developer:​soap-1.6:​methods:​clearPosDeviceScreen]] | Clear pos screen and return device to idle | +
-| PUT /​api/​posdevice/​checkout | [[developer:​soap-1.6:​methods:​startCheckOut]] | Start checkout pos device ​ | +
-| POST /​api/​posdevice/​checkout | [[developer:​soap-1.6:​methods:​updateCheckOut]] | Provide additional information to checkout process (ie add line items) | +
-| GET /​api/​posdevice/​checkout | [[developer:​soap-1.6:​methods:​getCheckOutStatus]] | Retrieve information about current checkout status | +
-| DELETE /​api/​posdevice/​checkout | [[developer:​soap-1.6:​methods:​cancelCheckOut]] | Cancel checkout | +
-| PUT /​api/​posdevice/​signature | [[developer:​soap-1.6:​methods:​requestSignature]] | Start signature request ​ | +
-| GET /​api/​posdevice/​signature | [[developer:​soap-1.6:​methods:​getSignatureStatus]] | Retrieve status of signature and signature if complete | +
-| DELETE /​api/​posdevice/​signature | [[developer:​soap-1.6:​methods:​cancelSignatureRequest]] | Cancel signature request | +
- +
- +
-===== Example Application ===== +
-  +
-To demonstrate the functionality of the POS Device Server api the following rudimentary point of sale application is provided. ​  It is available as a VB.Net project. ​  ​Please replace the example source key with your own SourceKey and pin before using. +
- +
-[[https://​downloads.usaepay.com/​POSDeviceExample_rev6.zip|POSDeviceExample ​ Rev6]] +
developer/posdevices.txt · Last modified: 2015/08/03 08:53 by tem

Page Tools