Integrated Manual Settlement

Terminal settlement can now be accessed through the TTA via the .Net interface. The name of the interface is "Tyro.Integ.ITerminalAdapterSettlement". At the conclusion of the execution of the methods, control will be returned to the caller and an object containing the result of the operation will be given.

Methods

The ITerminalAdapterSettlement interface exposes the following methods:

• ISettlementResult ManuallySettle() : This method makes an HTTPS POST request to the Tyro Integration Server requesting a manual terminal settlement. It uses the default MID and TID configured in the TTA configuration panel. An instance of ISettlementResult is returned that the caller can interrogate for the settlement information.
• ISettlementResult ManuallySettleMidTid(string mid, string tid) : This method make an HTTPS POST request to the Tyro Integration Server requesting a manual terminal settlement using the specified mid and tid. An instance of ISettlementResult is returned that the caller can interrogate for the settlement information.

Return Value

The ISettlementResult interface contains the following methods:

• boolean ErrorOccurred() : This method returns true if a configuration or network error occurred. In this case the caller should call the GetError() method to determine what the cause of the error was so that corrective action can be take. A return value of false indicates that the call executed successfully.
• string GetResult() : A machine readable result code. The value is either SUCCESS or ALREADY_SETTLED.
• Error GetError() : This method returns an Error object that allows the caller to determine things like the HttpStatusCode, the ErrorMessage and other useful pieces of information.
• string GetCurrentTerminalBusinessDay() : The current terminal business date on the terminal in dd/MM/yyyy format. This is the date the terminal is now on after settlement.
• string GetMessage() : A human readable message that can be displayed on the POS.

Response Error Codes

The following HTTP error codes may be returned for an Integrated Manual Settlement request. The value can be access via ISettlementResult.getError().getHttpStatusCode()

HTTP Code	HTTP Name	When
200	OK	Request succeeds (see below for more info)
202	Accepted	System not ready to receive requests
400	Bad Request	Request does not conform to requirements
403	Authentication Failed	Submitted key does not match Terminal's key
404	Not Found	Terminal is not connected to Tyro
500	Server Error	Error in Tyro system - Please report these to Tyro
501	Not Implemented	The operation is not available
503	Service Unavailable	The Terminal is busy fulfilling another request
504	Gateway Timeout	Request timed out before response could be generated

Notes on the integrated manual settlement functions:

1. The integrated manual settlement function is optional. The terminal will settle at its pre-configured auto-settlement time.
2. Tyro terminals can only settle once per Tyro Business Day (which is 5am to 5am AEST).

Integrated Tip Completion

Integrated tip completion is no longer available. The PIN mandate that is now in effect within Australia makes tipping via the receipt (i.e. writing a tip amount on the receipt) unsuitable. The functions are still available in the API (so that existing integrations don't break) however these function should be considered deprecated.