Skip to main content

Start Session

HeaderLengthData
0x340x08+4 Bytes: Money to Reserve

0x00000000 - 0xFFFFFFFF
Options0x04+Session Reference Number

0x00000000 - 0xFFFFFFFF
0x01Length of DOL List. If length is set to 0x00, default DOL tags will be used.
'n'List of tags for which data will be sent (if present): e.g. DFF006DFCA0BDFCA09DFF002DFF003DFCA03
All of the fields below are Apollo Only
0x01Supported 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 0x40Custom 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.
0x01Do not show amount of money to reserve. If this field is nonzero no amount of money will be displayed when starting a session (when absent the amount will be displayed).

If this field is used, all above fields must be present.
Max 0x10C9QR 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.
Max 0x40Override 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.
Max 0x40Second 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.
0x01Transaction Type. Set the transaction type. For more information, please see below. To not se the transaction type and use the default value, use 0x00.

If this field is used, all above fields must be present.
Max 0x80Present 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.
0x01Authorize options for open loop (EMV). Set to approve without going online in certain scenarios. For more information, please see below. To use the default Authorize options, enter 1 Byte, set to 0x00.

If this field is used, all above fields must be present.
0x01Authorize options for closed loop (CUG). Set to approve without going online in certain scenarios. For more information, please see below. To use the default Authorize options, enter 1 Byte, set to 0x00.

If this field is used, all above fields must be present.
Max 0x80Present 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:

  • 0x00: Default. EMV & proprietary cards are supported if they are enabled in the configuration of the terminal
  • 0x01: Proprietary Cards
  • 0x02: EMV Cards
  • 0x04: QR-Code
  • 0xFF: EMV, proprietary, and QR supported if they are enabled in the configuration of the terminal.

Example 0x05 = Proprietary Cards AND QR-Code

Transaction Types

The supported transaction types can be defined as either:

  • 0x00: Not specified (Get from mypayter setting)
  • 0x01: Payment
  • 0x02: Deferred Payment
  • 0x03: Pre-Authorization
Authorize Options

The supported Authorize options can be defined as either:

  • 0x00: Not specified (Get from mypayter setting)
  • 0x01: Authorize Online (default)
  • 0x02: Stand-in, always approve valid cards.
  • 0x03: Stand-in on no connection, approve valid cards only when there is no connection.

These settings apply to both Open (EMV) and Closed (Closed User Group) cards.

Usage

This command begins a session; A request to capture a card for the stated amount, which indicates the reserved money for which the customer can buy products. 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.

Response

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