Skip to main content

Read Card

Limited functionality

This request is only available on the APOLLO terminal family.

HeaderLengthData
0x410x04+4 Bytes: Session Reference Number

0x00000000 - 0xFFFFFFFF
1 Byte: Length of DOL List
If length is set to 0x00, default DOL tags will be used.
'n' Length: List of tags for which data will be sent (if present): e.g. DFF006DFCA0BDFCA09DFF002DFF003DFCA03
1 Byte: Supported Payment Methods
For more information, please see below. When absent, all cards are allowed. To accept all cards, enter 1 Byte set to 0x00 or 0xFF.

If this is used, all above fields must be present.
Max 64 Bytes: Custom logo
NULL terminated string of the file name of the logo to be used, without file extention (eg. Custom_Logo_1). Files can be loaded to the terminal using asset loading in MyPayter.com. Showing of the logo is only allowed if emv cards are disabled (Setting “Supported Payment Methods” to have bit 0x02 set to 0). To set the default logo enter 1 Byte, set to 0x00.

If this field is used, all above fields must be present.
Max 4279 Bytes: QR code url to be shown at the payment screen.
NULL terminated string. For example: “www.payter.com”. To not set the QR code enter 1 Byte, set to 0x00.

If this field is used, all above fields must be present.
64 Bytes: Override Session Reference Number with a string.
NULL terminated string version of Session reference. If this field is used the previous Session reference number will be overridden. Entering 1 Byte, set to 0x00 will retain and use the previously declared Session Reference Number.

If this field is used, all above fields must be present.
64 Bytes: Second Session Reference String.
NULL terminated string. This is a second reference string that can be added to the session. To not set the second Session Reference enter 1 Byte, set to 0x00.

If this field is used, all above fields must be present.
128 Bytes: Present Card Message.
Set the present card message to display.To use the default Present Card Message, enter 1 Byte, set to 0x00.

If this field is used, all above fields must be present.
1 Byte: Card Read Type.
Select the card read type.

0x00Default
0x01Transit

If this field is used, all above fields must be present.
128 Bytes: Present Card Title. Set the present card title to display.

If this field is used, all above fields must be present.
Supported Payment Methods

The supported payment methods can be defined bitwise:

  • 0x01: Proprietary Cards
  • 0x02: EMV Cards
  • 0x04: QR-Code
  • 0xFF: All cards

Example 0x05 = Proprietary Cards AND QR-Code

Usage

This command is used to extract data from a card. The session reference number is a free field and can be used to send a tracking number that will appear in the back office reporting of the terminal. A Read Card can not go online. Sending an Auth after a Read Card will result in the same behaviour as sending a Cancel Session. It will drop the card and return to the Enabled state.

Response

Card Read, Proprietary Card Read, Result (Not OK)