displayPosDeviceScreen
Display a screen/message on the pos device
Allows the developer to display a predefined screen to the pos device associated with the source key. For screens that support it, a custom message can also be set. If the name of screen does not match a screen that is available on the pos device, the default idle screen will be displayed.
displayPosDeviceScreen ( ueSecurityToken Token, string Screen, string Message)
Type |
Name |
Description |
Token |
Merchant security token: used to identify merchant and retrieve the custom fields. |
|
string |
Screen |
Name of screen to display |
string |
Message |
Message to display |
string |
Status |
Confirmation that screen was displayed |
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 |
Request:
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://secure.eBizCharge.com/soap/2.0/uedocs">
<SOAP-ENV:Body>
<ns1:displayPosDeviceScreen>
<Token>
<ClientIP>192.168.0.1</ClientIP>
<PinHash>
<HashValue>01c95985232effa5e74f07b39884a091a8982c97</HashValue>
<Seed>13651794221583757287</Seed>
<Type>sha1</Type>
</PinHash>
<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>
</Token>
<Screen>idle</Screen>
<Message>Testing 879642494</Message>
</ns1:displayPosDeviceScreen>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Response: