# WEB API Resources - Part 2 #### sendARPC (EMV Only) This query string sends the ARPC to the device during an EMV transaction. ``` ?operation= &httpMethod= &closeDeviceAfter= &readerArgument= &destinationURL= &requestLocation= &passInData= ```
ParameterDescription
operation

Operation to request from MagneFlex. Use:

sendARPC

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 length.

closeDeviceAfter

Flag to close the device after the request. Use:

true – close device

false – do not close the device

readerArgument

ARPC data to send to the device. issuerAuthenticationData:, endSession:

Argument details:

issuerAuthenticationData – ARPC response to send to the device.

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.

destinationURLMagneFlex 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

passInDataOptional 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/cardpostback.aspx? operation=sendARPC &httpMethod=GET &closeDeviceAfter=true &readerArgument= issuerAuthenticationData:0030F92EDFDF540A00000000000000000000DFDF550182DFDF250F423246363045413036313731364141FA0670048A023030000000000000, endSession:true &destinationURL=https://192.168.10.100/magneflexdemo/cardpostback.aspx &requestLocation=false &passInData= ``` Return Value: The EMV ARPC response output in Hex string format of device raw response for this command.
ParameterDescription
errorCodeError status. 0 is Success. Non-Zero is an error.
errorMessageDescription of the errorCode.
opType

The type of operation. For this command the value is:

EMV_TRANS_RESULT

batchDataBatch data from the device to be passed to MagneFlex.
passInDataOptional data to send to MagneFlex. This data will be passed back to the web app.
Example: #### requestPIN (PinPad Only) This query string instructs the device to prompt for a PIN. ``` ?operation= &httpMethod= &closeDeviceAfter= &readerArgument= &destinationURL= &requestLocation= &passInData= ```
ParameterDescription
operation

Operation to request from MagneFlex. Use:

requestPIN

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

Data to send for the device to be passed to MagneFlex. Arguments:

timeLimit:, fieldseparator:, pinOption:, maxpinlength:, minpinlength:, tone:,

pinmode:, endSession:

Argument details:

timeLimit - Seconds to wait before the operation times out. Value is in hexadecimal format.

(1 - 255)

fieldseparator - Delimiter to separate the output data.

pinOption - PIN verification and format:

0 = ISO0 Format, No verify PIN

1 = ISO3 Format, No verify PIN

2 = ISO0 Format, Verify PIN

3 = ISO3 Format, Verify PIN

maxpinlength – Max PIN length in hexadecimal format. (<= 0C)

minpinlength – Min PIN length in hexadecimal format. (>= 04)

tone – Beep behavior of prompt:

0 = None

1 = Single beep

2 = Double beep

pinmode - Message to display as a user prompt:

0 = PINMsgEnterPIN

1 = PINMsgEnterPINAmt

2 = PINMsgReenterPINAmt

3 = PINMsgReenterPIN

4 = PINMsgVerifyPIN

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.

destinationURLMagneFlex 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

passInDataOptional 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=requestPIN &httpMethod=GET &closeDeviceAfter=true &readerArgument= timeLimit:3C, fieldseparator:|, pinOption:00, maxpinlength:0C, minpinlength:04, pinmode:00, endSession:true &destinationURL=https://192.168.10.100/magneflexdemo/cardpostback.asp &requestLocation=false &passInData=testData ``` Return Value: The Response output in Hex string format of device raw response for this command.
ParameterDescription
errorCodeError status. 0 is Success. Non-Zero is an error.
errorMessageDescription of the errorCode.
opType

The type of operation. For this command the value is:

PIN_RESULT

operationStatusStatus of the operation.
pinEPBEncrypted PIN block.
pinKSNPIN KSN.
passInDataOptional data to send to MagneFlex. This data will be passed back to the web app.
Example: orMessage=OK\&opType=PIN\_RESULT\&operationStatus=00\&pinEPB=1098FF7ECABD1 1F3\&pinKSN=9A006300000001200010\&passInData=testData #### requestManualCard (PinPad Only) This query string instructions the device to prompt for a manual card entry. ``` &operation= &httpMethod= &closeDeviceAfter= &readerArgument= &destinationURL= &requestLocation= &passInData= ```
ParameterDescription
operation

Operation to request from MagneFlex. Use:

requestManualCard

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

Data to send for the device 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 - This is an ORed combination of flags that changes the device’s data entry request behavior. Value is decimal equivalent of the binary value.

Bits 0 and 1

0 = Acct,Date,CVC

1 = Acct,Date

2 = Acct,CVC

