Skip to main content

Application Development Kit (Version 4.7)


ped.h File Reference

Last updated: 25-Feb-2025
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define  CLA_PED   0x22
  Class for PED commands. More...
#define  INS_PED_ENABLE   0x00
  Enable or Disable PED. More...
#define  INS_PED_GET_PIN   0x01
  Request PIN from user. More...
#define  INS_SET_PIN_TIMEOUT   0x02
  Configure timeout for PIN entry. More...
#define  INS_PED_START_PIN   0x03
  Start PIN entry (polling interface) More...
#define  INS_PED_POLL_PIN   0x04
  Poll PIN entry status (polling interface) More...
#define  INS_PED_STOP_PIN   0x05
  Stop PIN entry (polling interface) More...
#define  INS_SET_PIN_INPUT_PARAM   0x06
  Configure PIN input parameter. More...

Functions

bool  handlePedCmd (unsigned short msgBufSize, unsigned char *msg, unsigned short msgSize, unsigned short rspBufSize, unsigned char *rsp, unsigned short *rspSize)
bool  pedSetExtButton (void)
void  pedReset (void *handle)

Macro Definition Documentation

◆ CLA_PED

#define CLA_PED   0x22

Class for PED commands.

◆ INS_PED_ENABLE

#define INS_PED_ENABLE   0x00

Enable or Disable PED.

◆ INS_PED_GET_PIN

#define INS_PED_GET_PIN   0x01

Request PIN from user.

◆ INS_PED_POLL_PIN

#define INS_PED_POLL_PIN   0x04

Poll PIN entry status (polling interface)

◆ INS_PED_START_PIN

#define INS_PED_START_PIN   0x03

Start PIN entry (polling interface)

◆ INS_PED_STOP_PIN

#define INS_PED_STOP_PIN   0x05

Stop PIN entry (polling interface)

◆ INS_SET_PIN_INPUT_PARAM

#define INS_SET_PIN_INPUT_PARAM   0x06

Configure PIN input parameter.

◆ INS_SET_PIN_TIMEOUT

#define INS_SET_PIN_TIMEOUT   0x02

Configure timeout for PIN entry.

Function Documentation

◆ handlePedCmd()

bool handlePedCmd ( unsigned short  msgBufSize,
unsigned char *  msg,
unsigned short  msgSize,
unsigned short  rspBufSize,
unsigned char *  rsp,
unsigned short *  rspSize 
)

Dispatch function to handle different PED commands

Parameters
[in] msgBufSize size of the input message buffer
[in] msg pointer to the input message buffer
[in] msgSize size of the input message
[in] rspBufSize maximum size of the response buffer
[in,out] rsp pointer to the response buffer
[in,out] rspSize pointer to the response message size
Returns
true if command was executed and rsp contains a response, false in case invocation is not allowed by a side command.

◆ pedReset()

void pedReset ( void *  handle )

Function invoked by a thread at connection termination to abort the PIN entry. SDI server supports multiple connections, which can use the PED interface. With activation of the PED interface with command 22-03 (Start PIN entry) on one connection, the interface is locked for other connections. If a connection terminates, which optains the PED lock, the interface would be unaccessable for other connections. Therfore, this function will abort the PIN entry and unlock the PED interface, if the connection disturbes so that it can be used by other connection again. Please note that this function works for a PIN Entry started by 22-03 (Start PIN entry). A PIN entry started with 22-01 (Get PIN) is not considered, but the PED lock is released after the user hast finished the PIN entry.

Parameters
[in] handle handle of the terminating connection

◆ pedSetExtButton()

bool pedSetExtButton ( void  )

Inform the VAULT about the Confirm button was pressed if PIN polling is active and Navigator Mode 2 is set

Returns
true if PIN polling is active and Navigator Mode 2 set, else false

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Verifone logo