Difference between revisions of "Payment Processing Developer Guide"

From Cloud9 Payment Processing Gateway Documentation
Jump to: navigation, search
(API for Point of Sale)
(Understanding AVS)
 
(46 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Template:C9Header|Developer Guide}}
 
{{Template:C9Header|Developer Guide}}
=Overview=
 
'''This section is under construction. Please contact us directly @ 561-392-9606 x 701 for information on limited Cloud9 release.'''
 
 
=Environment & Client Options=
 
=Environment & Client Options=
 
Being a cloud based system, Cloud9 has few restrictions on the integration options.
 
Being a cloud based system, Cloud9 has few restrictions on the integration options.
 
The following are some of the possibilities:
 
The following are some of the possibilities:
 
* Windows
 
* Windows
 +
* Web Browser
 
* Unix/Linux
 
* Unix/Linux
 
* Android
 
* Android
* iPhone
+
* iOS
 
* OS X
 
* OS X
 
* Custom
 
* Custom
Line 30: Line 29:
 
|-
 
|-
 
|
 
|
|}
 
 
==Payment Device Control Services==
 
<br>
 
{| style=" border: 1px dashed red; width="400px"
 
|- style="vertical-align: top;"
 
|[[File:PDCClientCloud.jpg|none|600px|Main Cloud9 Payment Processing Gateway Integration Diagram]]
 
|-
 
|The client can communicate directly with the cloud or Payment Device Controller via SOAP, JSON or using the wizard like wrapper, written in C/C++/Java.
 
 
|}
 
|}
  
Line 49: Line 39:
 
|}
 
|}
  
