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=Parameter
Description
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.
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:
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:
https://192.168.10.100/magneflexdemo/cardpostback.aspx?errorCode=0&errorMessage=OK&opType=EMV_TRANS_RESULT&batchData=01023FF982023BDFDF540A00000000000000000000DFDF550182DFDF250F423246363045413036313731364141FA820211F082020DF105DFDF1A0100F8820176DFDF5982015888F3F2E7838F9B729FFED8D0866CB9C6CD06DC850B071ABF5184CFE9923B3F830D1BA6924B039DA9E75C8E717F9E0E95E45AC87A7BD94911F7E96CAE81E8A444F144714FF34B2C20E2F18D89D0616DBE355D808493488E2206273914A37833495A8C69DDEA90F182061CD7E7E416C20FBD260348389EAD6AFFBC0A0FD81BBE2E0D1FC2CF65195E1A79EC73264941D8F42BC5CD6837B9CCD267BD1FD5C37A9352AAEB1A1346E6C9C18ACA9CB01156C12411759091146357A87A39F1B3FB415EFDAA48509E9A25003E54E87616F63F04C2484261B3A765E23AB7176FF6C1B08D8BFD23B6884835620BB175E366A54232598028FF24998186BAA0590B92DCF336623F881D66379219C535DA2721E77ECBA8ADF8675BE0B9C8AC56CC5A52B9FD8216A43EA43B2B7CE7D22E911AB107566A8F79A103677F16681DD811852332CFB92D313ECC851C36E6317E087C3AAD65D3CDBDD36C97F9252770DFDF560A9010010B2F60EA0001C3DFDF570180DFDF580106F78200885F25031606235F24031806305F2A0208409F02060000000009999F03060000000000009F0607A00000000410109F1C0831313232333334349F3901059C01009F34031E03005F20164D4153544552434152442F4155544F4D4154494F4E49DFDF4D263B353535353030303032303030343434343D313830363230313030303030303030303030303F0011223344&passInData=
requestPIN (PinPad Only)
This query string instructs the device to prompt for a PIN.
Parameter
Description
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 ‘,’.
Return Value:
The Response output in Hex string format of device raw response for this command.
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:
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:
https://192.168.10.100/magneflexdemo/cardpostback.aspx?errorCode=0&err 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.
Parameter
Description
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.
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:
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:
https://192.168.10.100/magneflexdemo/cardpostback.aspx?errorCode=0&errorMessage=OK&opType=CARD_MANUAL_SWIPE&cardDataIn=FA81EBDFDF251039384446323041393034313230423045F481D4DFDF30020000DFDF3139254D313131313030303030343030303030313131315E4D414E55414C20454E5452592F5E32323232303030303030303030303030303030303FDFDF32020000DFDF33273B313131313030303030343030303030313131313D32323232303030303030303030303030303FDFDF34020100DFDF3500DFDF371C%M1111000004000001111^MANUAL 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.
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:
Return 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:
https://192.168.10.100/magneflexdemo/cardpostback.aspx?errorCode=0&errorMessage=OK&opType=SEND_COMMAND_RESULT&commandID=070501&commandResult=270000401F3F12006034F70080F8FFFF6034F70080F8FFFF70E6530F80FAFFFF20F3440D80FAFFFF287EF40080F8FFFF10B4480D80FAFFFF78B4480D80FAFFFF80B4480D80FAFFFF0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000&passInData=testdata
requestSignature (PinPad Only)
This query string instructions the device to prompt for a Signature.
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:
https://192.168.10.100/magneflexdemo/cardpostback.aspx,Data=opType=SIGNATURE_RESULT&signatureDataIn=283E293F29402B422B442C462E4B2F4F30513257335A345D346035633769376B386D386E386F376C376937663663365F36573653374F384B39473A443C413E3F403D463A493A4D3B513C553E58406046684D6B506E547057725B7361736473666F696C6A696A656A60695C68FFFF8E629063916392639264936494649564FFFF813882388337853787378A378B368D3690369236953599359C34A333A732AB32B230B62FB92FBD2EC02DC62CC82CFFFFA827A828A929AA2AAA2BAB2CAD2FAE31AF35B037B138B23BB33EB542B748B84CB852B855B75AB65CB55EB05FAE60AA5FA75EA35DFFFFD156CF54CE53CD52CC51CB4FC94EC64BFFFF&signatureResult=0&passInData=test data
requestData (MICR Only)
This query string retrieves data from user interaction with the device.
Parameter
Description
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.
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:
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