All pages
Powered by GitBook
1 of 1

Loading...

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

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 Command response output in TVL format.

Example:

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.

Example:

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.

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.

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.

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.

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.

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=testData

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

https://192.168.10.100/magneflexdemo/cardpostback.aspx?errorCode=0&err orMessage=OK&opType=SEND_COMMAND_RESULT&commandID=070501&commandResult
=270000401F3F12006034F70080F8FFFF6034F70080F8FFFF70E6530F80FAFFFF20F34 40D80FAFFFF287EF40080F8FFFF10B4480D80FAFFFF78B4480D80FAFFFF80B4480D80F AFFFF00000000000000000000000000000000000000000000000000000000000000000 00000000000000000000000000000000000000000000000&passInData=testdata

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

https://192.168.10.100/magneflexdemo/default.aspx? 
&operation=requestSignature
&httpMethod=GET 
&closeDeviceAfter=true 
&readerArgument=
    timeLimit:3C, 
    option:00, 
    tone:01, 
    endSession:true
&destinationURL=https://192.168.10.100/magneflexdemo/cardpostback.aspx 
&requestLocation=false
&passInData=testData

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

https://192.168.10.100/magneflexdemo/cardpostback.aspx,Data=opType=SIG NATURE_RESULT&signatureDataIn=283E293F29402B422B442C462E4B2F4F30513257 335A345D346035633769376B386D386E386F376C376937663663365F36573653374F38
4B39473A443C413E3F403D463A493A4D3B513C553E58406046684D6B506E547057725B
7361736473666F696C6A696A656A60695C68FFFF8E6290639163926392649364946495
64FFFF813882388337853787378A378B368D3690369236953599359C34A333A732AB32 B230B62FB92FBD2EC02DC62CC82CFFFFA827A828A929AA2AAA2BAB2CAD2FAE31AF35B0 37B138B23BB33EB542B748B84CB852B855B75AB65CB55EB05FAE60AA5FA75EA35DFFFF
D156CF54CE53CD52CC51CB4FC94EC64BFFFF&signatureResult=0&passInData=test data

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.