MagneFlex Browser WEB API Resources
requestCardSwipe
This query string instructs the device to prompt for a card swipe.
?operation= &httpMethod= &closeDeviceAfter= &readerArgument= &destinationURL= &requestLocation= &passInData=operation
Operation to request from MagneFlex. Use: requestCardSwipe
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. requestCardSwipe requires no arguments.
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 application.
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=requestCardSwipe
&httpMethod=GET &closeDeviceAfter=true
&readerArgument= &destinationURL=https://192.168.10.100/magneflexdemo/cardpostback.aspx &requestLocation=false
&passInData=Return Value:
The CardSwipe output in TVL format.
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: CARD_SWIPE_RESULT
cardDataIn
Magnetic swipe card data in TLV format. FA (Container for generic data) DFDF25 (Device serial number) F4 (Container for Encrypted MSR data) DFDF30 (Masked T1 status) DFDF31 (Masked T1) DFDF32 (Masked T2 status) DFDF33 (Masked T2) DFDF34 (Masked T3 status) DFDF35 (Masked T3) DFDF37 (Encrypted T1) DFDF39 (Encrypted T2) DFDF3B (Encrypted T3) DFDF3C (Encrypted MagnePrint) DFDF43 (MagnePrint Status) DFDF50 (MSR KSN)
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
requestSendCommand
This query string sends a command to the device and returns the raw response from the device.
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:, endSession: Argument details: timeLimit - Seconds to wait before the operation times out. Value is in hexadecimal format. (00 - FF) command - The command 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.
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 Command response output in Hex string format of device raw response for this command.
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:
requestSendExtendedCommand
This query string sends an extended command to the device and returns the raw response from the device.
operation
Operation to request from MagneFlex. Use: requestSendExtendedCommand
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
Extended command to send to reader.
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 Extended Command response output in Hex string format of device raw response for this command.
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_EXTENDED_COMMAND_RESULT
commandID
Command that was sent.
commandResult
Result of a command sent to the device.
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
requestSendBatchCommand (Reserved for Future Use)
This query string sends a batch of commands to the device and returns the raw response from the device.
operation
Operation to request from MagneFlex. Use: requestSendBatchCommand
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.
readerArgument
Batch of commands that should be sent to reader. Commands are delimited by the bar character |. Example: readerArgument=0900|000100|1500
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 ,.
Return Value:
The Batch Command response output in Hex string format of device raw response for this command.
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_BATCH_COMMAND_RESULT
commandResult
Result of a command sent to the device formatted as: [command]-[result] For each command sent in a batch is returned a separate commandResult. Example: &commandResult=0900-000A9010010B355414000099 &commandResult=000100-000D31303030303033333534433033 &commandResult=1500-000103
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
requestStartEMVTransaction (EMV Only)
This query string begins an EMV transaction.
operation
Operation to request from MagneFlex. Use: requestStartEMVTransaction
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. For requestStartEMVTransaction use: false – do not close the device
readerArgument
Comma delimited list of arguments to be passed to MagneFlex. Arguments: timeLimit:, cardType:, option:, amount:, transactionType:, cashBack:, currencyCode:, endSession:, quickChipMode:, reserved: Argument details: timeLimit - Seconds the operation times out. Value is in hexadecimal format. (00 - FF) transactionType - Type of transaction to be used in hexadecimal: 00 = Purchase (listed as “Payment” on ICS) 01 = Cash Advance (not supported for this reader) 02 or 09 = Cash back (09 not supported, contactless) 04 = Goods (Purchase) 08 = Services (Purchase) 10 = International Goods (Purchase) 20 = Refund 40 = International Cash Advance or Cash Back 80 = Domestic Cash Advance or Cash Back cardType - Card type that can be used for the transaction: 1 = Magnetic stripe 2 = Contact smart card 3 = Magnetic stripe or contact smart card amount - The amount to be used and authorized, EMV Tag 9F02. Format in decimal. cashBack - Amount of cash back to be used, EMV Tag 9F02. Format in decimal. currencyCode - Transaction Currency Code (EMV Tag 5F2A, format n4 string) Sample valid values: 0840 = US Dollar 0978 = Euro 0826 = UK Pound endSession - Flag to end the session for the device. Default value is true. quickChipMode - Flag to start the transaction to accommodate qwick Chip mode. “true” = Accommodate qwick chip mode. “false” = Do not accommodate qwick chip mode. reserved - These are the reserved bytes beginning at index 20 of the 0xA2 command. Reference device manual D99875585 for more details. Example: 0000000000000000000000000840000100 – QuickDip Mode 0000000000000000000000000840000003 – PIN Verify 0000000000000000000000000840000004 – PIN Set
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 EMV ARQC response output in Hex string format of device raw response for this command.
errorCode
Error status. This parameter is only available when the status is not successful.
errorMessage
Description of the errorCode. This parameter is only available when the status is not successful.
opType
The type of operation. For this command the value is: EMV_ARQC_RESULT
arqcData
ARQC data from the device.
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
sendARPC (EMV Only)
This query string sends the ARPC to the device during an EMV transaction.
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.
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 EMV ARPC response output in Hex string format of device raw response for this command.
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: EMV_TRANS_RESULT
batchData
Batch data from the device to be passed to MagneFlex.
passInData
Optional 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
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.
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 Response output in Hex string format of device raw response for this command.
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: PIN_RESULT
operationStatus
Status of the operation.
pinEPB
Encrypted PIN block.
pinKSN
PIN KSN.
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
requestManualCard (PinPad Only)
This query string instructions the device to prompt for a manual card entry.
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.
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 CardSwipe output in TVL format.
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: CARD_MANUAL_SWIPE
cardDataIn
Manual card entry data in TLV format.
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
requestSendCommand (PinPad Only)
This query string sends a command to the device and returns the raw response from the device.
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:
Return Value:
The Command response output in TVL format.
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:
requestSignature (PinPad Only)
This query string instructions the device to prompt for a Signature.
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.
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:
requestData (MICR Only)
This query string retrieves data from user interaction with the device.
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.
customDisplayMessage
Message 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)
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 Command response output in TVL format.
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: REQUEST_DATA_RESULT
dataResponse
Data received from the device.
passInData
Optional data to send to MagneFlex. This data will be passed back to the web app.
Example:
Last updated