Events

didConnect

didConnect Method

Called when a connection to the client has been established through the method clientForDevice.

Parameters

Parameter	Notes
client Required HeftClient	The client object, used to perform transactions and communicate with the payment terminal.

Code example

//didConnect:
//Called when a connection to specified device was created.
-(void)didConnect:(id<HeftClient>)client 
{
    // connected successfully to a device
    // assign the client to our heftClient property
    heftClient = client;
}

didDiscoverFinished

didDiscoverFinished Method

When the modal window from startDiscovery is closed then this event is called.

Code example

//didDiscoverFinished
// This function gets called when discovery is finished
- (void)didDiscoverFinished;
{
    NSLog(@"Discover finished"); 
    //Stop search activity indicator or other desired functions 
}

didFindAccessoryDevice

didFindAccessoryDevice Method

Notifies that a new accessory device was found. When a payment terminal is detected this delegate is called. You can take the newDevice object and create a new heft client for that particular terminal or store it in memory to connect to it later.

Parameters

Parameter	Notes
newDevice Required HeftRemoteDevice	An object containing a reference to the accessory device.

Code example

//didFindAccessoryDevice
//Delegate which notifies that a new accessory device was found.
- (void)didFindAccessoryDevice:(HeftRemoteDevice*)newDevice
{
    NSLog(@"Found new device");
    //Connect to device or store found device for later.
}

didLostAccessoryDevice

didLostAccessoryDevice Method

Notifies that the accessory device was disconnected.

Parameters

Parameter	Notes
oldDevice Required HeftRemoteDevice	An object containing a reference to the accessory device.

Code example

//didLostAccessoryDevice
//Delegate which notifies that an accessory device was disconnected
- (void)didLostAccessoryDevice:(HeftRemoteDevice*)oldDevice
{
    NSLog(@"Device disconnected");
    //Remove device from devices array
    [heftManager.devicesCopy removeObject:oldDevice];
    //Do some cleanup after disconnecting if necessary 
    
} 

responseStatus

responseStatus Method

Called to inform about the status of the transaction, several calls can be expected. Several calls to this method happen after a transaction is initiated from the HeftClient to inform about the status of operation. The info object contains a string (status) and a dictionary (xml).

Parameters

Parameter	Notes
info Required ResponseInfo	Includes status code, status text and detailed xml.

Code example

//responseStatus:
//Called to inform about the status of the transaction
-(void)esponseStatus:(id<ResponseInfo>)info
{
    NSLog(info.status);
    NSLog(info.xml.description);
}

responseFinanceStatus

responseFinanceStatus Method

Notifies that the transaction has completed.

Parameters

Parameter	Notes
info Required FinanceResponseInfo	Information about current transaction status.

Code example

//responseFinanceStatus:
//Called at the end of a transaction to inform about the result of the operation.
-(void)responseFinanceStatus:(id<FinanceResponseInfo>)info
{
    NSLog(info.status);
    NSLog(info.customerReceipt);
    //print receipts
}

responseError

responseError Method

Called to inform about the status of the transaction, several calls can be expected. Several calls to this method happen after a transaction is initiated from the HeftClient to inform about the status of operation. The info object contains a string (status) and a dictionary (xml).

Parameters

Parameter	Notes
info Required ResponseInfo	The info object contains a string (status) and a dictionary (xml).

Code example

//responseError:
//Called when an error happens.
-(void)responseError:(id<ResponseInfo>)info
{
    NSLog(info.status);
    NSLog(info.xml.description);
}

requestSignature

requestSignature Method

Called during a financial operation if a signature from the customer is needed. The requestSignature delegate should be implemented to print out or display the receipt for the customer to sign.

Parameters

Parameter	Notes
receipt Required NSString	The receipt is a html formatted string containing a receipt for the customer to sign.

Code example

//requestSignature:
//Is called if a signature from the customer is needed.
-(void)requestSignature:(NSString*)receipt
{
    NSLog(receipt);
    //Display buttons to accept or decline customer signature
    UIAlertView* alert = [[UIAlertView alloc] initWithTitle:@"" message:@"sign?" delegate:self cancelButtonTitle:@"No" otherButtonTitles:@"Yes", nil];
    [alert show];
}

cancelSignature

cancelSignature Method

Called if the signature request times out. If the payment terminal does not receive an approval for the signature within a certain timeframe, it cancels the transaction and sends a notification to the app.

Code example

//cancelSignature
//Called if the signature request times out.
-(void)cancelSignature
{
    NSLog(@"Signature request timed out");
}

responseScannerEvent

responseScannerEvent Method

Called to inform that a scan has been performed, several calls can be expected.

Parameters

Parameter	Notes
info Required ScannerEventResponseInfo	The info object contains scanCode, status and a dictionary (xml).

Code example

//responseScannerEvent:
//Called to inform that a scan has been performed
-(void)responseScannerEvent:(id<ScannerEventResponseInfo>)info
{
    NSLog(info.scanCode); //barcode scanned
    NSLog(info.xml.description);
}

responseScannerDisabled

responseScannerDisabled Method

Called to notify that the scanner has been disabled.

Parameters

Parameter	Notes
info Required ScannerDisabledResponseInfo	The info object contains information about the scanner operation.

Code example

//responseScannerDisabled:
//Called to notify that the scanner has been disabled. 
-(void)responseScannerDisabled:(id<ScannerDisabledResponseInfo>)info
{
    NSLog(info.status);
}

responseLogInfo

responseLogInfo Method

Called when logs have been downloaded from the payment terminal by using the logGetInfo method.

Parameters

Parameter	Notes
info Required LogInfo	The info object has the string property log which holds the log info in text with carriage returns.

Code example

//responseLogInfo:
//Called when logs have been downloaded from the card reader by using the logGetInfo method.
-(void)responseLogInfo:(id<LogInfo>)info
{
    NSLog(info.log);
    //write to log file
}

responseRecoveredTransactionStatus

responseRecoveredTransactionStatus Method

Notifies that a transaction has been recovered.

This method is OPTIONAL and only required if retrievePendingTransaction is called.

Parameters

Parameter	Notes
info Required FinanceResponseInfo	Information about the recovered transaction status. If an attempt was made to recover a transaction when none was pending then this parameter WILL be nil.

Code example

//responseRecoveredTransactionStatus:
//Called when a pending transaction result has been recovered from the payment terminal.
- (void)responseRecoveredTransactionStatus:(id<FinanceResponseInfo>)info{
    if(info != nil) {
        if(info.statusCode == EFT_PP_STATUS_SUCCESS) {
            NSLog(info.status);
            NSLog(info.customerReceipt);
            NSLog(info.merchantReceipt);
            // print receipts and/or save receipts in the transaction log.

            if(info.financialResult == EFT_FINANC_STATUS_TRANS_APPROVED){
                // Process to recover an authorized transaction result.
            } else if(info.financialResult == EFT_FINANC_STATUS_TRANS_DECLINED) {
                // Process to recover a declined transaction result.
            }
        } else if(info.statusCode != EFT_PP_STATUS_NO_DATA_AVAILABLE) {
            // some other error was detected while waiting for a pending transaction result.
        }
    }
    // else a pending transaction result was not found. 
}