Chapter 12 – StatusCheck Method

The purpose of the StatusCheck method is to allow integrators to check the online status of a device at any time by sending just a few parameters.

Important Note:
If a StatusCheck Request is submitted to a device that has already received another Request and is in use, the Response received may not indicate the actual status of the the terminal due to its processing state.

Section 12.1 - Service Location: link

For SOAP connections:

https://demo.spweblink.com/service/StatusCheck.asmx?op=StatusCheck

For standard HTTPS connections:

https://demo.spweblink.com/service/StatusCheck.asmx

StatusCheck Input Parameters

O = Optional, R = Required, C = Conditional

Parameter Name

Opt/Req/ Conditional

Max Length

Description

UserName

R

24

User name assigned in the payment server. The user must have an appropriate level of access within the system in order to utilize the web service. Assigned by Nuvei

Password

R

24

Password associated with the user name provided. Assigned by Nuvei

PosID

R

24

Value assigned by Nuvei to identify the ISV

SerialNum

R

10

Unique Serial Number of the Payment device.

ExtData

O

256

Reserved for future use

Section 12.1.1 - Status Check Response Data Definitions

O = Optional, R = Required, C = Conditional

Parameter Name

Opt/Req/ Conditional

Max Length

Description

ResultCode

R

6

Transaction Result Code: Determines transaction results

ResultMessage

R

64

Transaction Result Text. Review result text for details of a transaction.

 

Section 12.2 - StatusCheck XML Schema link

Section 12.2.1 - SOAP 1.1 Request and Response link

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Service/PosService.asmx HTTP/1.1 Host: demo.spweblink.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://secure.spweblink.com/StatusCheck" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <StatusCheck xmlns="https://secure.spweblink.com/"> <UserName>string</UserName> <Password>string</Password> <PosID>string</PosID> <SerialNum>string</SerialNum> <ExtData>string</ExtData> </StatusCheck> </soap:Body> </soap:Envelope> HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <StatusCheckResponse xmlns="https://secure.spweblink.com/"> <StatusCheckResult> <ResultCode>string</ResultCode> <ResultMsg>string</ResultMsg> <ExtData>string</ExtData> </StatusCheckResult> </StatusCheckResponse> </soap:Body> </soap:Envelope>

Section 12.2.2 - SOAP 1.2 Request and Response link

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Service/PosService.asmx HTTP/1.1 Host: demo.spweblink.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <StatusCheck xmlns="https://secure.spweblink.com/"> <UserName>string</UserName> <Password>string</Password> <PosID>string</PosID> <SerialNum>string</SerialNum> <ExtData>string</ExtData> </StatusCheck> </soap12:Body> </soap12:Envelope> HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <StatusCheckResponse xmlns="https://secure.spweblink.com/"> <StatusCheckResult> <ResultCode>string</ResultCode> <ResultMsg>string</ResultMsg> <ExtData>string</ExtData> </StatusCheckResult> </StatusCheckResponse> </soap12:Body> </soap12:Envelope>

Section 12.2.3 - HTTPS GET Request and Response link

The following is a sample HTTPS GET request and response. The placeholders shown need to be replaced with actual values.

GET /Service/PosService.asmx/StatusCheck?UserName=string&Password=string&PosID=string&SerialNum=string&ExtData=string HTTP/1.1 Host: demo.spweblink.com HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <StatusCheckResult xmlns="https://secure.spweblink.com/"> <ResultCode>string</ResultCode> <ResultMsg>string</ResultMsg> <ExtData>string</ExtData> </StatusCheckResult>

Section 12.2.4 - HTTPS POST Request and Response link

The following is a sample HTTPS POST request and response. The placeholders shown need to be replaced with actual values.

POST /Service/PosService.asmx/StatusCheck HTTP/1.1 Host: demo.spweblink.com Content-Type: application/x-www-form-urlencoded Content-Length: length UserName=string&Password=string&PosID=string&SerialNum=string&ExtData=string HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <StatusCheckResult xmlns="https://secure.spweblink.com/"> <ResultCode>string</ResultCode> <ResultMsg>string</ResultMsg> <ExtData>string</ExtData> </StatusCheckResult>

Section 12.2.5 - JSON Format link

POST /Service/PosService.asmx/StatusCheck HTTP/1.1 Host: demo.spweblink.com Content-Type: application/json; charset=utf-8 Content-Length: length { "StatusCheck": { "UserName": "string", "Password": "string", "PosID": "string", "SerialNum": "string", "ExtData": "string", "_xmlns": "https://secure.spweblink.com/" } } { "StatusCheckResponse": { "StatusCheckResult": { "ResultCode": "string", "ResultMsg": "string", "ExtData": "string" }, "_xmlns": "https://secure.spweblink.com/" } }

Need Help?

How can we help you today?  Our team is standing by and just a click away.