dpySCM Namespace Reference

Deepsy SCM namespace that includes the different enums, structs or method signatures that should be used.

Classes

struct  ApduRxData
 APDU RX exchange command. More...
 
struct  ApduTxData
 APDU TX exchange command. More...
 
struct  CardEvent
 The kind of event and the card information. More...
 
struct  CardInfo
 All the data related to the new card event information. More...
 
struct  CardOperation
 All data card structure. More...
 
struct  ChargeConfirmation
 Confirmation charge. More...
 
struct  ChargeResult
 The result of the charge request. More...
 
struct  Command
 Structure used to send commands (input) in raw data form and store the response (output) More...
 
struct  Data
 A simple card operation. More...
 
struct  DataBlock
 DataBlock structure. More...
 
struct  Device
 All the date related to the device information. More...
 
struct  DeviceChargeConfirmation
 Device confirmation charge. More...
 
struct  DeviceChargeResult
 Device charge result. More...
 
struct  DeviceDateTime
 DateTime struct which contains the response received from the service. More...
 
struct  DeviceKeys
 Add Keys. More...
 
struct  DeviceMediaProfiles
 Device media profiles. More...
 
struct  DeviceNetworkConfiguration
 The device network configuration. More...
 
struct  DeviceNetworkConnectivity
 Contains the network address to be tested on that device. More...
 
struct  DeviceNetworkStatus
 The status of the network connectivity. More...
 
struct  DevicePassThrough
 Device pass through. More...
 
struct  DevicePaymentAppConfiguration
 Device payment terminal configuration. More...
 
struct  DevicePaymentAppInfo
 Device payment application information. More...
 
struct  DevicePaymentAppStatus
 Device payment application information. More...
 
struct  DevicePciRebootTime
 Device PCI Reboot Time. More...
 
struct  DevicePlayProfile
 Device play profile. More...
 
struct  DeviceReaderList
 List of readers. More...
 
struct  DeviceRequestCharge
 Device request of charging. More...
 
struct  DeviceUpgradeStatus
 Device upgrade status. More...
 
struct  DeviceVersion
 Device full version. More...
 
struct  ForceConnection
 Force the connection of the smart reader with its payment gateway. More...
 
struct  Key
 A structure to store keys. More...
 
struct  KeyGroup
 Key group. More...
 
struct  Led
 Structure defining LED parameters. More...
 
struct  LedGroupState
 Structure defining a group of LEDs inside a media profile. More...
 
struct  LoggingConfiguration
 The Logging Configuration to be applied or being applied. More...
 
struct  MediaProfile
 Media profile which contains information about the. More...
 
struct  NetworkConfiguration
 Netowrk Configuration. More...
 
struct  PassThrough
 Structure containing information needed to execute a pass through. More...
 
struct  PaymentAppConfiguration
 Relation between the property and its value. More...
 
struct  PaymentAppConfigurations
 List of property configurations. More...
 
struct  PaymentAppInfo
 It contains the information related to get the Payment Application information. More...
 
struct  PaymentAppStatus
 It contains the information related to set the Payment Application configuration. More...
 
struct  PlayProfile
 Play profile. More...
 
struct  Reader
 All the date related to the reader information. More...
 
struct  RequestCharge
 Request of charging to a smart card. More...
 
struct  Sound
 Structure defining a sound inside a media profile. More...
 
struct  StorageKeys
 A structure to fix the authentication keys. More...
 
struct  TransactionDevice
 Transaction operation device. More...
 
struct  TransferFile
 Basic information for transferring a file through the network. More...
 
struct  UltraLightCounter
 Structure for UltraLight counter requests. More...
 
struct  Version
 Basic information for get the version. More...
 

Typedefs

typedef boost::function< void(const bool &available)> service_availability_handler
 Prototype of the handler function used to monitor service availability. More...
 
typedef boost::function< void(boost::system::error_code &ec, const dpySCM::Device &rDevice)> get_devices_handler_function
 Handler for status function callback. More...
 
