clearPosDeviceScreen

Clear pos device screen

Description

Clears the screen and returns the pos device to idle state.

Syntax

clearPosDeviceScreen ( ueSecurityToken Token)

Arguments

Type	Name	Description
ueSecurityToken	Token	Merchant security token: used to identify merchant and retrieve the custom fields.

Return Value

string

Status

Indicates whether screen was successfully cleared

Exceptions

The following exceptions (errors) are applicable to this method.

Code	Message	Advice
21100	There are no POS devices associated with this source key	Register a pos device to this source key
21101	POS device offline	Device associated with this source key is offline, try rebooting

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

VB

.NET C#

XML

Request:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www.usaepay.com/soap/2.0/uedocs">
<SOAP-ENV:Body>
<ns1:clearPosDeviceScreen>
<Token>
<ClientIP>192.168.0.1</ClientIP>
<PinHash>
<HashValue>8fec8c064a722b0e0885a8e4a76591534feebc3c</HashValue><Seed>1365180546476681040</Seed>
<Type>sha1</Type>
</PinHash>
<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>
</Token>
</ns1:clearPosDeviceScreen>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response:

Change History

Version	Change
1.6	Method added in this release

Table of Contents