Diagnosis Request

It conveys Information related to the target POI for which the diagnosis is requested. Content of the Diagnosis Request message.

Request Parameters

Required

Optional

Identification of a POI System or a POI Terminal for the Sale to POI protocol. MessageHeader.POIID.

Indicates if Host Diagnosis are required.

Identification of the Acquirer. Present if requesting the diagnosis of these hosts only.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200
It conveys the result of the requested diagnosis and a possible message to display on a logical device. Content of the Diagnosis Response message.
Show moreShow less
Responseobject
Result of a message request processing. If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements.
Show children Hide children
Resultstring
Result of the processing of the message. Possible values:

Failure

Partial

Success

ErrorConditionstring
Condition that has produced an error on the processing of a message request. Returned if Result is not Success. Possible values:

Aborted

Busy

Cancel

DeviceOut

InProgress

InsertedCard

InvalidCard

LoggedOut

MessageFormat

NotAllowed

NotFound

PaymentRestriction

Refusal

UnavailableDevice

UnavailableService

UnreachableHost

WrongPIN

AdditionalResponsestring
Additional information related to processing status of a message request. If present, the POI logs it for further examination.
LoggedSaleIDarray[string]
Sale Terminal logged to. If Sale Terminal logged to this POI Terminal.
POIStatusobject
Indicate the availability of the POI Terminal components. The data element is absent if the component is not part of the POI Terminal. State of a POI Terminal.
Show children Hide children
GlobalStatusstring
Global status of a POI Server or POI Terminal. Possible values:

Busy

Maintenance

OK

Unreachable

SecurityOKFlagboolean
Indicates if the security module of the POI is working and usable. If security module present.
PEDOKFlagboolean
Indicates if the PED is working and usable. If PED present.
CardReaderOKFlagboolean
Indicates if the card readers are working and usable. If card reader device present.
PrinterStatusstring
Indicates if the printer is working and usable. Possible values:

NoPaper

OK

OutOfOrder

PaperJam

PaperLow

CommunicationOKFlagboolean
Indicates if the communication infrastructure is working and usable. If communication infrastructure present.
CashHandlingDevicearray[object]
Status of cash handling device. If cash handling devices present.
Show children Hide children
CashHandlingOKFlagboolean
Indicates if the cash handling device is working and usable.
Currencystring
Currency of a monetary amount.
CoinsOrBillsarray[object]
Number of coins or bills of a given value.
Show children Hide children
UnitValuenumber
Maximum: 99999999.999999
Value of a coin or bill.
Numberinteger
Number of coins or bills of a certain value.
FraudPreventionFlagboolean
Indicates a suspicion of fraud by the POI System. Could be set to True by the POI system to notify to the Sale system and the Cashier that a suspicion of fraud had been detected on the POI as an unexpected reboot of the POI.
HostStatusarray[object]
State of a Host.
Show children Hide children
AcquirerIDinteger
Identification of the Acquirer.
IsReachableFlagboolean
Indicate if a Host is reachable.

Diagnosis Request

Request Parameters

Response parameters

HTTP Responses

200