typedef boost::function< void(boost::system::error_code &ec, const dpySCM::DeviceReaderList &rReader)> get_readers_handler_function
 Result of getting readers information.
 
typedef boost::function< void(boost::system::error_code &ec, const std::string &deviceId, dpySCM::CardEvent cardEvent)> handler_cardEvent_function
 Result of new card event.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceChargeResult deviceChargeResult)> handler_device_charge_result_function
 Result of device charge EMV result.
 
typedef boost::function< void(boost::system::error_code &ec, const std::string &deviceId, dpySCM::Event deviceEvent)> handler_deviceListEvent_function
 Result of added/removed device event.
 
typedef boost::function< void(boost::system::error_code &ec)> confirmation_handler_function
 Result of confirmation operation.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceKeys deviceKeys)> get_keys_handler_function
 Result of getting keys information.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::TransactionDevice TransactionDevice)> card_operation_handler_function
 Result of card operation.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DevicePassThrough devicePassThrough)> pass_through_operation_handler_function
 Result of pass through operation.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceVersion &deviceVersion)> device_version_handler_function
 Result of get version.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DevicePaymentAppInfo &devicePaymentAppInfo)> device_payment_app_info_function
 Result of get device payment application info.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceMediaProfiles &deviceMediaProfiles)> device_media_profiles_function
 Result of get media profiles.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceUpgradeStatus &deviceUpgradeStatus)> upgrade_status_events_function
 Result of every upgrade status event.
 
typedef boost::function< void(boost::system::error_code &ec, const std::string &deviceId)> force_device_upgrade_function
 Result of force device upgrade request.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DevicePciRebootTime &devicePciRebootTime)> reboot_time_handler_function
 Result of getting PCI Data Security Standard reboot time.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::UltraLightCounter &ulCounter)> ultralight_counter_handler_function
 Result of getting a ultralight counter value.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceNetworkConfiguration &deviceNetworkConfiguration)> device_network_configuration_handler_function
 Result of get network configuration.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DevicePaymentAppConfiguration &devicePaymentAppConf)> device_payment_app_conf_function
 Result of get device payment application configuration.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceDateTime &dateTime)> device_date_time_handler_function
 Result of get network configuration.
 
typedef boost::function< void(boost::system::error_code &ec, dpySCM::DeviceNetworkStatus &deviceNetworkStatus)> network_status_handler_function
 Result of testing network connectivity.
 
typedef boost::function< void(boost::system::error_code &ec, const std::string &deviceId, dpySCM::LoggingConfiguration &loggingConfiguration)> get_logging_configuration_handler_function
 Result of getting logging configuration.
 

Enumerations

enum  Action {
  BOOT = 0, ACTIVE = 1, STANDBY = 2, SLEEP = 3,
  DEEP_SLEEP = 4, HIBERNATE = 5, REBOOT = 6, OFF = 7
}
 Power action events. More...
 
enum  CardType {
  DEFAULT_CARD = 0, MIFARE_1K = 1, MIFARE_4K = 2, MIFARE_UL_EV1 = 3,
  MIFARE_UL_C = 4, MIFARE_DES = 5, MIFARE_MINI = 6, MIFARE_PLUS = 7,
  FELICA = 8, CALYPSO = 9, CTS512B = 10, CTS256B = 11,
  SRT_512 = 12, SRI_512 = 13, EMV = 14, SAM = 15
}
 Available card types. More...
 
enum  KeyType { DEFAULT_KEY = 0, KEY_A = 1, KEY_B = 2 }
 Keys types. More...
 
enum  OperationType {
  DEFAULT_OP = 0, AUTH = 1, READ = 2, WRITE = 3,
  APDU = 4, TRANSFER = 5, RESTORE = 6, INCREMENT = 7,
  DECREMENT = 8, INCREMENT_ONLY = 9, DECREMENT_ONLY = 10
}
 Different types of operation. More...
 
