Difference between revisions of "IOS API Documentation"

From Cloud9 Payment Processing Gateway Documentation
Jump to: navigation, search
Line 7: Line 7:
 
'''[http://cloud9paymentgateway.com/files/API/samples/iOS iOS Sample Project Download]'''
 
'''[http://cloud9paymentgateway.com/files/API/samples/iOS iOS Sample Project Download]'''
  
−
=Integration Steps=
+
=Setup=
−
==iPassthruManager==
+
==Installation==
−
IPassthruManager is a virtual payment terminal, which communicates with Multiplexer.<br>Multiplexer is a Cloud Based Payment Terminal Communication Server. All TCP based pin pads are controlled by the Multiplexer.
+
# Add iPDCLib.framework to your project like other normal framework.
−
#Implement the protocol IPassthruNotificationSupport
+
# Add "Supported external accessory protocols" to your app's info.plist with value
−
#Call initWithDelegate to instantiated the iPassthruManager class.
+
"com.ingenico.easypayemv.spm-transaction"  (there is a sample info.plist in the iPDCAPP.zip)
−
#Call setConnectionWithHost to set the Multiplexer host and port
+
# If you need the payment terminal to work in the background,add "Required background" to your app's info.plist with value "App communicates with an accessory" (there is a sample info.plist in the iPDCAPP.zip)
−
#Call Start to connect to Multiplexer and connect to the payment terminal via bluetooth
 
−
#Call Stop to disconnect the above connections.
 
  
 
==iPDCManager==
 
==iPDCManager==
−
iPDCManager assists communication with Cloud9 Payment Web Device Controller(PWC), which abstracts the control of payment terminals.
+
iPDCManager (Payment Device Controller Manager) assists communication with Cloud9 Payment Web Device Controller(PWC), which abstracts the control of payment terminals.  iPDCManager includes Store & Forward Support.
 
#Implement the protocol IPDCManagerNotify
 
#Implement the protocol IPDCManagerNotify
 
#Call initWithDelegate to instantiated the iPDCManager class.
 
#Call initWithDelegate to instantiated the iPDCManager class.
−
#Call postTransactionToUrl to send a JSON request to Cloud-PDC via https protocol.
+
# (Optional) Call ''enableRushMode'' or ''disableRushMode'' to enable or disable Store & Forward, respectively
 +
# Call postTransactionToUrl to send a JSON request to Cloud-PDC via https protocol.
  
−
=Protocol Reference=
 
−
*IPassthruManagerNotifyClient is used for payment terminal communication event notifications.
 
−
*IPassthruManagerNotifySSL is used for Multiplexer communication event notifications.
 
−
*ServerToClientDataSent is triggered after sending data to ICM122.
 
−
*ClientToServerDataSent is triggered after sending data to Multiplexer.
 
−
*HttpsDataReceived is triggered when a Cloud-PDC response is receieved.
 
−
*HttpsErrorOccurred is triggered when the https connection encounter a error.
 
  
 
=JSON Protocol Reference=
 
=JSON Protocol Reference=
 
The iOS facilitates payment operations via JSON Key-Value pairs. See [[JSON API Documentation]] for full functionality info.
 
The iOS facilitates payment operations via JSON Key-Value pairs. See [[JSON API Documentation]] for full functionality info.
 +
 +
=iPassthruManager (DEPRECATED)=
 +
Passthru manager is an older version of Payment Device Controller Manager without Store & Forward. It is maintained for backward compatibility.
 +
Click on the following link for [[API_iPassThruManager|information on iPassthruManager]]
 +
  
 
{{Template:C9Footer|Integration}}
 
{{Template:C9Footer|Integration}}

Revision as of 20:47, 18 January 2018




Cloud9 Payment Gateway Documentation. This site can also be reached at http://docs.cloud9paymentgateway.com

Sample Test Application Screenshot

Download iOS SDK Library

iOS SDK Library Download

Sample iOS Application

iOS Sample Project Download

Setup

Installation

  1. Add iPDCLib.framework to your project like other normal framework.
  2. Add "Supported external accessory protocols" to your app's info.plist with value

"com.ingenico.easypayemv.spm-transaction" (there is a sample info.plist in the iPDCAPP.zip)

  1. If you need the payment terminal to work in the background,add "Required background" to your app's info.plist with value "App communicates with an accessory" (there is a sample info.plist in the iPDCAPP.zip)

iPDCManager

iPDCManager (Payment Device Controller Manager) assists communication with Cloud9 Payment Web Device Controller(PWC), which abstracts the control of payment terminals. iPDCManager includes Store & Forward Support.

  1. Implement the protocol IPDCManagerNotify
  2. Call initWithDelegate to instantiated the iPDCManager class.
  3. (Optional) Call enableRushMode or disableRushMode to enable or disable Store & Forward, respectively
  4. Call postTransactionToUrl to send a JSON request to Cloud-PDC via https protocol.


JSON Protocol Reference

The iOS facilitates payment operations via JSON Key-Value pairs. See JSON API Documentation for full functionality info.

iPassthruManager (DEPRECATED)

Passthru manager is an older version of Payment Device Controller Manager without Store & Forward. It is maintained for backward compatibility. Click on the following link for information on iPassthruManager





From the makers of Cloud9 Payment Processing Gateway and Creditline Credit Card Processing Software

Retrieved from "http://cloud9paymentgateway.com/w/index.php?title=IOS_API_Documentation&oldid=653"