requestSendCommand (PinPad Only)
This query string sends a command to the device and returns the raw response from the device.
?operation=
&httpMethod=
&closeDeviceAfter=
&readerArgument=
&destinationURL=
&requestLocation=
&passInData=Parameter
Description
operation
Operation to request from MagneFlex. Use:
requestSendCommand
httpMethod
HTTP method to be used for the HTTP postback from MagneFlex. Use:
GET - returns the response data in the form of a query string. POST – recommended for EVM related transactions to accommodate limits on query string lengths.
closeDeviceAfter
Flag to close the device after the request. Use:
true – close device
false – do not close the device
readerArgument
Comma delimited list of arguments to be passed to MagneFlex. Arguments:
timeLimit:, command:, commandType:, waitForReport:, endSession:
Argument details:
timeLimit - Seconds to wait before the operation times out. Value is in hexadecimal format.
(1 - 255)
command – Command to be sent in hexadecimal.
commandType – Type of command to be sent.
“SET” = For commands where the ACK status is to be returned. “GET” = For commands where the data is to be returned.
waitForReport - The report number to wait for before returning the response.
Example:
Command 30 00 (Set KSN) will respond with an ACK (01) or with data in Get Mode (30).
“01” = will return the response for ACK report (01). “30” = will return the data report (30).
endSession - Flag to end the session for the device. Default value is true.
“true” = End the session after the request is processed.
“false” = Do not end the session after the request is processed.
destinationURL
MagneFlex will send the postback to this URL.
requestLocation
Flag to send GPS location of the device hosting Magneflex (iOS only). Use:
true – send location
false – do not send location
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Each input parameter supplied in the request is delimited by an ampersand character ‘&’, and the value for a parameter begins after an equal character ‘=’. Where ever a parameter contains multiple values, each are delimited by a comma character ‘,’.
Example query:
https://192.168.10.100/magneflexdemo/default.aspx?
operation=requestSendCommand
&httpMethod=GET
&closeDeviceAfter=true
&readerArgument=
timeLimit:3C,
command:070501,
commandType:SET,
waitForReport:27,
endSession:true
&destinationURL=https://192.168.10.100/magneflexdemo/cardpostback.aspx
&requestLocation=false
&passInData=testDataReturn Value:
The Command response output in TVL format.
Parameter
Description
errorCode
Error status. 0 is Success. Non-Zero is an error.
errorMessage
Description of the errorCode.
opType
The type of operation. For this command the value is:
SEND_COMMAND_RESULT
commandID
Command that was sent.
commandResult
Data returned from the command sent to the device.
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
Parameter
Description
operation
Operation to request from MagneFlex. Use:
requestSignature
httpMethod
HTTP method to be used for the HTTP postback from MagneFlex. Use:
GET - returns the response data in the form of a query string. POST – recommended for EVM related transactions to accommodate limits on query string lengths.
closeDeviceAfter
Flag to close the device after the request. Use:
true – close device
false – do not close the device
readerArgument
Comma delimited list of arguments to be passed to MagneFlex. Arguments:
timeLimit:, option:, tone:, endSession:
Argument details:
timeLimit - Seconds the device will wait for the user to complete the operation in hexadecimal.
(1 - 255)
option:
0 = Timeout clears any signature data
1 = Timeout returns timeout status plus length collected. Sig Data can be requested.
tone – Type of prompt tone:
0 = No sound
1 = One beep
2 = Two beeps
endSession - Flag to end the session for the device. Default value is true.
“true” = End the session after the request is processed.
“false” = Do not end the session after the request is processed.
destinationURL
MagneFlex will send the postback to this URL.
requestLocation
Flag to send GPS location of the device from which Magneflex (iOS only) is hosted.
Use:
true – send location
false – do not send location
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Each input parameter supplied in the request is delimited by an ampersand character ‘&’, and the value for a parameter begins after an equal character ‘=’. Where ever a parameter contains multiple values, each are delimited by a comma character ‘,’.
Example query:
Return Value:
The Signature capture output in TVL format.
Parameter
Description
errorCode
Error status. 0 is Success. Non-Zero is an error.
errorMessage
Description of the errorCode.
opType
The type of operation. For this command the value is:
SIGNATURE_RESULT
signatureDataIn
Signature data from the device in hexadecimal format.
signatureResult
Result of the signature capture.
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
Last updated