enum  Event { ADDED = 0, REMOVED = 1 }
 The type of event related to the smart card. More...
 
enum  WorkMode { NA_MODE = 0, DISABLE_GW = 1, REDSYS_GW = 2 }
 Work mode indicator, it defines which configuration is been used. More...
 
enum  AppStatus { NA_STATUS = 0, PA_ENABLE = 1, PA_DISABLE = 2 }
 Payment Application status. More...
 
enum  FunctionalityIndicator {
  NA_INDICATOR = 0, IDLE = 1, NOT_AVAILABLE = 2, NOT_INITIALISED = 3,
  NO_KEYS = 4, TERMINAL_BROKEN = 5, NO_COMMUNICATIONS = 6
}
 Functionality indicator. More...
 
enum  Property {
  NA_PROPERTY = 0, ACCESS_POINT_CODE = 1, ACCESS_POINT_TYPE = 2, TRANSPORT_OPERATOR_ID = 3,
  PRICING_PLAN = 4, ONLINE_MODE = 5, OFFLINE_MODE = 6, OFFLINE_BACKUP = 7,
  PRICE = 8, TRANSACTION_MODE_CONF = 9, END_OF_DAY_TIME = 10, BLACKLIST = 11,
  BLACK_LIST_UPDATE_TIMER = 12, BLACK_LIST_UPDATE_RETRIES = 13, BLACK_LIST_TIME_WITHOUT_UPDATES = 14, FINANCIAL_BLACK_LIST = 15,
  WHITE_LIST = 16, ODA_CARDS = 17, PASSBACK_TIMER = 18, PASSBACK_NUMBER = 19,
  LANGUAGE = 20, DESTINATION_MODE = 21, ROUTE = 22, TRANSPORT_ZONE = 23,
  STOP = 24, EMPLOYEE_ID = 25, VEHICLE = 26, EXTRA = 27
}
 It defines the basic setting for the transport operator. More...
 
enum  TicketMode { NA_TICKET = 0, DISABLE_TICKET = 1, CLIENT_TICKET = 2, BOTH_TICKETS = 3 }
 Ticket printing configurations. More...
 
enum  SolutionCode { NA_SOLUTION = 0, TRANSACTION_AUTHORIZED = 1, TRANSACTION_DENIED = 2, UNKOWN_SOLUTION = 3 }
 Solution code for the reuslt of the operation. More...
 
enum  RequestType {
  NA_REQUEST = 0, SALE = 1, FULL_OVERVIEW = 2, COUNTABLE_CLOSING = 4,
  GENERAL_OPERATION_DETAIL = 5, PARTICULAR_OPERATION_DETAIL = 6, PRINT_LOCAL_COPY = 7, PRINT_LAST_ONLINE_COPY = 8,
  PRINT_AN_ONLINE_COPY = 9, TRADE_ALLOCATION = 10, ECO_QUERY = 11
}
 Type of request. More...
 
enum  ProductTypeId {
  NA_PRODUCT = 0, DEBIT = 1, CREDIT = 2, COMMERCIAL = 3,
  PREPAID = 4, PRIVATE = 5, UNKONW_PRODUCT = 6
}
 Product type identifier. More...
 
enum  TechTypeId {
  NA_TECH = 0, CONTACTLESS_EMV_CARD = 1, CONTACTLESS_EMV_NFC = 2, CONTACTLESS_BAND = 3,
  CONTACTLESS_BAND_NFC = 4, CONTACT_EMV = 5, MAGNETIC_BAND = 6, UNKOWN_TECH = 7
}
 Identifier for the technology type of the payment application. More...
 
enum  State {
  IDLE_STATE = 0, DOWNLOADING_UPDATES = 1, UPDATE_DOWNLOADED = 2, PREPARED_TO_INSTALL = 3,
  INSTALLING = 4, UPDATE_INSTALLED = 5, INSTALLING_ROLLBACK_PACKAGE = 6, ROLLBACK_DONE = 7
}
 The different types of upgrade events. More...
 
