Method
Name | Description |
---|---|
ShowScreen | For terminals with large screens (MX925, MX915) this method allows the cash register to display specific screens prior to the processing the tender. Use this method to display order items on a virtual receipt. |
Parameters
Name | Type | Required | Description |
---|---|---|---|
merchantAccount |
String | The merchant account associated with the transaction | |
screenName |
String | Name of the XSLT file stored in the terminal and used as a template. | |
formatB64XML |
String | Base64 encoded XML data sent to the screen. Includes data elements as well as styling options. The XML contains all relevant data in simple nodes. The relevant options depend on the template to show the screen and expose content control options. |
Callback
Name | Description |
---|---|
ShowScreenCB |
Callback used to return whether the screen displayed correctly, including error messages if applicable. |
Returned Details
Name | Type | Description |
---|---|---|
screenId |
int | The ID of the screen reporting in the callback. A terminal will only accept one message at a time. If several showScreen requests are sent before getting the showScreen callback, the last message will override previous messages. |
pedResult |
int | Result denoting whether an error occurred on the PED. A value of 0 means no error occurred. |
pspResult |
int | Result denoting whether an error occurred on the PSP. A value of 0 means no error occurred. |
libResult |
int | Result denoting whether an error occurred in the Library. A value of 0 means no error occurred. |
errorMessage |
String | Error message describing what went wrong. |