3 = Acct

Bit 2

1=Use Qwick Codes entry

Bit 3

1=Use PAN in PIN block creation

Bit 4

0=Use PAN min 9, max 19

1=Use PAN min 14, max 21

tone – Beep behavior of prompt:

0 = None

1 = Single beep

2 = Double beep

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.

destinationURLMagneFlex 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

passInDataOptional 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=requestManualCard &httpMethod=GET &closeDeviceAfter=true &readerArgument= timeLimit:3C, option:8, tone:00, endSession:true &destinationURL=https://192.168.10.100/magneflexdemo/cardpostback.aspx &requestLocation=false &passInData= ``` Return Value: The CardSwipe output in TVL format.
ParameterDescription
errorCodeError status. 0 is Success. Non-Zero is an error.
errorMessageDescription of the errorCode.
opType

The type of operation. For this command the value is:

CARD_MANUAL_SWIPE

cardDataInManual card entry data in TLV format.
passInDataOptional data to send to MagneFlex. This data will be passed back to the web app.
Example: ENTRY/^22220000000000000000DFDF3913;1111000004000001111=2222000000000 0000?DFDF3B00DFDF3C00DFDF430400000000DFDF500A9500030000000120000C\&pass InData= #### requestSendCommand (PinPad Only) This query string sends a command to the device and returns the raw response from the device. ``` &httpMethod= &closeDeviceAfter= &readerArgument= &destinationURL= &requestLocation= &passInData= ```
ParameterDescription
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.

destinationURLMagneFlex 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

passInDataOptional 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=testData ``` Return Value: The Command response output in TVL format.
ParameterDescription
errorCodeError status. 0 is Success. Non-Zero is an error.
errorMessageDescription of the errorCode.
opType

The type of operation. For this command the value is:

SEND_COMMAND_RESULT

commandIDCommand that was sent.
commandResultData returned from the command sent to the device.
passInDataOptional data to send to MagneFlex. This data will be passed back to the web app.
Example: #### requestSignature (PinPad Only) This query string instructions the device to prompt for a Signature. ``` ?operation= &httpMethod= &closeDeviceAfter= &readerArgument= &destinationURL= &requestLocation= &passInData= ```
ParameterDescription
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.

destinationURLMagneFlex 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

passInDataOptional 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=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 ``` Return Value: The Signature capture output in TVL format.
ParameterDescription
errorCodeError status. 0 is Success. Non-Zero is an error.
errorMessageDescription of the errorCode.
opType

The type of operation. For this command the value is:

SIGNATURE_RESULT

signatureDataInSignature data from the device in hexadecimal format.
signatureResultResult of the signature capture.
passInDataOptional data to send to MagneFlex. This data will be passed back to the web app.
Example: data ### requestData (MICR Only) This query string retrieves data from user interaction with the device. ``` ?operation= &httpMethod= &customDisplayMessage= &closeDeviceAfter= &readerArgument= &destinationURL= &requestLocation= &passInData= ```
ParameterDescription
operation

Operation to request from MagneFlex. Use:

requestData

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.

customDisplayMessageMessage to display within the browser to instruct user interaction (iOS only).
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:

Argument details:

timeLimit - Seconds the device will wait for the user to complete the operation in hexadecimal.

(1 - 255)

destinationURLMagneFlex 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

passInDataOptional 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=requestData &httpMethod=GET &customDisplayMessage=Please Swipe Card or Scan a Check &closeDeviceAfter=true &readerArgument= timeLimit:3C &destinationURL=https://192.168.10.100/magneflexdemo/cardpostback.aspx &requestLocation=false &passInData=testData ``` Return Value: The Command response output in TVL format.
ParameterDescription
errorCodeError status. 0 is Success. Non-Zero is an error.
errorMessageDescription of the errorCode.
opType

The type of operation. For this command the value is:

REQUEST_DATA_RESULT

dataResponseData received from the device.
passInDataOptional data to send to MagneFlex. This data will be passed back to the web app.
Example: ``` https://192.168.10.100/magneflexdemo/cardpostback.aspx?errorCode=0&errorMessage=OK&opType=REQUEST_DATA_RESULT&dataResponse= %B5999991234567891^MAGTEK/TEST ^21042011000000819000000?;5999991234567891=210420110000819?<13> &passInData=testdata ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.magtek.com/hardware/card-readers/magnetic-stripe-readers/idynamo-5-gen-iii/documentation/developers-manuals/magneflex-browser-programmers-reference/magneflex-browser-web-api-resources/web-api-resources-part-2.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.