enum  UpdateState {
  STATE_IDLE = 0, STATE_UPDATING = 1, STATE_WAIT_ROLLBACK = 2, STATE_TRANSFERRING = 3,
  STATE_ROLLING_BACK = 4, STATE_INSTALLING = 5, STATE_FINISHING = 6
}
 Defines the UPDATE STATES. More...
 
enum  LedId {
  NA_LED = 0, LED1 = 1, LED2 = 2, LED3 = 3,
  LED4 = 4, LED5 = 5, LED6 = 6, LED7 = 7,
  LED8 = 8, LED9 = 9, LED10 = 10, LEDLOGO1 = 11
}
 Led identifier. More...
 
enum  LedColor {
  NA_COLOR = 0, WHITE = 1, RED = 2, BLUE = 3,
  GREEN = 4, MAGENTA = 5, YELLOW = 6, CYAN = 7
}
 Led color. More...
 
enum  RebootType { SOFT = 0, HARD = 1 }
 Reboot type, it defines different reboot types. More...
 
enum  Component {
  NONE = 0, ALL = 1, CONFIGURATION = 2, LIBPAP_EMV = 3,
  TRANSPORT_NFC = 4, SAM_READER = 5, SYSTEM = 6, UPDATES = 7,
  SERVER = 8
}
 Defines the type of components or applications inside the SCM device. More...
 
enum  LogLevel { DEBUG = 0, INFO = 1, WARN = 2, ERROR = 3 }
 Logging Level values indicating severity of the logs. More...
 
enum  SamSlot {
  ALL_SAMS = 0, FIRST = 1, SECOND = 2, THIRD = 3,
  FOURTH = 4
}
 Logging Level values indicating severity of the logs. More...
 

Typedef Documentation

typedef boost::function<void(boost::system::error_code& ec, const dpySCM::Device& rDevice)> get_devices_handler_function

This type of function is called when the status callback is done.

Parameters
error_codeerror code (if any)
infovector with the status of the processesResult of getting devices information.
typedef boost::function<void(const bool &available)> service_availability_handler
Parameters
availabletrue if the service is available, false otherwise

Enumeration Type Documentation

enum Action
Enumerator
BOOT 

Boot device.

ACTIVE 

Active.

STANDBY 

Standby.

SLEEP 

Sleep.

DEEP_SLEEP 

Deep sleep.

HIBERNATE 

Hibernate.

REBOOT 

Reboot.

OFF 

Shutdown.

enum AppStatus
Enumerator
NA_STATUS 

Not available.

PA_ENABLE 

Enable Payment application.

PA_DISABLE 

Disable Payment application.

enum CardType
Enumerator
DEFAULT_CARD 

Default value.

MIFARE_1K 

Mifare 1K.

MIFARE_4K 

Mifare 4K.

MIFARE_UL_EV1 

Mifare ultra light EV1.

MIFARE_UL_C 

Mifare ultra light C.

MIFARE_DES 

Mifare desfire.

MIFARE_MINI 

Mifare mini.

MIFARE_PLUS 

Mifare plus.

FELICA 

Felica.

CALYPSO 

Calypso.

CTS512B 

CTS512B.

CTS256B 

CTS256B.

SRT_512 

SRT_512.

SRI_512 

SRI_512.

EMV 

EMV.

SAM 

SAM.

enum Component
Enumerator
NONE 

None of the components/applications.

ALL 

All of the components/applications.

CONFIGURATION 

Configuration component.

LIBPAP_EMV 

Libpap emv component.

TRANSPORT_NFC 

Transport_nfc component.

SAM_READER 

Sam_reader component.

SYSTEM 

System component.

UPDATES 

Updates component.

SERVER 

Server component.

enum Event
Enumerator
ADDED 