=Protocols=
+
=Understanding AVS=
The following are the base protocols, used by the Cloud9 to interact between the components:
+
If you need to enforce AVS (Address Verification), you can set '''IgnoreAVSresult''' API option to '''N''' (NO).
{| class="wikitable"
+
If you do so, your software must use post processing to determine the reason for decline and proceed accordingly (not all decline reasons are critical in all conditions).
|-
+
<br>We have an extensive list of AVS match options. 
! scope="col"| Initiating End
+
<br> See this link for: [https://developer.acquired.com/references/issuercodes#:~:text=Issuer%20Response%20Codes.%20Overview.%20We%20will].
! scope="col"| Receiving End
+
<br>'''The Flow'''
! scope="col"| Link / Protocol
+
# AVS pass - ok?
|-
+
# IF AVS NOT pass - check the AVS Response Code to decide if to proceed.
|POS Software
+
<br>
|Payment Platform Front End
+
'''​Please only check the first 5 digits of zip codes'''
|HTTPS
 
|-
 
|Payment Platform Front End
 
|MSR / PIN Pad
 
|RS232, etc
 
|-
 
| Management Browser
 
|Payment Platform Gateway
 
|HTTPS
 
|}
 
  
 
+
=Integration Options and Working Samples=
=Integration Options=
 
 
Please choose the integration scenario below, to dive into more detail:
 
Please choose the integration scenario below, to dive into more detail:
My client is a:
 
==Web Based Integration==
 
1) First, visit the following web site to initialize, and '''select proceed to get over the security message, first (ignore any errors, the test server does not yet have a secure certificate of its own)''': [https://testlink.c9pg.com:5551/hj https://testlink.c9pg.com/]
 
 
*[http://samples.c9pg.com/html/c9pg_client_html_test.htm Running HTML Client with active source code display]
 
*[http://samples.c9pg.com/html/ Source Code]
 
 
==API for Point of Sale==
 
In this section we will discuss the integration options for developers of conventional Point Of Sale (POS) systems.
 
<br>'''There are two main options:'''
 
# Default: POS uses a payment terminal/pin pad ('''DEFAULT'''/[[Glossary:Card Present|Card Present]] scenario)<br><!--Proceed to the [[Cloud9 Payment Device Controller API Guide]]-->
 
# POS does '''NOT''' use a payment terminal/pin pad ([[Glossary:Card Not Present|Card Not Present]] scenario), or you have already integrated a pin pad into your system<br><!--Proceed to the [[Cloud9 Direct API Guide]]-->
 
 
&rarr; Please, see the '''[http://cloud9paymentgateway.com/files/API/samples mini-POS developer package]''' (download, unzip the file and run the executable, the code is in the INC directory)
 
 
==SOAP/XML==
 
===Simple Purchase Payment Request & Response===
 
<code><Request>
 
  <Type>Purchase</Type>
 
  <TotalAmount>10.00</TotalAmount>
 
</Request>
 
<Response>
 
  <Result>Queued</Result>
 
  <TrxToken>1234ABCD</TrxToken>
 
</Response></code>
 
 
===Simple Payment Status Request & Response===
 
<code><Request>
 
  <Type>Query</Type>
 
  <TrxToken>1234ABCD</TrxToken>
 
</Request>
 
<!-- Payment Status Query Response-->
 
<Response>
 
  <Result>Approved</Result>
 
  <ApprovedAmount>10.00</ApprovedAmount>
 
  <AccountBalanceAmount>50.00</AccountBalanceAmount>
 
  <AccountType>Credit</AccountType>
 
  <AccountAssnCode>VS</AccountAssnCode>
 
  <AccountNumber>411111XXXXXX1111</AccountNumber>
 
  <AccountToken>7890XYZ</AccountToken>
 
</Response></code>
 
 
<br>
 
<br>
 +
{{Template:samples}}
  
 
=Documentation=
 
=Documentation=

Latest revision as of 07:26, 13 September 2024




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

Environment & Client Options

Being a cloud based system, Cloud9 has few restrictions on the integration options. The following are some of the possibilities:

  • Windows
  • Web Browser
  • Unix/Linux
  • Android
  • iOS
  • OS X
  • Custom

Services

Cloud9 Payment Gateway

Cloud9 is essentially a multi-merchant/multi processor switch. Cloud9 reduces the complexity of direct processor and payment terminal programming, certification and compliance by presenting a simple unified interface to the developer with numerous interface options. The core communications are conducted via TLS/SOAP/JSON with wrappers in C/C++/Java, if desired.

Back-Office Reporting Gateway

Cloud9 has a full suite of Back Office Reporting, which can be extended and scripted.

Payment Device Controller (PDC)

Optional Payment Device Controller (PDC) hides the complexity of low level communications with the payment terminals and adds Offline Store & Forward functionality, if desired. The client (POS/web page/mobile device, etc) can communicate with the PDC, which will in turn control the payment perminal/pin pad and relate the processing instructions to the Cloud9 Payment Gateway. This is the easiest form of integration and it is recommended.
Note: Variations of Payment Device Controller are Payment Mobile Controller (PMC) and Payment Web Controller (PWC), dealing with mobile and web based payment processing functionality respectively.

→ OPTION1: Local Payment Device Controller with Store and Forward Capability


Main Cloud9 Payment Processing Gateway Integration Diagram
The client can communicate with a local Payment Device Controller (PDC) via SOAP, JSON or using the wizard like wrapper, written in C/C++/Java.

→ OPTION2: No Local Software - Direct Cloud Connection to Cloud9 Payment Web Controller (PWC)

Cloud9 PWC Direct Integration Diagram
The client can communicate directly with the cloud Payment Web Controller (PWC) via SOAP, JSON or using the wizard like wrapper, written in C/C++/Java.


Payment Device Controller Setup

Please, see Cloud9 Payment Device Controller Setup

System & Process Diagrams

POS System Diagram

Cloud9DiagramPOSDetail.jpg

Cloud9 Process Diagram

Cloud9ProcessDiagram.jpg

Understanding AVS

If you need to enforce AVS (Address Verification), you can set IgnoreAVSresult API option to N (NO). If you do so, your software must use post processing to determine the reason for decline and proceed accordingly (not all decline reasons are critical in all conditions).
We have an extensive list of AVS match options.
See this link for: [1].
The Flow

  1. AVS pass - ok?
  2. IF AVS NOT pass - check the AVS Response Code to decide if to proceed.


​Please only check the first 5 digits of zip codes

Integration Options and Working Samples

Please choose the integration scenario below, to dive into more detail:

Web Browser Samples

Web Browser Integration Samples

RESTFul JSON/SOAP

JSON API Documentation

MS Windows Samples

Windows Integration Samples

iOS Integration Samples

iOS Integration Samples

Android Integration Samples

Android Integration Samples

Documentation

Payment Processing API Documentation





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