Difference between revisions of "Payment Processing API Documentation"

From Cloud9 Payment Processing Gateway Documentation
Jump to: navigation, search
(Using the C PGClient Documentation)
(Using the C PGClient Documentation)
Line 49: Line 49:
 
<br>
 
<br>
 
You can use the File List and File Member functions like so, to get more detail on what is available:
 
You can use the File List and File Member functions like so, to get more detail on what is available:
[[File:doxygen1.jpg|left|You can also use Search to find a function]]
+
'''You can also use Search to find a function'''
 +
<br>[[File:doxygen1.jpg|none|frame]]
 
<br>'''Alternative way to browse functions'''
 
<br>'''Alternative way to browse functions'''
[[File:doxygen2.jpg|left]]
+
<br>[[File:doxygen2.jpg|none|frame]]
[[File:doxygen3.jpg|none|frame|This is how you can browse the parameter definitions]]
+
<br>'''This is how you can browse the parameter definitions'''
 +
<br>[[File:doxygen3.jpg|none|frame]]
 
<br>
 
<br>
 
<br>
 
<br>

Revision as of 07:21, 20 August 2017




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

Step One

Please, review the Developer Guide to determine the best integration approach, before diving into the API Documentation below.

API Documentation

Overview

The following document will give a good idea of how to use our Payment Gateway Client API (PGCApi), which have wrappers for other languages (VB, JS, etc) This is a simpler value pair operation library

Elements

The library has two basic elements:

Connection
Client can either connect directly to
a)Cloud9 Server Payment Web Controller (PWC) - this is a good option is local hardware payment terminals are not used
b)Local Payment Device Controller (PDC), which controls the payment terminal.
Payment Processing Transaction Session
an object that holds description of the transaction and it's result. There is one transaction per session

Basic Flow

  1. Initialize
  2. Connect
    repeat as many times as necessary
  3. Create New Transaction Session
  4. Set Transaction Parameters (uses simple Set String and Set Value commands)
  5. Send Transaction Request
  6. Get Transaction Response (uses simple Get String and Get Value commands)
  7. Close the Session
    go back to create a new transaction session, if more transactions needed
  8. Disconnect

Detailed Flow with C Examples

  1. Initialize the library
    PgcInit("PgcSample");
  2. Connect to the Payment Web Controller (PWC - direct Cloud9 Server connection) or local Payment Device Controller (PDC) Server
    1. Create Connection Handle
      int nConn = PgcNewConn(PGC_SVC_C9PG_PDC, "Name", "Token", PGC_TIMEO_TXN_UI, "PgcSample", ""); //USE PGC_SVC_C9PG_PWE_TEST for PWE
    2. Open the Connection, specified by Connection Handle
      int nErr = PgcConnect(nConn);
  3. Create New Transaction Session
    int nSess = PgcNewSess(nConn, 1);
  4. Set Session Parameters
    1. Set MID/TID/PWD
      PgcSetStr(nSess, 0, PGC_GWKEY_GMID, "1001396250"); // Gateway merchant ID
      PgcSetStr(nSess, 0, PGC_GWKEY_GTID, "GT1001396253"); // Gateway terminal ID
      PgcSetStr(nSess, 0, PGC_GWKEY_GMPW, "123"); // Gateway merchant password
    2. Set Transaction Type
      PgcSetStr(nSess, 0, PGC_GWKEY_TXNACT, PGC_GWVAL_TXNACT_AUTH); // Transaction action type -> authorization
    3. Set Transaction Medium (e.g. Credit Card)
      PgcSetStr(nSess, 0, PGC_GWKEY_MDM, PGC_GWVAL_MDM_CREDIT); // Payment medium -> credit card
    4. Set Transaction Parameters (e.g. Amount, Tax, Trace#)
      PgcSetAmt(nSess, 0, PGC_GWKEY_MAINAMT, 123); // Main amount -> $1.23
      PgcSetAmt(nSess, 0, PGC_GWKEY_INCTAXAMT, 8); // Included tax amount -> $0.08
      PgcSetStr(nSess, 0, PGC_GWKEY_SRCTRACENUM, "123456"); // Source trace number; will be returned for matching
  5. Send Transaction Request
    int nErr = PgcRequest(nSess);
  6. Get Transaction Response and Approval Code
    PgcGetStr(nSess, 0, PGC_GWKEY_STATUS, sStatus, 256); // Transaction status, indicating if it is successful
    ...
    PgcGetStr(nSess, 0, PGC_GWKEY_RSPCODE, sRspCode, 256); // Response code returned from the host
    ...
    PgcGetStr(nSess, 0, PGC_GWKEY_RSPTEXT, sRspText, 256); // Response text returned from the host
    ...
    PgcGetStr(nSess, 0, PGC_GWKEY_AUTHCODE, sAuthCode, 256); // Auth code
  7. Close the Transaction Session
    PgcFreeSess(nSess);
  8. Disconnect from Server
    PgcDisconnect(nConn); // Disconnecting from the controller; will be called automatically upon closing
    PgcFreeConn(nConn); // Closing connection to the controller; called once per connection
  9. Un-Initialize
    PgcUninit("PgcSample"); // Uninitializing library; called once per application upon exit

Online Documentation: Payment Gateway Client Library ver 17.08.14 documentation

Using the C PGClient Documentation

There are two main files of interest:

PgcClient.h
contains functions
PgcKey.h
contains parameter definitions for the key pairs


You can use the File List and File Member functions like so, to get more detail on what is available: You can also use Search to find a function


Doxygen1.jpg


Alternative way to browse functions



This is how you can browse the parameter definitions


Doxygen3.jpg



Samples

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





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