ADDED or INSERTED.

REMOVED 

REMOVED.

Enumerator
NA_INDICATOR 

Not available.

IDLE 

The payment terminal is operational.

NOT_AVAILABLE 

The payment terminal is not operational.

NOT_INITIALISED 

The payment terminal has not been initialised.

NO_KEYS 

The payment terminal has no keys.

TERMINAL_BROKEN 

The payment terminal has some failure.

NO_COMMUNICATIONS 

The payment terminal has no GPRS signal or connectivity.

enum KeyType
Enumerator
DEFAULT_KEY 

Empty key.

KEY_A 

A type.

KEY_B 

B type.

enum LedColor
Enumerator
NA_COLOR 

NA_COLOR.

WHITE 

WHITE.

RED 

RED.

BLUE 

BLUE.

GREEN 

GREEN.

MAGENTA 

MAGENTA.

YELLOW 

YELLOW.

CYAN 

CYAN.

enum LedId
Enumerator
NA_LED 

NA_LED.

LED1 

LED1.

LED2 

LED2.

LED3 

LED3.

LED4 

LED4.

LED5 

LED5.

LED6 

LED6.

LED7 

LED7.

LED8 

LED8.

LED9 

LED9.

LED10 

LED10.

LEDLOGO1 

LEDLOGO1.

enum LogLevel
Enumerator
DEBUG 

Debug Logging Level.

INFO 

Info Logging Level.

WARN 

Warn Logging Level.

ERROR 

Error Logging Level.

Enumerator
DEFAULT_OP 

Unused value.

AUTH 

Authentication operation.

READ 

Read operation.

WRITE 

Write operation.

APDU 

Exchange APDU commands.

TRANSFER 

Transfer command.

RESTORE 

Restore command.

INCREMENT 

Increment command.

DECREMENT 

Decrement command.

INCREMENT_ONLY 

Increment command.

DECREMENT_ONLY 

Decrement command.

Enumerator
NA_PRODUCT 

Not available product.

DEBIT 

Debit card.

CREDIT 

Credit card.

COMMERCIAL 

Commercial card.

PREPAID 

Prepaid card.

PRIVATE 

Some private card.

UNKONW_PRODUCT 

No know product.

enum Property
Enumerator
NA_PROPERTY 

Not available.

ACCESS_POINT_CODE 

Access point code.

ACCESS_POINT_TYPE 

Access point type. Available values: "input", "output".

TRANSPORT_OPERATOR_ID 

Transport operator identifier.

PRICING_PLAN 

It indicates which pricing plan is configured. Available values: "variable-kft", "fix-kft", "pinpad", "0-mtt", "1-mtt".

ONLINE_MODE 

The terminal shall work in online mode. Available values: "on", "off".

OFFLINE_MODE 

The terminal shall work in offline mode. Available values: "on", "off".

OFFLINE_BACKUP 

The terminal shall work in offline mode the online mode fails. Available values: "on", "off".

PRICE 

Ticket price.

TRANSACTION_MODE_CONF 

Transaction mode configuration.

END_OF_DAY_TIME 

At which time it is made the shift change.

BLACKLIST 

Enable/disable blacklist. Available values: "on", "off".

BLACK_LIST_UPDATE_TIMER 

Timer in minutes for updating the black list in the payment terminal.

BLACK_LIST_UPDATE_RETRIES 

How much updating retries can be done before refusing bank cards.

BLACK_LIST_TIME_WITHOUT_UPDATES 

Number of hours without updating the black list.

FINANCIAL_BLACK_LIST 

Enable/disable financial blacklist. Available values: "on", "off".

WHITE_LIST 

Enable/disable white list. Available values: "on", "off".

ODA_CARDS 

Enable/disable ODA cards. Available values: "on", "off".

PASSBACK_TIMER 

Timer for counting the consecutive logins.

PASSBACK_NUMBER 

