View source for JSON API Documentation

{{Template:C9Header|JSON API Documentation}}
=Step One=
Please, review the '''[[Payment_Processing_Developer_Guide|Developer Guide]]''' to determine the best integration approach, before diving into the API Documentation below.

=API DOCUMENTATION=

&rarr; ''' [http://cloud9paymentgateway.com/docs/API/JSON/  Full SOAP/JSON API Documentation]

See below for a good intro to the API with some examples.

=Elements=
The library has two basic elements:
;Connection:Client can either connect directly to<br>a)Cloud9 Server Payment Web Controller (PWC) - this is a good option is local hardware payment terminals are not used<br>b)Local Payment Device Controller (PDC), which controls the payment terminal.
;Name/Value Pair

=Connection Types=
{{Template:ConnectionTypes}}

=Basic Transaction=

{  // REQUEST
  "GMID":"10XXXXXX50",  // Gateway Merchant ID
  "GTID":"GTXXXXXXX53", // Gateway Terminal ID
  "GMPW":"XXX",         // Gateway Password
  "TransType":"Auth",   // Transaction Type
  "Medium":"Credit",    // Transaction Medium (Credit=Credit Card)
  "MainAmt":"123",      // Amount
  "IncTaxAmt":"56",     // Tax Amount
  "SourceTraceNum":"123456"  // Trace Number
}
 
{  // RESPONSE
  "Status": "success",  // Response Status
  "ResponseCode": "00", // Response Code
  "AuthCode": "12345A"  // Authorization Approval Code
}

=Core Key Names / Commands=
{| class="wikitable"
!scope="col"|Value
!scope="col"|Explanation
|-
|GMID
|Gateway Merchant ID
|-
|GTID
|Gateway Terminal ID
|-
|GMPW
|Gateway Account Password
|-
|[[#TransType - Transaction Type Command|TransType]]
|Transaction Type
|-
|[[#Medium - Processing Medium Command|Medium]]
|Transaction Medium (e.g. Credit Card/Debit Card/etc)
|-
|MainAmt
|Main Transaction Amount
|-
|IncTaxAmt
|Tax Amount
|-
|SourceTraceNum
|Merchant Transaction Trace Number
|-
|IncTaxAmt
|Tax Amount
|-
|InvoiceNum
|Invoice Number
|-
|OrderNum
|Order Number
|-
|VoucherNum
|Voucher Number
|-
|AdditionalInfo
|Additional Transaction Info
|-
|AccountNum
|Account Number (optional - only needed if PDC is not used to control the payment terminal)
|-
|ExpDate
|Expiration Date (optional - only needed if PDC is not used to control the payment terminal) 
|-
|Track1
|Track1 of Card (optional - only needed if PDC is not used to control the payment terminal)
|-
|Track2
|Track2 of Card (optional - only needed if PDC is not used to control the payment terminal)
|-
|PinData
|Pin Data for Debit (optional - only needed if PDC is not used to control the payment terminal)
|-
|CardPresent
|Sets the Card Present Indicator (optional)
|-
|EntryMode (optional)
|Entry Mode
|}

=Core Values=

==TransType - Transaction Type Command==
{| class="wikitable"
!scope="col"|Value
!scope="col"|Explanation
|-
|Auth
|Authorization. Authorization is a non-finalized transaction that is used in a tip environment. Add tip to finalize.  Only finalized transactions are batched/settled
|-
|Sale
|Sale. Sale is a finalized transaction that will be included in the next batch/settlement
|-
|AddTip
|Adds Tip to an Auth, finalizing it and getting it ready to be batched/settled
|-
|Modify
|Modifies a transaction, also finalizing it and getting it ready to be batched/settled
|-
|Finalize
|Finalizes Authorization and turns then into Sale, getting it ready to be batched/settled

|-
|Void
|Voids a transaction
|-
|Refund
|Refunds a transaction
|-
|Inquiry
|Debit, Credit or Gift Card Card Balance Inquiry
|-
|Activate
|Activate a Gift Card
|-
|AddValue
|Add Value to a Gift Card
|-
|Deactivate
|Deactivate a Gift Card
|}

==Medium - Processing Medium Command==
{| class="wikitable"
!scope="col"|Value
!scope="col"|Explanation
|-
|Credit
|Credit Card
|-
|Debit
|Debit Card
|-
|Gift
|Prepaid
|-
|Prepaid
|Prepaid Card
|-
|EBTCash
|EBT Cash
|-
|EBTFood
|EBT Food
|}

==Boolean Values==
{| class="wikitable"
!scope="col"|Value
!scope="col"|Explanation
|-
|Y
|True or Yes
|-
|N
|False or No
|}

=Live Sample Companion=
&rarr; '''NOTE:''' It is '''highly recommended''' that you use the live '''[[Windows_Integration_Samples|Integration Samples]]''', which has real time source code windows to help you understand the API.
<br>'''You can see the JSON Payload at the bottom of the page, for reference.'''
[[image:cloud9api.jpg|none|thumb|750px|API Sample Screenshot|link=Windows_Integration_Samples]]<br>


=Source C Documentation=
You might find '''[http://cloud9paymentgateway.com/docs/API  Payment Gateway C-languages Documentation]''' useful, if you would like to explore the source for JSON interface (see PgcKey.h file for definitions)
{{Template:C9Footer|Integration}}