Maximum number of attempts that can be done with bank card.

LANGUAGE 

Terminal language. Available languages: "spanish", "catalan", "english", "french", "german", "italian", "portuguese", "galician", "basque", "valencian".

DESTINATION_MODE 

Destination mode configuration.

ROUTE 

It indicates the route which is done in the vehicle where is installed the payment terminal.

TRANSPORT_ZONE 

It indicates the zone where is the transport vehicle which has installed the payment terminal.

STOP 

It indicates the stop where is the transport vehicle which has installed the payment terminal.

EMPLOYEE_ID 

It indicates the employee id.

VEHICLE 

Vehicle id.

EXTRA 

Extra information, such us expedition.

enum RebootType

Reboot types.

Enumerator
SOFT 

Reboot only application.

HARD 

Reboot complete device.

Enumerator
NA_REQUEST 

Not available.

SALE 

Sale.

FULL_OVERVIEW 

Query for grand total.

COUNTABLE_CLOSING 

Query for countable closing.

GENERAL_OPERATION_DETAIL 

Query for detailing general operations.

PARTICULAR_OPERATION_DETAIL 

Query for detailing single operations.

PRINT_LOCAL_COPY 

Query for printing a local copy.

PRINT_LAST_ONLINE_COPY 

Query for printing the last online copy.

PRINT_AN_ONLINE_COPY 

Query for printing some online copy.

TRADE_ALLOCATION 

Query for assigning the trade allocation.

ECO_QUERY 

ECO query.

enum SamSlot
Enumerator
ALL_SAMS 

Reset all device slots.

FIRST 

Reset slot 1.

SECOND 

Reset slot 2.

THIRD 

Reset slot 3.

FOURTH 

Reset slot 4.

Enumerator
NA_SOLUTION 

Not available.

TRANSACTION_AUTHORIZED 

The transaction was authorized.

TRANSACTION_DENIED 

The transaction was refused.

UNKOWN_SOLUTION 

Unknow result.

enum State
Enumerator
IDLE_STATE 

IDLE_STATE.

DOWNLOADING_UPDATES 

DOWNLOADING_UPDATES.

UPDATE_DOWNLOADED 

UPDATE_DOWNLOADED.

PREPARED_TO_INSTALL 

PREPARED_TO_INSTALL.

INSTALLING 

INSTALLING.

UPDATE_INSTALLED 

UPDATE_INSTALLED.

INSTALLING_ROLLBACK_PACKAGE 

INSTALLING_ROLLBACK_PACKAGE.

ROLLBACK_DONE 

ROLLBACK_DONE.

enum TechTypeId
Enumerator
NA_TECH 

Not available technology.

CONTACTLESS_EMV_CARD 

EMV contactless card.

CONTACTLESS_EMV_NFC 

EMV NFC contactless card.

CONTACTLESS_BAND 

Banc contactless card.

CONTACTLESS_BAND_NFC 

Band NFC contactless card.

CONTACT_EMV 

EMV contact card.

MAGNETIC_BAND 

Magnetic band card.

UNKOWN_TECH 

No know technology.

enum TicketMode
Enumerator
NA_TICKET 

Not available.

DISABLE_TICKET 

The payment terminal must not generate operation ticket.

CLIENT_TICKET 

The payment terminal shall generate the client ticket.

BOTH_TICKETS 

The payment terminal shall generate the trade and client tickets.

Enumerator
STATE_IDLE 

State idle.

STATE_UPDATING 

State updating.

STATE_WAIT_ROLLBACK 

State wait rollback.

STATE_TRANSFERRING 

State transferring.

STATE_ROLLING_BACK 

State rolling back.

STATE_INSTALLING 

State installing.

STATE_FINISHING 

State rebooting.

enum WorkMode
Enumerator
NA_MODE 

Not available.

DISABLE_GW 

The payment terminal has not communication with Redsys.

REDSYS_GW 

The payment terminal has communications with Redsys.