Install “Click & Pledge PaaS Class Library” package version 2.0 or later
Install "Click & Pledge Payment-as-a-Service" version 8.0000 or later
Complete the Activation between Click & Pledge and Salesforce
Complete the "Click & Pledge Payment-as-a-Service" Post Installation instructions

After Installing “Click & Pledge Event Management 2.0” you need to Create Site (if not created earlier). This is a Salesforce public URL site. You can watch the video or follow the instructions below:

During installation user needs to approve the ‘Third-Party Access’ by accepting the access permission, then continue the Installation.

Step 1: Approve Package API Access

Step 2: Choose Security Level

Step 3. Install Package

Verify User Interface Setup

The Salesforce User Interface setup allows for different views of various sections. The remainder of this post-installation procedure uses the following view settings. Please make sure your view matches the following:

Enable Enhanced Profile List Views: Unchecked
Enable Enhanced Profile User Interface: Unchecked

The settings may be reverted back to the enhanced view once the setup is complete.

Setup > App Setup > Customize > User Interface

Site Creation

You must create a site URL unless you have already created one. At top right of Salesforce account under your account name, use the dropdown box to find 'Setup'. Once you click 'Setup' go to menu on left of page and find 'App Setup', 'Develop', then 'Site' and select 'New'
Setup > App Setup > Develop > Site > New

You will go to a Sites page where you can enter a Domain Name you would like to use. Note: Be careful when creating domain name. It cannot be modified after creation.

Check availability for Domain name first then accept the terms and click the 'Register My Force.com Domain'.

Please note: The Force.com domain name cannot include periods or other characters. A common mistake is using such texts as: www.MyOrg.org - the entry for such a domain should be: MyOrg and will look like: http://MyOrg-developer-edition.na12.force.com

You cannot modify your Force.com domain

Select 'OK' that you agree you cannot modify your domain.

You will go back to the Sites page and you will see the URL you created. Click on 'New.'
Sites

Site Creation Instructions:
Site Setting

Special Note regarding Clickjack:

Salesforce feature note: http://docs.releasenotes.salesforce.com/en-gb/spring14/release-notes/rn_sitecom_clickjacking.htm

At ‘Site Label’, ‘Site Name’ and ‘Default Web Address’ type your desired text. At ‘Active Site Home Page’ user must select ' ExternalRegistrationPage' from lookup value. Then click Save. After that, open your created 'Site Label' and modify as suggested below.

Enable Visualforce

Click on 'SiteLabel"
Go down to the Site Visualforce Pages section and click on Edit.

Enable the following ‘Visualforce Pages’ by adding the pages to ‘Enabled Visualforce Pages’ section. To do this you will need to select them then click on the Add arrow to bring into 'Enabled Visualforce Pages'. Once finished click on Save.
1.CnP_PaaS_EVT.EventListingPage
2.CnP_PaaS_EVT.ExternalRegistrationPage
Enable Visualforce Page Access

Update 'Public Access Settings'
Then go to 'Public Access Settings' at your created Site.

After that click Edit at ‘Public Access Settings’ then set the settings as below.
(a) At 'Field-Level Security'
(i) Under Standard Field-Level Security
Please set all the fields of Contact object, view as Visible.

To make visible click ‘View’ beside of Contact Object Name and keep each field visibility as on and then ‘Save’ it.
NOTE: Please make sure any additional custom fields that you may wish to use in the event registration form are also visible.
(ii) ) Under 'Custom Field-Level Security’
Please Set the 'Custom Field Level Security', view as Visible. To do this follow this path
Setup -> Develop -> Sites -> Click on Site Label -> Public Access Settings -> then under Custom Field Level Security click the following list of Event Custom Objects and keep all the fields as visible.
To make visible click ‘View’ beside of Custom Object Name and keep each field visibility as on and then ‘Save’ it. These are:

C&P Designer
C&P Designer Content Data
C&P Event
C&P Event Account Information
C&P Event Attendee Custom Information
C&P Event Authenticate Device
C&P Event Category
C&P Event Check-In and Check-Out
C&P Event Contact Field
C&P Event Custom Field
C&P Event Device Junction
C&P Event Discount Plan
C&P Event Layout
C&P Event Level Group
C&P Event Listing
C&P Event Listing Junction
C&P Event Question Section
C&P Event Registered Attendee
C&P Event Registrant
C&P Event Registration Level
C&P Event Setting
C&P Event Temporary Contact
C&P Event External Tab
C&P Event Inventory Process
C&P Widget

(b) At Standard Object Permissions

C&P Designer
C&P Designer Content Data
C&P Event
C&P Event Account Information
C&P Event Attendee Custom Information
C&P Event Authenticate Device
C&P Event Category
C&P Event Check-In and Check-Out
C&P Event Contact Field
C&P Event Custom Field
C&P Event Device Junction
C&P Event Discount Plan
C&P Event Layout
C&P Event Level Group
C&P Event Listing
C&P Event Listing Junction
C&P Event Question Section
C&P Event Registered Attendee
C&P Event Registrant
C&P Event Registration Level
C&P Event Setting
C&P Event Temporary Contact
C&P Event External Tab
C&P Event Inventory Process
C&P Widget

Set Time Zone

Set Event Start/End Date and Time so it is consistent across Events and Event Listing Page, set the same 'Time Zone' and 'Locale' in Salesforce 'Personal Information' section and Salesforce 'Site User' section.

1. Check the Time Zone in your 'Personal Information' first. Go up to the top right corner menu and select your User Name > Setup > My Personal Information > Personal Information

2. Now set the same Time Zone and Locale at Salesforce 'Site User.'
(a) To get there follow this path: Your User Name (in menu at top right corner) > Setup > App Setup > Sites. Click at Site Label.

(b) Move to 'Public Access Settings'

(d) Open the 'Site User' profile

(e) Edit the 'Site User' Profile

(f) Set the same 'Time Zone' as you did in your 'Personal Information' Detail [Set time zone, step 1]
User Detail

Create Remote Site

To send the Events Tickets/Name Badges we need to have a Remote Site. Follow the below steps to create the Remote Site:
Move to:
Name -> Setup -> Administration Setup -> Security Controls -> Remote Site Settings
Click at ‘New Remote Site’

Remote Site Name - Name this whatever you wish. This is used for your internal reference.
Remote Site URL - Enter the Salesforce instance URL for the account to be connected. Example: https://na9.salesforce.com (The primary URL need to be used without the information followed after the first /)

Keep Site as ‘Active and then Click ‘Save’.

↧

Report :: Version2.5

August 18, 2014, 2:05 am

≫ Next: PaymentMethod :: Version3.1

≪ Previous: Salesforce-Event-Post Installation 2 0 :: Version3.1

Table of Contents [ Hide]

Detail

Build a New Report

Report Type:

Consolidated Transaction Report: The report lists transactions as a single line entry regardless of the number of items purchased. The report will include the selected data as selected in the Select Data section.
Detailed Listing Report [detailed item listing]: The report lists transactions as a multi-line entry listing each item purchased as a separate line (row) in the report. Discount, tax, shipping and each product are listed individually in separate rows.

Select Data:

Available fields to be included in any report. Mouse click on any of the fields in the order needed. The following shows an example of a few selected fields:

Select Data

Saved reports may be retrieved in future using the selected fields.

Report Name

Report name will be saved for future reference. All saved reports will be available for use in future.

Search and Download

Search Transactions

Multi-Account Reporting: [Visible only when multiple accounts are enabled]

All accounts accessible by the user are presented in the box of account. Select accounts for reporting by clicking on the account and clicking on the right arrow. Reports may be exported as one file through the export link provided at the bottom of the page.

Show System Reports
System reports are pre-defined reports with specific fields. The following provides a description for each report:

Detailed Transaction [CSV/XML]: Itemized listing of all items paid for in the transaction, including sales tax, discount, and shipping. Each item is individually listed in separate rows. The report includes complete donor information, item SKUs, total paid, recurring transaction information as well as questions & answers.
Consolidated Transaction [CSV/XML]: Summarized listing of transaction. Each transaction is listed in a row showing the purchase as one line entry. The report includes complete donor information, total paid, recurring transaction information as well as questions & answers.

Mobile Giving Transactions Only: An option of consolidated report - the report generates the list of all payments made through the mobile SMS platform.

Quick Report [CSV/XML]: Consolidated transaction report providing primary details including date/time, first name, last name, address, city, state, zip, phone, email, payment total, and referring URL.
Patron Info [CSV/XML]: Patron information only, including: name, address, phone number, and email.
Email List [CSV/XML]: Designed for use with newsletter programs, the report includes 4 columns: [First name] [Last Name], [Email], [First Name] [Last Name] <[Email]>
CiviCRM [CSV Only]: Designed specifically for hosted CiviCRM as part of the Joomla Open Source content management system. The CiviCRM importer uses this file to import the file to CiviCRM.
Salesforce Donor Management Module [CSV Only]: Designed specifically for the Salesforce Donor Management module /Import tab, the data may be imported to the CRM system directly from the report.
GiftWorks [CSV Only]: Designed specifically for Mission Research- GiftWorks database, the data may be imported to GiftWorks database directly from the report.
resultsplus! [CSV Only]: Designed specifically for resultsplus! , the report may be imported to the resultsplus! database.
Political Organizer and Voter-Lists.com [CSV Only]: Designed specifically for Campaign Organizer and Voter-Lists.com, the report may be imported to the Political Organizer database or set up for Internet access by contacting Voter-Lists.com.
NGP With Contributions: Designed specifically for NGP Software, the report may be imported to MyNGP.com. The output includes contributor information as well as the contributions made.
NGP Without Contributions: Designed specifically for NGP Software, the report may be imported to MyNGP.com. The report includes contribution information only.
e-Ticket Report: Report on all purchased e-Tickets.
e-Name Badge Report: Report on all name badges
e-Ticket / e-Name Badge Detailed Report: Detailed report of e-Ticket and e-Name badge combined
Mobile Ticketing System Report: Designed for the mobile ticketing application.

Show Custom Reports

Choosing the option allows for selecting a report among the custom reports defined in the Build a New Report tab.

Search by Report Type

Reports may be filtered by the type of transaction: Authorized Credit Cards, Declined Credit Cards, Invoice, Purchase Order. Selecting all boxes results in a complete report of all transactions.

Filter by Type

Reports may be filtered by products or donations. A report may be generated for products only, donations only, or both products and donations by checking both boxes.

Search by Receipt Order Number

Receipt order numbers are included in the receipts. The order may be used as a search parameter.

Search by Last 4 Digits of Card

Last 4 digits of a card is included in the receipt. A report may be generated for the last 4 digits. Please note that the last 4 digits of a card are not unique and reports may have many payments with the same last 4 digits.

Search by First Name

Reports may be filtered by the first name of a patron.

Search by Last Name

Reports may be filtered by the last name of a patron.

Search by Tracker

Tracking parameters may be included in the link to the checkout page. Once a tracking parameter is added all donations through the link may be tracked and filtered in reports. [e.g. https://co.clickandpledge.com/default.aspx?WID=7273&Trk=Bob]. Adding Trk=Bob at the end of the checkout page link provides the means for tracking any payment that has originated through the link. Entering "Bob" in the Search by Tracker will create a report of all payments through the link. There are no limits on the number of tracking parameters. Numbers and text may be used as tracking parameters, e.g. Trk=1234, Trk=Event, Trk=event123, etc.

Sold Item

Reports may be filtered for product or donation names. Product names and donation name filters may be set as: Starts with, Contains, Is, or Ends with.

SKU

SKUs can be added to products, product options, donations and premiums. Can be searched by filters: Starts with, Contains, Is, Ends with. SKUs are only available on Detailed Transaction reports.

Checkout Page ID

Reports may be filtered by the checkout page that was used for payment. Reports may be generated for each checkout page individually.

Campaign

Reports may be generated for a specific campaign.

Report Time Zone

Base the reports on the local organization's time zone as set in the Account Info > Profile section.

Search by Beginning Date

Select the beginning date of the report

Search by End Date

Select the end date of the report

Label Report

Sort by
Report View
Transaction Type
Filter by Type
Search by Tracker
Sold Item
Checkout Page ID
Campaign
Report Time Zone
Search by Beginning Date
Search by End Date

Name Badge Report

Search by Tracker
Checkout Page ID
Campaign
Item
Report Time Zone
Search by Beginning Date
Search by End Date

Recurring

Search Recurring

Order Number

Search by First Name

Search by Last Name

Search by Last 4 Digits of Card

Report Time Zone

Search by Beginning Date

Search by End Date

QR PayCard

Search QR PayCard

QR PayCard

Order Number

Search by First Name

Search by Last Name

Search by Last 4 Digits of Card

Report Time Zone

Search by Beginning Date

Search by End Date

Show

Send Receipt

Search Transaction

Amount

First Name

Last Name

Last 4 Digits

Report Time Zone

From Date

To Date

Order Number

Detail

Results of the Search Transaction query will be listed in the Details section.

↧

PaymentMethod :: Version3.1

August 18, 2014, 2:05 am

≫ Next: Create-Event :: Version2.6

≪ Previous: Report :: Version2.5

Path: CnPAPI.Engine.Request.Order. CardHolder.PaymentMethod

Elements:

PaymentType
CreditCard
ReferenceTransaction
Check
PurchaseOrder
Invoice

Schema

<xsd:element name="PaymentMethod">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="PaymentType"/>

<xsd:element ref="CreditCard" minOccurs="0"/>

<xsd:element ref="ReferenceTransaction" minOccurs="0"/>

<xsd:element ref="Check" minOccurs="0"/>

<xsd:element ref="PurchaseOrder" minOccurs="0"/>

<xsd:element ref="Invoice" minOccurs="0"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

Example

<PaymentType>CreditCard</PaymentType>

<NameOnCard>John Smith</NameOnCard>

</CreditCard>

</PaymentMethod>

PaymentType

In Release 1.x of the API, credit card is the only payment method allowed. The additional methods that are available in the payment system will be added in later releases (e.g. Invoice, Purchase Order).

Name	PaymentType
Path	CnPAPI.Engine.Request.Order. CardHolder.PaymentMethod.PaymentType
Description	Payment method used for the transaction.
Data Type	String
Range	CreditCard, ReferenceTransaction, Check, PurchaseOrder, Invoice
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	yes
Example	<PaymentType>CreditCard</PaymentType>

Schema

<xsd:element name="PaymentMethod">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="PaymentType"/>

<xsd:element ref="CreditCard" minOccurs="0"/>

<xsd:element ref="ReferenceTransaction" minOccurs="0"/>

<xsd:element ref="Check" minOccurs="0"/>

<xsd:element ref="PurchaseOrder" minOccurs="0"/>

<xsd:element ref="Invoice" minOccurs="0"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

CreditCard

Path: CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod.CreditCard

Elements:

NameonCard
CardNumber
Cvv2
ExpirationDate
TrackData

Schema

<xsd:element name="CreditCard">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="NameOnCard"/>

<xsd:element ref="CardNumber"/>

<xsd:element ref="Cvv2"/>

<xsd:element ref="ExpirationDate"/>

<xsd:element ref="TrackData" minOccurs="0"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

NameOnCard

Name	NameOnCard
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod.CreditCard.NameonCard
Description	Name as it appears on the credit card
Data Type	String
Range	Minimum: 2 characters Maximum: 50 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	yes
Example	<NameOnCard>John Smith</NameOnCard>

Schema

<xsd:element name="NameOnCard">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Name as it appears on credit card</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:normalizedString">

<xsd:minLength value="2"/>

<xsd:maxLength value="50"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

CardNumber

Name	CardNumber
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod.CreditCard.CardNumber
Description	Credit card number to be charged. Use 4111111111111111 if transacting in Test mode.
Data Type	String
Range	Minimum: 15 digits Maximum: 17 digits
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	yes
Example	<CardNumber>4111111111111111</CardNumber>

Schema

<xsd:element name= "CardNumber" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation> Credit card number to be charged. Use 4111111111111111 if transacting in Test mode.</xsd:documentation >

</xsd:annotation >

<xsd:restriction base= "xsd:string" >

<xsd:minLength value= "15" />

<xsd:maxLength value= "17" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

Cvv2

Name	Cvv2
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod.CreditCard. Cvv2
Description	Card verification number or security code on the back of the credit card. Use 123 if transacting in Test mode.
Data Type	String
Range	Minimum: 1 digit Maximum: 4 digits
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	yes
Example	<Cvv2>123</Cvv2>

Schema

<xsd:element name= "Cvv2" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation> Card verification number or security code on the back of the credit card. Use 123 if transacting in Test mode.</xsd:documentation >

</xsd:annotation >

<xsd:restriction base= "xsd:string" >

<xsd:minLength value= "0" />

<xsd:maxLength value= "4" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

ExpirationDate

Name	ExpirationDate
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod.CreditCard.ExpirationDate
Description	Credit card expiration date. Use any date in future if transacting in Test mode.
Data Type	DateTime
Range	mm/yy format
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	yes
Example	<ExpirationDate>04/09</ExpirationDate>

Schema

<xsd:element name= "ExpirationDate" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation> Credit card expiration date. Use any date in future if transacting in Test mode.</xsd:documentation >

</xsd:annotation >

<xsd:restriction base= "xsd:string" >

<xsd:pattern value= "[0-9][0-9]/[0-9][0-9]" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

Track Data

Name

Track Data

Path

CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod.CreditCard.TrackData

Description

Track data information from the credit card reader

Data Type

Text

Range

Minimum: 43 Characters
Maximum: 226 Characters

Default

Operation

Transaction Operation only

Input/output

Input

Version/Release

1.2

Required

Example

<TrackData>´111111111111111^SIMPSON/HOMER ^1612101106840000228000000?;4111111111111111=16121011068422800000?</TrackData>

Schema

<xsd:element name="TrackData">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation></xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:minLength value="43"/>

<xsd:maxLength value="226"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

ReferenceTransaction

Path: CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. ReferenceTransaction

Elements:

Schema

<xsd:element name= "ReferenceTransaction" >

<xsd:complexType >

<xsd:sequence >

<xsd:element ref= "OrderNumber" />

<xsd:element ref= "VaultGUID" />

</xsd:sequence >

</xsd:complexType >

</xsd:element>

OrderNumber

Name	OrderNumber
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. ReferenceTransaction. OrderNumber
Description	Prior transactions’ order number
Data Type	String
Range	36 characters [value as provided by previous transaction]
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.14
Required	No
Example	<OrderNumber> e5ea0f30-8556-42b7-a532-517957d5f1a8</OrderNumber>

Schema

<xsd:element name= "OrderNumber" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:maxLength value= "36" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

VaultGUID

Name	VaultGUID
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. ReferenceTransaction. VaultGUID
Description	Prior transactions’ VaultGUID
Data Type	String
Range	36 characters [value as provided by previous transaction]
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.14
Required	No
Example	<VaultGUID>GUID as reported by previous transaction</VaultGUID>

Schema

<xsd:element name= "VaultGUID" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:length value= "36" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

Check

Path: CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check

Elements:

Schema

<xsd:element name= "Check" >

<xsd:complexType >

<xsd:sequence >

<xsd:element ref= "AccountNumber" />

<xsd:element ref= "AccountType " />

<xsd:element ref= "RoutingNumber" />

<xsd:element ref= "CheckNumber" />

<xsd:element ref= "CheckType" />

<xsd:element ref= "NameOnAccount" minOccurs="0" />

<xsd:element ref= "IdType" minOccurs="0" />

<xsd:element ref= "IdNumber" minOccurs="0" />

<xsd:element ref= "IdStateCode" minOccurs="0" />

</xsd:sequence >

</xsd:complexType >

</xsd:element>

AccountNumber

Name	AccountNumber
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. AccountNumber
Description	Payee’s bank account number
Data Type	String
Range	Minimum: 1 character Maximum: 17 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.14
Required	No
Example	<AccountNumber >123456789</ AccountNumber >

Schema

<xsd:element name= "AccountNumber" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:minLength value= "1" />

<xsd:maxLength value= "17" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

AccountType

Name	AccountType
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. AccountType
Description	Type of account
Data Type	String
Range	SavingsAccount, CheckingAccount
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.14
Required	No
Example	<AccountType>CheckingAccount</AccountType>

Schema

<xsd:element name= "CheckType" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:enumeration value= "Company" />

<xsd:enumeration value= "Personal" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

RoutingNumber

Name	RoutingNumber
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. RoutingNumber
Description	Bank routing number
Data Type	String
Range	Maximum 9 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.14
Required	No
Example	<RoutingNumber>123456789</RoutingNumber>

Schema

<xsd:element name= "RoutingNumber" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:length value= "9" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

CheckNumber

Name	CheckNumber
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. CheckNumber
Description	Check number
Data Type	String
Range	Maximum 10 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.14
Required	No
Example	<CheckNumber>12345</CheckNumber>

Schema

<xsd:element name= "CheckNumber" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:maxLength value= "10" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

CheckType

Name	CheckType
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. CheckType
Description	Type of account
Data Type	String
Range	Company, Personal
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.14
Required	No
Example	<CheckType >Personal</CheckType>

Schema

<xsd:element name= "CheckType" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:enumeration value= "Company" />

<xsd:enumeration value= "Personal" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element >

NameonAccount

The following nodes are required for ACH transactions through the Global Payments gateways and will be ignored for Transfirst, ClearCommerce, and Authorize.NET

Name	NameonAccount
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. NameonAccount
Description	Name as it appears for the account
Data Type	String
Range	Minimum: 0 character Maximum: 100 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.21
Required	No
Example	<NameonAccount>John Smith</NameonAccount>

Schema

<xsd:element name= "NameOnAccount" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:maxLength value= "100" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

IdType

Name	IdType
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. IdType
Description	Type of ID used
Data Type	String
Range	Minimum: 0 character Values: Driver, Military, State
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.21
Required	No
Example	<IdType>Driver</IdType>

Schema

<xsd:element name= "IdType" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:enumeration value= "Driver" />

<xsd:enumeration value= "Military" />

<xsd:enumeration value= "State" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element >

IdNumber

Name	IdNumber
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. IdNumber
Description	ID number, e.g. Driver license number
Data Type	String
Range	Minimum: 0 character Maximum: 30 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.21
Required	No
Example	<IdNumber>Driver</IdNumber>

Schema

<xsd:element name= "IdNumber" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:maxLength value= "30" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element>

IdStateCode

Name	IdStateCode
Path	CnPAPI.Engine.Request.Order.CardHolder.PaymentMethod. Check. IdStateCode
Description	The state where the ID has been issued
Data Type	String
Range	Minimum: 0 character Maximum: 3 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.21
Required	No
Example	<IdStateCode>VA</IdStateCode>

Schema

<xsd:element name= "IdStateCode" >

<xsd:simpleType >

<xsd:annotation >

<xsd:documentation />

</xsd:annotation >

<xsd:restriction base= "xsd:normalizedString" >

<xsd:maxLength value= "3" />

</xsd:restriction >

</xsd:simpleType >

</xsd:element >

↧

Create-Event :: Version2.6

October 20, 2014, 5:00 pm

≫ Next: Events :: Version3.7

≪ Previous: PaymentMethod :: Version3.1

Before creating an Event, make sure you have followed the Event Management Installation and Post Installation Instructions posted in the prerequisites below:

Prerequisites:

Install and deploy Click and Pledge's Event Management Application. Event Management Installation Instructions
Go through the Event Management Post Installation instructions including creating a URL site. Event Post Installation Instructions

After creating an event, you may add additional features such as an Event Listing page, Discounts, Custom Fields, and Contact Information Fields.

Note:

To view Event page: Before you can view your event; you must create and save an event and have at least one registration level.

↧

Events :: Version3.7

October 20, 2014, 5:00 pm

≫ Next: Installation :: Version3.1

≪ Previous: Create-Event :: Version2.6

Table of Contents [ Hide]

Events

Basic Information

Additional Information

Swiper1 Global Access

Event Settings

With Click & Pledge Event Management release 2.x all event management is under one "C&P Event Management" tab

To create a new event select the Create New Event button.

Create or Manage Events

Events

Once you have created events you can click on the name to manage your event. Click the plus sign [+] to view and manage the sections. Use filter to show all or some events. Upcoming Events will show events that have a start date greater than today's date. Archived Events will show events whose end date has passed. Active Events are all events who have not reached their end date.

Basic Information

Enter all the basic event details. In Basic Information are all the mandatory fields that need to be completed to create an event. All other sections like Additional Information, Messages, Discount Plans, etc. allow for customization but they do not need to be setup for the event to work.

Event Details

Event Name (Internal)*
Event Name (External)*
Salesforce Public Site URL*: Instructions to set up your Salesforce Public Site URL are in the Post Installation Instructions. In order to use the Click & Pledge Event Management Application you must complete the post installation instructions
Event Template*: Select any template from the list. After your event is created you may customize it, choose another template, or create your own template.
Total Inventory: (Optional) You may enter an inventory for the total number of attendees for the event. Inventories may be set for registration levels as well, but total number of registrations sold cannot exceed this number.
Anonymous: Events will be considered ‘Named’ unless the ‘Anonymous’ option is selected. With Named events, for each ticket sold first name, last name and email address needs to be entered for each ticket. For Anonymous events, multiple tickets can be purchased without providing this information. Contact creation for each named attendee will follow your Match Mode settings within the C&P Settings tab under Contact & Account.
Registration Timeout*
Registration Timer Hide: If selected the timer will be hidden.
Mode*: Active - ready to process transactions; Inactive –cannot be viewed and link will show inactive message; Test – may run test transactions with demonstration credit card number (4111111111111111)

Event Date and Time - Use the calender to select these dates

Start Date*: Event Start Date
End Date*: Event End Date
Publish Date*: Date the event will show on the website

Pricing/Registration Level –at least one registration level must be created for each event

Registration Fields Visibility - Use dropbox to hide field(s) on the registration form

C&P Account

C&P Account – If your organization has multiple Click & Pledge accounts, select the account you wish to use for this event. If you want to offer multiple accounts use 'Add Account' button.

C&P Account Name- This field will only show if more than 1 Click & Pledge account available. You may wish to use this label to note a currency or define your account. E.g. $

Payment Type – Select payment types for this event. These payment types must be active within your Click & Pledge account to be accepted for your events. To review your payment options within your Click & Pledge account you can access them by

Login to Click & Pledge portal: https://portal.clickandpledge.com/
then go to Account Info>Accepted Cards

Custom Payment – If you wish to name other payment types, like Cash or Check

Add Account – If you have multiple Click & Pledge accounts you may add additional accounts then allow patrons to select an account. Display Label appears if you have multiple accounts. It allows you to distinguish between the accounts. An example, maybe you have accounts in different regions you may identify them by their region. Or if accounts are in different countries, you may want to distinguish by currency.

Account Selector Label – If offering multiple accounts then enter text to show above your accounts. E.g. Select Currency, Select your region, Select your local association

Always click SAVE to save any changes.

Additional Information

Here you may customize Event and Levels. Use the radio buttons to access either Event or Levels. All customization here is optional.

Event

Detailed Address: Enter in the address information to be used for map for event. Display Address fields allows you to customize location text on map.

Other Details:

Event Coordinator
Category
Campaign
Iframe Code – Iframe code for event is provided
Agenda (PDF only) – upload a PDF file
Agenda Display Name
Event Description - uses editor to enter event description
Additional Donation – if checked allow patrons to make a donation with registration. If accepting then must add Label for donation.

Label For Additional Donation
SKU For Additional Donation
Tax Deductible %
Campaign For Additional Donation

Always click SAVE to save any changes.

Levels

Select a level to edit the following

Name on Reports*
Report Color
SKU Code
Campaign
Level Description

Always click SAVE to save any changes.

Discount Plans

Create an unlimited number of discount plans. Discount plans may be layered

Discount plans are applied to registration levels or event
May be batch uploaded
Discounts by %, Fixed discount or a combination of both
Required Start and End date
Inventory
Coupon code
Group discount

Always click SAVE to save any changes.

Designer

Customize your event page, tickets and name badges with Designer.

Registration form – Map payee and registrant information fields. Create and manage custom questions.
Widgets – create widgets for your online form for information like weather, maps, etc. If widget type is single, then will show on page. If tabbed- will show in tabbed section.
Site – Choose from Click & Pledge templates or create a custom template for your site. When layout selected, Merge Fields and editor will be provided.
Tickets – Choose from Click & Pledge ticket templates or customize tickets for your event. When layout selected Merge Fields and editor will be provided.
Name Badges - Choose from Click & Pledge name badge templates or customize name badges for your event. When layout selected Merge Fields and editor will be provided.

Messages

Customize message for Event and Levels. This includes messages displayed during registration/payment process and on automated email receipts (if send receipt is selected).

Event

Messages
Sold Out
Event Ended
Payment
Show Terms & Conditions
Acknowledgement Mandatory
Terms & Conditions Text
Thank You
Payment Declined
Default System Receipt
Send Receipt – If choosing to send receipt Click & Pledge will email an itemized receipt to registrant. If sending default receipt you have the option of customizing the following:
Organization Information: Add your organization's language and contact information
Thank You Message: Customize your Thank You message
Terms & Conditions: Enter a Terms & Conditions message
Internal Notification: Enter email addresses of those who need to be alerted when transactions occur. Emails on list will be sent a copy of the receipt when a transaction occurs. Separate all emails with a semicolon (;).
Registrant & Attendee Email Notification

Levels- select a level and customize that level’s Sold Out message. Sold Out message will show if inventory is depleted for that level.

Always click SAVE to save any changes.

Check In & Check Out

Check In and Check out attendees using status menu box

Swiper1 Access: Allows Click & Pledge users to check in and check out attendees.

Registrations

Review Registrants, send registration email, and access Temporary Contacts to manage any registrants who are not current Contacts in Salesforce.

Box Office

In Box Office you can manually add attendees to events.

Event Listings

C&P Event Listing is a Parent Page for your events. You may create an unlimited number of Event Listing pages and each Event Listing Page can show an unlimited number of events. So for example, you may wish to have an Event Listing Page for Conferences and a separate one listing your Fundraising Events.

Swiper1 Global Access

Add and manage individuals to enable them to Check In and Check Out event attendees.

Before adding a user to this section, the individual must first be enabled with your Click & Pledge administrative system. To enable someone with your Click & Pledge administrative system, you need to

Event Settings

This area will list of all devices that have requested authorization to access Events using Swiper1. Select the edit button for each device to view the events the device is authorized to Check In/Check out.

↧

Installation :: Version3.1

October 27, 2014, 6:28 pm

≫ Next: Admin :: Version1.1

≪ Previous: Events :: Version3.7

Table of Contents [ Hide]

App Installation

Salesforce Integration (optional)

Inside Salesforce

Connect the Swiper1

Enabling Swiper1 in the Click & Pledge Application

Inside Click & Pledge

App Installation

Swiper1 requires an active Click & Pledge account. If you need an account Apply Here. Install the Swiper1 app through the Android Play Store or iTunes App Store. Following the App installation instructions provide on the store you select.

The illustrated QR Code is a direct link to the Google Play Store for Swiper1.

Once installed the application may be used for manual credit card processing without any need for the Swiper1 hardware. No additional fees for manual entry. If using the Swiper1 device, credit cards may be processed by swiping the card.

Salesforce Integration (optional)

Inside Salesforce

Swiper1 checks all contacts in Salesforce and retrieves first 10 contacts with the same first name and last name. The contacts are displayed and may be selected through a radio button listing.

Connect the Swiper1

In order for Swiper1 to have access to Salesforce, Connect App should be set up first. Follow the steps listed below to enable the App access within Salesforce.

Login to Salesforce
Go to Setup> App Setup > Create > Apps > Connected Apps > New

Setting up New App gives Swiper1 access to the Salesforce instance through an active web service. A security token and passcode needs to be set up in Click & Pledge's portal. But before setting up Swiper1 within Click & Pledge's portal, various fields need to be completed.

Connected App Name: Swiper1 (name for internal use only and may be labeled according to internal policies)
API Name: Swiper1
Contact Email: Organization's Admininistrator Email Address
Enable the OAuth Settings
Callback URL: This is the most important setting and has to be set up exactly as listed: https://portal.clickandpledge.com/YourAccount/default.aspx
Selected OAuth Scopes: Full access(full) + Perform requests on your behalf at any time (refresh_token)
Click on SAVE and exit

To retrieve the Consumer Key & Consumer Secret click on the app name in the listing screen. Follow the path below to move:

Go to Setup> App Setup> Create > Apps > Connected Apps > Click on Swiper1

Apps

You will see the following screen. Here you can get the Consumer Key and the Consumer Secret. To get the Consumer Secret select 'Click to reveal.'

Enabling Swiper1 in the Click & Pledge Application

Once the Swiper1 App has been enabled, Swiper1 needs to be activated in the C&P Settings.

Click on C&P Settings
Click on Swiper1 tab
Check the Activate Swiper1 checkbox
Click on Update Swiper1

Once activated in Salesforce, login to the Click & Pledge portal and follow the listed steps to enable cross talk between Swiper1 app > Click & Pledge > Salesforce.

Inside Click & Pledge

The Swiper1 app retrieves the necessary credentials from the Click & Pledge web-services. To establish connection follow the steps listed below:

Login to the Click & Pledge administrative portal [https://portal.clickandpledge.com]
Click on Account Info > 3rd Party > Salesforce Swiper1
Enter the Salesforce instance URL for the account to be connected. Example: https://na9.salesforce.com (The primary URL need to be used without the information followed after the first /)
Copy the Consumer Key and Consumer Secret from Salesforce in the previous step.
Click on Verify connection to establish connection.
A new tab will be opened with Salesforce login page.
Login to Salesforce to verify connection
Upon confirmation save the settings and exit.

↧

Admin :: Version1.1

October 27, 2014, 6:28 pm

≫ Next: Transaction :: Version10.1

≪ Previous: Installation :: Version3.1

Get Started

Once you have committed to your Give Big site you can provide any of the following information to Click & Pledge to initially set up your site. This includes:

Accent color for site (Mandatory)
Logo image - Please send the Give Big or organization logo that will be placed on the left side of the main header - preferably transparent background in .tiff, .gif, .png, or .eps format.
Images for carousel - 1-4 images for the top home page carousel. Recommended image size in pixels 893x457; 72dpi; Max File Size: 150KB; .png, .jpg or .gif formats.
Pages - Provide titles and page content for any pages to be created and state where pages should be located (header, lower page, footer sections).
Cause List – Provide Cause List header name and labels for columns.

All items listed above, with the exception of accent color, can be edited by you at any time by logging into the Give Big platform and making changes.

To Login

Note: At any time you may login to your Give Big platform and make edits as needed.

To login go to upper right corner and click on the circle with 3 lines.

Select Organization Sign In, enter your Click & Pledge email and password for your account, click Sign In button.

Once within the site, you will go to your profile page. To edit your profile page click ‘Edit Profile’ button.

The primary settings for your Give Big site are located in the Header Settings on the homepage. To get to the home page, click on the your Give Big logo at top left of page.

get to homepage

Header Settings

Header Settings are managed using the Setting button at top of home page, below logo and above photo carousel.

Header Settings

Within Header Settings you have access to the following:

Header Setting Tabs

Social Network URL: Enter your links for your social media sites. Use entire url including http:// or https://

Default Share messages: Enter share message, or default messages supporters can share on their social media sites. Here you may also upload a default image for share messages.

SEO: Search engine optimization (SEO) is the process of affecting the visibility of a website or a web page in a search engine's search results by adding descriptions and keywords. Please note that although SEO helps your page visibility with the search engines, it does not guarantee it.

Script: Text placed in the following field will be added to the line before the </HEAD> tag. It may be used for addition of web analytics script such as Google Analytics. Please note that addition of this tag may adversely affect the site performance. Placement of any script in this section is the sole responsibility of the organization. It is highly recommended that you perform testing of the site performance prior to any high profile campaign.

Carousel: Upload images for the rotating carousel. Note the size requirements especially the file size. An image with too large a file size can slow the loading of the home page and adversely affect the site.

Header: Manages the look of the homepage header. HTML code is used to control the layout of the header. A counter can be added by entering {Total}

Config: Opt to show or hide comments on the homepage. Comments appear to the right of recent donations. Enter text to appear inside search bar.

Campaign: This area only appears if you have a countdown date set for the start of your campaign counter will appear on the top bar until the start date. Total Seed Value allows you to add a fixed amount to your campaign total.

Download activity: Will give the list of your campaign’s participating organizations, their total raised and transaction count.

Tribute (Optional Section): Click Customize Tribute button to opt to hide or show tribute widget.

Tribute button

Cause List (Optional Section): Click Customize Cause List button to access this section. This section allows you to showcase some organizations based on sectors and/or fundraising status. Up to 6 organizations can be listed in each column and the list will refresh as the page refreshes. You can opt to show or hide Cause List area. Widget Header titles the cause list section. And by column you can manage the information that shows using filters for tags, keywords, total raised, and by ascending, descending or random order.

Cause List

Sponsors (Optional Section): WYSIWYG editor for listing or showing sponsor logos. Here you may showcase sponsor logos on the website’s homepage with the option to link the logo to the sponsor’s website. Image formats need to be .png or .gif. We recommend image size to be less than 100 KB. Large images take longer to load and may slow down the site.

Sponsor Button

Lower Page Setting: WYSIWYG editor for text, images and listing pages with links. This section contains information about your Give Big event, contact information, and information for the participating organizations and donors. You may create as many pages as needed and provide titles with links in this section.

Lower Page Setting

Footer: Click Footer Setting button WYSIWYG editor for text and listing pages with links.

Footer Setting

↧

Transaction :: Version10.1

December 30, 2014, 8:50 am

≫ Next: Post-Installation :: Version4.2

≪ Previous: Admin :: Version1.1

CnPAPI.Engine.Request.Order.Transaction

Elements:

TransactionType
DynamicDescriptor
Recurring
CurrentTotals
CouponCode
TransactionDiscount
TransactionTax
TransactionConvenienceFee
ChargeDate
CustomParameters
ReferenceTransaction
GiftCardList

Schema

<xsd:element name="Transaction">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="TransactionType" minOccurs="0"/>

<xsd:element ref="DynamicDescriptor" minOccurs="0"/>

<xsd:element ref="Recurring" minOccurs="0"/>

<xsd:element ref="CurrentTotals" minOccurs="0"/>

<xsd:element ref="CouponCode" minOccurs="0"/>

<xsd:element ref="TransactionDiscount" minOccurs="0"/>

<xsd:element ref="TransactionTax" minOccurs="0"/>

<xsd:element ref="TransactionConvenienceFee" minOccurs="0"/>

<xsd:element ref="ChargeDate" minOccurs="0"/>

<xsd:element ref="CustomParameters" minOccurs="0"/>

<xsd:element ref="ReferenceTransaction" minOccurs="0"/>

<xsd:element ref="GiftCardList" minOccurs="0"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

Example

<TransactionType>Authorize</TransactionType>

<DynamicDescriptor>DynamicDescriptor | Phone</DynamicDescriptor>

<Periodicity>2 Months</Periodicity>

</Recurring>

</CurrentTotals>

</Transaction>

TransactionType

Name	TransactionType
Path	CnPAPI.Engine.Request.Order.Transaction.TransactionType
Description	The type of transaction this order represents.
Data Type	String
Range	Authorize: Transaction will not settle and will need to be settled manually. Payment: Transaction posted as settled and is final.
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	Yes
Example	<TransactionType>Payment</TransactionType>

Schema

<xsd:element name="TransactionType">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>The type of transaction this order represents.</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:enumeration value="Authorize"/>

<xsd:enumeration value="Payment"/>

<xsd:enumeration value="PreAuthorization"/>

</xsd:restriction>

</xsd:simpleType>
</xsd:element>

DynamicDescriptor

Name	DynamicDescriptor
Path	CnPAPI.Engine.Request.Order.Transaction.DynamicDescriptor
Description	The name that appears on the card holder’s statement.
Data Type	Minimum: blank Maximum: 39 characters
Range	Maximum 39characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	It is required only for In-house account. Ignored for the merchant accounts.
Example	<DynamicDescriptor>Campaign of VA \| 5409619811</DynamicDescriptor>

IMPORTANT POINT:

The dynamic descriptor has to include the phone number where a card holder may contact the organization. It has to be similar to the example provided.

Schema

<xsd:element name="DynamicDescriptor">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>The name that appears on the card holder’s statement.</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:maxLength value="39"/>

</xsd:restriction>

</xsd:simpleType>
</xsd:element>

Recurring

CnPAPI.Engine.Request.Order.Transaction.Recurring

Elements:

Schema

<xsd:element name="Recurring">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="Installment" minOccurs="0"/>

<xsd:element ref="EndDate" minOccurs="0"/>

<xsd:element ref="Periodicity"/>

<xsd:element ref="RecurringMethod" minOccurs="0"/>

</xsd:sequence>

</xsd:complexType>
</xsd:element>

Example

<Periodicity>2 Months</Periodicity>

</Recurring>

Installment

CnPAPI.Engine.Request.Order.Transaction.Recurring.Installment

Name	Installment
Path	CnPAPI.Engine.Request.Order.Transaction.Recurring.Installment
Description	The number of times a payment will be replicated.
Data Type	Int16
Range	Minimum: 2 Maximum: 999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	No
Example	<Installment>6</Installment>

Schema

<xsd:element name="Installment">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>The number of periods the transaction should be repeated.</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:integer">

<xsd:minInclusive value="2"/>

<xsd:maxInclusive value="999"/>

</xsd:restriction>

</xsd:simpleType>
</xsd:element>

EndDate

CnPAPI.Engine.Request.Order.Transaction.Recurring.EndDate

Name	EndDate
Path	CnPAPI.Engine.Request.Order.Transaction.Recurring.EndDate
Description	The date when the recurring payments should end.
Data Type	String
Range	dd/mm/yy
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.90
Required	No [optional – ignored if Installment is used. Use in place of periodicity.
Example	<EndDate>15/01/09</EndDate>

Schema

<xsd:element name="EndDate">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>yy/mm/dd</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:pattern value="[0-9][0-9]/[0-9][0-9]/[0-9][0-9]"/>

</xsd:restriction>

</xsd:simpleType>
</xsd:element>

Periodicity

CnPAPI.Engine.Request.Order.Transaction.Recurring.Periodicity

Name	Periodicity
Path	CnPAPI.Engine.Request.Order.Transaction.Recurring.Periodicity
Description	The period for the recurring transaction. After the first transaction, all subsequent charges will occur with this period. Credit card expiration date will be checked for validity based on the period and installments.
Data Type	String
Range	It must be one of the following Week 2 Weeks Month 2 Months Quarter 6 Months Year
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.2
Required	No. Use either periodicity or EndDate when posting recurring transaction.
Example	<Periodicity>2 Months</Periodicity>

Schema

<xsd:element name="Periodicity">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>The period for the recurring transaction. After the first transaction, all subsequent charges will occur with this period. Credit card expiration date will be checked for validity based on the period and installments.</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:enumeration value="Week"/>

<xsd:enumeration value="2 Weeks"/>

<xsd:enumeration value="Month"/>

<xsd:enumeration value="2 Months"/>

<xsd:enumeration value="Quarter"/>

<xsd:enumeration value="6 Months"/>

<xsd:enumeration value="Year"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

RecurringMethod

CnPAPI.Engine.Request.Order.Transaction.Recurring.RecurringMethod

Name	RecurringMethod
Path	CnPAPI.Engine.Request.Order.Transaction.Recurring.RecurringMethod
Description	The recurring method used. The value will ONLY be used for reporting.
Data Type	String
Range	It must be one of the following Installment Subscription
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.24
Required	No. - value is only used in the report
Example	<RecurringMethod>Subscription</RecurringMethod>

Schema

<xsd:element name="RecurringMethod">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation></xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:enumeration value="Installment"/>

<xsd:enumeration value="Subscription"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

CurrentTotals

CnPAPI.Engine.Request.Order.Transaction.CurrentTotals

Elements:

TotalDiscount
TotalTax
TotalShipping
TotalDeductible
Total

Schema

<xsd:element name="CurrentTotals">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="TotalDiscount" minOccurs="0"/>

<xsd:element ref="TotalTax" minOccurs="0"/>

<xsd:element ref="TotalShipping" minOccurs="0"/>

<xsd:element ref="TotalDeductible" minOccurs="0"/>

<xsd:element ref="Total"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

TotalDiscount

CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalDiscount

Name	TotalDiscount
Path	CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalDiscount
Description	Sum of all individual discounts applied for each item in the list.
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.20
Required	No
Example	<TotalDiscount>1000</ TotalDiscount >

Schema

<xsd:element name="TotalDiscount">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total discount applied to the order</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

TotalTax

CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalTax

Name	TotalTax
Path	CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalTax
Description	Total tax applied to the transaction
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.20
Required	No
Example	<TotalTax>1000</TotalTax >

Schema

<xsd:element name="TotalTax">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total tax for the order</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

TotalShipping

CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalShipping

Name	TotalShipping
Path	CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalShipping
Description	Total cost of shipping for the transaction
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.20
Required	No. - value is only used in the report
Example	< TotalShipping>1000</TotalShipping>

Schema

<xsd:element name="TotalShipping">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total shipping cost for the order</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

TotalDeductible

CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalDeductible

Name	TotalDeductible
Path	CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.TotalDeductible
Description	Total tax deductible portion for the transaction
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.20
Required	No
Example	<TotalDeductible>2500</TotalDeductible >

Schema

<xsd:element name="TotalDeductible">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total tax deductible portion of the order</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

Total

CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.Total

Name	Total
Path	CnPAPI.Engine.Request.Order.Transaction.CurrentTotals.Total
Description	Total transaction amount
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	1.20
Required	Yes
Example	<Total>3500</Total >

Schema

<xsd:element name="Total">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total amount to be charged.</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

CouponCode

Name	CouponCode
Path	CnPAPI.Engine.Request.Order.Transaction.CouponCode
Description	The type of transaction this order represents.
Data Type	String
Range	Min: 0 Max: 50 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.32
Required	No
Example	<CouponCode>ABCDEF-500</CouponCode >

Schema

<xsd:element name="CouponCode">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation></xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:maxLength value="50"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

TransactionDiscount

Name	TransactionDiscount
Path	CnPAPI.Engine.Request.Order.Transaction.TransactionDiscount
Description	The type of transaction this order represents.
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.48
Required	No
Example	< TransactionDiscount>500</TransactionDiscount>

Schema

<xsd:element name="TransactionDiscount">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total discount applied to the transaction</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

TransactionTax

Name	TransactionTax
Path	CnPAPI.Engine.Request.Order.Transaction.TransactionTax
Description	Tax associated with the entire transaction
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.48
Required	No
Example	<TransactionTax>123</ TransactionTax>

Schema

<xsd:element name="TransactionTax">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total tax applied to the transaction</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>
</xsd:element>

TransactionConvenienceFee

Name	TransactionConvenienceFee
Path	CnPAPI.Engine.Request.Order.Transaction.TransactionConvenienceFee
Description	Total convenience fee applied to the transaction
Data Type	long
Range	Min: 0 Max: 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.50
Required	No
Example	<TransactionConvenienceFee>456</TransactionConvenienceFee>

Schema

<xsd:element name="TransactionConvenienceFee">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>Total convenience fee applied to the transaction</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

ChargeDate

Name	ChargeDate
Path	CnPAPI.Engine.Request.Order.Transaction.ChargeDate
Description	The date the transaction should be processed.
Data Type	date
Range	YY/MM/DD
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.48
Required	No
Example	<ChargeDate>12/01/30</ChargeDate>

Schema

<xsd:element name="ChargeDate">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>yy/mm/dd</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:pattern value="[0-9][0-9]/[0-9][0-9]/[0-9][0-9]"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

ReferenceTransaction

CnPAPI.Engine.Request.Order.Transaction.ReferenceTransaction

Elements:

OrderNumber
VaultGUID

Schema

<xsd:element name="ReferenceTransaction">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="OrderNumber"/>

<xsd:element ref="VaultGUID"/>

</xsd:sequence>

</xsd:complexType>
</xsd:element>

OrderNumber

Name	OrderNumber
Path	CnPAPI.Engine.Request.Order.Transaction.ReferenceTransaction.OrderNumber
Description	The order number for the previous transaction
Data Type	String
Range	Max = 36 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.48
Required	No
Example	< OrderNumber>123456</OrderNumber>

Schema

<xsd:element name="OrderNumber">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation/>

</xsd:annotation>

<xsd:restriction base="xsd:normalizedString">

<xsd:maxLength value="36"/>

</xsd:restriction>

</xsd:simpleType>
</xsd:element>

VaultGUID

Name	VaultGUID
Path	CnPAPI.Engine.Request.Order.Transaction.ReferenceTransaction.VaultGUID
Description	The VaultGUID for the previous transaction
Data Type	String
Range	Max = 36 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.48
Required	No
Example	<VaultGUID>ABCD1234EGFDF4444</VaultGUID>

Schema

<xsd:element name="VaultGUID">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation/>

</xsd:annotation>

<xsd:restriction base="xsd:normalizedString">

<xsd:length value="36"/>

</xsd:restriction>

</xsd:simpleType>
</xsd:element>

GiftCardList

CnPAPI.Engine.Request.Order.Transaction.GiftCardList

Elements:

GiftCard

Schema:

<xsd:element name="GiftCardList">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="GiftCard" maxOccurs="unbounded"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

GiftCard

CnPAPI.Engine.Request.Order.Transaction.GiftCardList.GiftCard

Elements:

GiftCardCode
GiftCardAmount

Schema

<xsd:element name="GiftCard">

<xsd:complexType>

<xsd:sequence>

<xsd:element ref="GiftCardCode"/>

<xsd:element ref="GiftCardAmount"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

GiftCardCode

Name	GiftCardCode
Path	CnPAPI.Engine.Request.Order.Transaction.GiftCardList.GiftCardCode
Description	The code for the gift card discount card
Data Type	String
Range	Max = 50 characters
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.48
Required	No
Example	<GiftCardCode>ABCDE123456</GiftCardCode>

Schema

<xsd:element name="GiftCardCode">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation>GiftCardCode</xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:string">

<xsd:maxLength value="50"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

GiftCardAmount

Name	GiftCardAmount
Path	CnPAPI.Engine.Request.Order.Transaction.GiftCardList.GiftCardAmount
Description	The gift card’s discount amount
Data Type	long
Range	Min = 0 Max = 9999999999
Default
Operation	Transaction Operation only
Input/output	Input
Version/Release	2.48
Required	No
Example	<GiftCardAmount>123</GiftCardAmount>

Schema

<xsd:element name="GiftCardAmount">

<xsd:simpleType>

<xsd:annotation>

<xsd:documentation></xsd:documentation>

</xsd:annotation>

<xsd:restriction base="xsd:long">

<xsd:minInclusive value="0"/>

<xsd:maxInclusive value="9999999999"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

↧

Post-Installation :: Version4.2

December 30, 2014, 8:50 am

≫ Next: Swiper1 :: Version2.4

≪ Previous: Transaction :: Version10.1

Table of Contents [ Hide]

Step 1: Add C&P Account Info to C&P Settings

Step 2: Set up Contact matching Preferences

Step 3: Set up ‘Contact & Account’ Mapping Preferences

Step 4: Update Setting on Contact Layout Pages

Step 4a: Add 'C&P Miscellaneous Information' Visualforce Page to Contact View page

Step 4b: Place Virtual Terminal button & Invoice Virtual Terminal button in Patron/Contact Detail page

Step 4c: Place 'Related Lists' on Patron/Contact Detail Page

Step 4d: Place 'Fields' on Patron/Contact Detail Page

Step 4e: Disable 'New Button' on following related lists

Step 5: Settings for using Opportunity Products

Step 6: Update Setting on Opportunity Layout Page

Step 6a: Place 'Fields' on Opportunity Detail Page

Step 7: Site Creation

Step 8: Mail Chimp Integration

Step 1: Add C&P Account Info to C&P Settings

Go to C&P Settings > C&P Account to add your Click & Pledge accounts. There is no limit on the number of Click & Pledge accounts that may be added a single Salesforce.com instance.
Step 1 CAP Account

Hint: If you do not see the C&P Settings tab you can access it by clicking on the + sign on the very right end of your tabs area. This will bring up all your tabs.

C&P Account Name - Name this whatever you wish. This is used for your internal reference.
C&P Account Number - This is your Click & Pledge Account Number. See below for instructions to find.
C&P Account GUID - This number is located in your Click & Pledge Account. See below for instructions to find.
C&P Account Status - Select from drop down menu your Click & Pledge Account Status.
C&P Account Currency Code - Select from drop down menu your Click & Pledge Account Currency Code

Once you enter the above information, click 'Add/Update.' Once Account is created it can be modified by clicking 'Edit'. Or deleted by clicking 'Del'.
To find your Click & Pledge Account information you need to:

Login to you Click & Pledge Account at https://portal.clickandpledge.com/
Click on the 'Account Info' in upper right corner
Under 'Your Profile' tab, click 'API Information'
Find Account ID (C&P Account Number) and API (PaaS/FaaS) Account GUID (C&P Account GUID)

Refer to the following image:
CAP Admin

Step 2: Set up Contact matching Preferences

Within C&P Settings, go to Contact & Account tab to set up preferences

With Contact Matching you can customize when your Contacts are to be created by choosing a Match Mode and selecting which field(s) you wish to include. This allows an organization complete control of Contact Creation which will eliminates duplicate Contacts.

Note: Most organization should find that the Semi Automatic mode will work best to reduce duplicates. Transactions will be added to a Contact when fields match and then organization will use C&P Temporary Contact tab to determine how to handle all Contacts who do not match.

Match Mode - Choose a mode. With Contact Settings there are 3 modes to choose from:

Fully Automatic Contact Creation - A transaction will be placed under an existing Contact when one of the selected fields within each of your chosen columns is matched. If a transaction does not meet the selected criteria then a new Contact is created.
Semi Automatic Contact Create - A transaction will be placed under an existing Contact when one of the selected fields within each of your chosen columns is matched. If a transaction does not meet the selected criteria then it will be created in C&P Temporary Contact.
Manual Contact Creation - Every transaction will create a contact within C&P Temporary Contact.

C&P Temporary Contact tab will allow you to choose to create a new contact or merge with an existing contact.

Match Fields: Select field(s) you wish to have the Contact search select from. For columns, you can choose one or more fields. To select more than one field in a column, select <CTRL> key then select fields. A Contact will need to match one field within each column. Only choose fields within the columns you wish to have included in the search. See example below:

Match Fields

Step 3: Set up ‘Contact & Account’ Mapping Preferences

Step 4: Update Setting on Contact Layout Pages

To setup all settings, go to 'Contact Page Layout' page first. The path is shown below:
Click 'Setup' > App Setup > Customize > Contacts > Page Layouts > Click Edit beside 'Contact Layout'
Step 4 Set up

Step 4a: Add 'C&P Miscellaneous Information' Visualforce Page to Contact View page

Completing Step 4a will allow you to view Credit Card & eCheck payments, Manual Opportunity Settlement and Soft Credits on your Contact's page.

At 'Contact Layout' move to 'Visualforce pages' section. Drag the section icon to create a new section. Name it C&P Info. then drag C&P Miscellaneous to that section.

After adding this page, you can observe the effect at Contact Detail Page:

Step 4b: Place Virtual Terminal button & Invoice Virtual Terminal button in Patron/Contact Detail page

Follow the path below. [This setting is also under Contact Layout (you can refer back 1st image)]

At 'Contact layout', select 'Buttons' section. Find 'Virtual Terminal' button.

Drag that button into 'Custom Buttons' area under 'Contact Detail' section. See below:

After placing the Virtual Terminal Button, click Save.

After adding this button, you can observe the changes on Contact Detail Page. See below:
Step 4B Contact Layout

Step 4c: Place 'Related Lists' on Patron/Contact Detail Page

At 'Contact Layout' select 'Related Lists' section. There find

C&P Autoresponder Queue
C&P Autoresponder Sent Email Log
C&P Contact Alias
C&P Custom Questions
C&P Data
C&P Recurrings
C&P Soft Credits Given
C&P Soft Credits Received
C&P Transactions
Opportunities
C&P Invoice
C&P Pledge
C&P Broadcaster Member Activity

Select and drag these Related Lists and place it an appropriate place (up to User convenience). For example, you can place it immediately below 'Custom Links' as in image below:
Step 4c Related Lists

Step 4d: Place 'Fields' on Patron/Contact Detail Page

At 'Contact Layout' select 'Fields' section. There find

C&P Connect Alias
C&P Alias Contact Data

Contact Layout Fields

Then Click on Save.

Step 4e: Disable 'New Button' on following related lists

'New Button' needs to be disabled for:

C&P Autoresponder Queue
C&P Autoresponder Sent Email Log

At ‘Contact Layout’, Move to ‘Related Lists’ section --> then move to the respective Related List Properties

Step 4e Related Lists

Related List Properties

Step 5: Settings for using Opportunity Products

Within C&P settings we have an option to “Use Products for each item in an Opportunity". Set this option ONLY if you are using the Opportunity>Product model. Most implementations do not use the Product model and as such this step may be skipped.

This option is located under C&P Settings > Opportunity

To enable this to work we have to make some settings changes at ‘Opportunity Settings’
Follow this path to move Opportunity Settings area,
Click Setup --> App Setup -->Customize ---> Opportunities---> Settings--->

Make sure to enable/check above option
Then click Save button

Step 6: Update Setting on Opportunity Layout Page

To add C&P Soft Credits to Opportunity Layout Page follow these instructions:
Click on Opportunities tab then select and an Opportunity

Recent Opportunities

Then select Edit Layout

Step 6a: Place 'Fields' on Opportunity Detail Page

At ‘Opportunity Layout' select 'Fields' section. There find

C&P Contact
C&P Order Number
C&P Payment Type
C&P Recurring ID
C&P SKU
C&P GL Account Number
C&P Class
C&P Sub Class
C&P Invoice
C&P Tax
C&P Tax Deductible
C&P Discount

Select following Related Lists, then individually drag it into page layout.

C&P Allocations
C&P Opportunity Pledge
C&P Soft Credits

Click SAVE

Step 7: Site Creation

Click & Pledge applications use a site for registration forms, invoices, autoresponder images, and more. A single site is all that is needed for all applications. There is no need to create multiple sites. All applications use variables at the end of the URL to identify the form.

To create a basic Force.com Site, you need to follow the following steps:

Register a domain name
Create a Force.com Site using the domain name

Registering a domain name

In order to create your sites you must first register your Force.com domain name. This only has to be done once. You should choose a domain name that represents your organization rather than a specific site.

Navigate to Setup | Develop | Sites and enter a domain name to use. You'll see a setup screen much like the following:

It is best to choose the your domain name as the basis for the site domain name. For example if your website address is: http://www.My-Company.com, use "My-Company" as the URL prefix to force.com as illustrated below:

Creating a Site

In Setup > Develop > Sites, click on the "New" button.

In "New Site" the following fields are important:

The important fields are:

Site Label - The name of the site as it appears in the user interface.
Site Name - The name used when referencing the site in the Force.com API.
Site Contact - The user responsible for receiving site-related communications from site visitors and Salesforce.com.
Default Web Address - The unique Force.com URL for this site. Salesforce.com provides the first part of the URL; you must create the suffix using only alphanumeric characters. We recommend using a generic name as this name will be used by all Click & Pledge products. Using a name as "default" may serve this purpose.
Active - Activates the site
Active Site Home Page - this points to the default Visualforce page to display when your site is active
Clickjack Protection Level - Specifies the type of framing allowed. If same origin framing is selected, site pages can only be iframed by the other pages on the same domain name and protocol security (HTTP or HTTPS). Allow framing by any page (no protection)
Salesforce feature note: http://docs.releasenotes.salesforce.com/en-gb/spring14/release-notes/rn_sitecom_clickjacking.htm

Click on "Save" to finish the site set up.

Public Access Settings

Click on "default" (site label as set in the previous step) in the Develop > Sites

Click on the "Public Access Settings" button

Click on the "View" link for the following Objects:

Contact
Opportunity

At "Field Level Security" > "Standard Field Level Security" set all fields as follows:

Set as "Visible" all fields in the "Contact" object

Set as "Visible" all fields in the Opportunity object

& finally for the "Standard Object Permissions" set the following permissions:

Personal Information Time Zone

Prior to setting the Guest User's Time Zone make sure the time zone set in the "Personal Information" is correct.

Guest User's Time Zone

In the Develop > Sites > Site Label (i.e. default) > Public Access Settings > View Users

Click on "View Users"

Click on the "Full Name":

Click on the "Edit" button

In the "Locale Settings" set the site's Time Zone matching the "Personal Information" Time Zone.

Permission Set Assignments

Click on "Edit Assignments" in the "Permission Set Assignments" section, at site guest user detail page

Permission Sets:

Enable the following permission sets. Additional permission sets may be available and used as needed. The following are essential for the proper implementation of the Event & Payment Management application:

PS-CnP-Event-ONLY-SiteGuestUser
PS-CnP-PaaS-ONLY-SiteGuestUser

Step 8: Mail Chimp Integration

Refer to this section for instructions: http://manual.clickandpledge.com/Versions-7-to-8-0.html#Step_10:_Mail_Chimp_Integration

↧

Swiper1 :: Version2.4

December 30, 2014, 8:50 am

≫ Next: Additional-Options :: Version3

≪ Previous: Post-Installation :: Version4.2

Swipe credit cards on your mobile smart phone. Events, gatherings, and more. Anywhere you want to accept credit cards in person.

The Swiper1 plugs directly into an Android or iPhone mobile phone through the audio-jack and processes credit cards securely in a few simple steps. The optional Salesforce integration provides identification of contact information by looking up the name listed on the credit card. All transactions are recorded and may be downloaded through the Click & Pledge portal as well as Salesforce.

Features:

Accept payments anywhere using your Android or iPhone mobile phone. For a list of tested devices please see: https://forums.clickandpledge.com/showthread.php?t=1395
Encrypted transactions, ensuring highest level of security and PCI compliance
Accept all major credit /debit cards [Visa, MasterCard, Discover, and American Express]
Fully integrated with Salesforce CRM + Salesforce Events attendee Check-in / Check-out.
QR-Scan Pay offering processing based on a previously processed transaction.
Recurring payments with customizable periods for both Installment & Subscription plans.
Free mobile virtual terminal.
Product catalogs and listings.
Allows for additional payments.
Real-time receipts – email, SMS (txt message) or print, compatible with portable Bluetooth printer.
Tax and tax deductible settings.
Custom questions compliant with FEC requirements.
Acceptance of Terms & Conditions with option to be included in the printed receipt.
Simple pricing model – no additional cost per transaction.
All standard Click & Pledge merchant account pricing applies.

↧

Additional-Options :: Version3

December 30, 2014, 8:50 am

≫ Next: Configuration :: Version3.9

≪ Previous: Swiper1 :: Version2.4

Table of Contents [ Hide]

General Settings

Cash Register Defaults

By default Swiper1 is setup to work with least restrictions. Upon installation Swiper1 is fully operational with appropriate login credentials. To customize Swiper1 follow the various setting options described below:

General Settings

The following options may be customized:

Require signature for all transactions (ON / OFF): In ON position signature will be required.

Require signature for transactions over $: A lower limit may be set for signature. All transactions over the lower limit will require a signature while transactions below the limit will NOT require a signature.

Sales tax option (%): In ON position all transactions will incur an added tax. In the following example a 6% tax will be added to all transactions by default. The calculated tax may be edited during the transaction process.
Tax deductible option (%): In ON position the percentage of the transaction that is tax deductible will be displayed. In the following example 50% of all payments will be tax deductible. The tax deductible portion will appear in the receipt.
Tracker: Trackers will be saved and may be downloaded through the reporting portal. The TEXT entered in the Tracker will be posted to Salesforce CRM as part of the transaction record.
Campaign: Campaign will be saved and may be downloaded through the reporting portal. The campaign will also post to Salesforce and matched against the existing campaigns. Non-existent campaigns will be created automatically.

Cash Register Defaults

Default product may be defined to minimize field entry at the time of processing. The default values will auto-populate the cash register.

Additional Payments

Additional Payment

Payment listing

Additional payments may be added to the final basket at the time of checkout. Default selections will appear as buttons that may be clicked for adding the respective value to the total processing amount. The settings may be in fixed amount or in percentage of total basket. In percent mode amounts may also be set to round to the nearest round value.

Example 1:

Total basket amount: $123.45
Default selections: $10, $20, $30, $40

The patron selects $10 so the grand total will be posted as: $133.45

Example 2:

Total basket amount: $123.45
Default selections: 10%, 20%, 30%, 40%

At checkout the following options will be made available:

$12.34 (10%)
$24.69 (20%)
$37.04 (30%)
$49.38 (40%)

The patron selects $12.34 so the grand total will be posted as: $135.79

Example 3:

Total basket amount: $123.45
Default selections: 10%, 20%, 30%, 40%
OPTION: Round to option

At checkout the following options will be made available:

$12 (10%)
$25 (20%)
$37 (30%)
$49 (40%)

The patron selects $12 so the grand total will be posted as: $135.45

Sales tax option & Tax deductible portion: The values entered will be used for calculating the tax and the tax deductible portion of the additional payment.

Additional surcharge

A surcharge may be added to the subtotal prior to processing. The surcharge may be in the form of a fixed amount plus a percentage, e.g. $5 or $2+5% or 5%

Recurring options

Recurring Transaction Setting

Receipt Settings

Receipts may be emailed, printed and/or sent by txt message. The various settings in this settings provide several features for printing and emailing the receipt.

Email Receipt: In ON position, receipts will be emailed to the patron with a valid email address.

Organization Information: If text entered in Organization Information it will appear on email receipt.
Thank you message: If text entered in Thank you message fields it will appear on email receipt.
Terms & Conditions: If text entered then Terms & Conditions will appear on print receipt.

Print Receipt: In ON position, receipts will be printed at end of transaction on compatible printer

Print option: In ON position, the Print option will be made available as an option after the completion of the transaction.
Print payment info: In ON position, the card holder name, last four digit of the credit card will be printed on the receipt.
Print terms & condition: In ON position, the terms & condition will be printed on the receipt. Depending on the length of the terms & conditions this option may use extra paper.
Receipt header: By default the Swiper1 logo will appear at the top of the printed receipt. If enter text here then Swiper1 logo will be replaced with this message.
Receipt footer: If text is entered the message will appear at the bottom of the receipt.
Terms & Conditions: If text entered then Terms & Conditions will appear on print receipt.

SMS Receipt: In ON position, at end of transactions a patron can request a receipt sent by SMS or text message.

Receipt Information: Customize text message to patrons. May use transaction autofill fields to include date, total amount, and patron's full name

Questions & Terms

Unlimited number of questions may be added to form. The questions & answers will appear on both the printed and emailed receipt.

The Terms & Conditions will also be added as a separate page during the checkout process. Once enabled the user has to AGREE to the listed Terms & Conditions before being able to finalize the payment. The Terms & Conditions will appear on the receipt based on the previous settings.

↧

Configuration :: Version3.9

December 30, 2014, 8:50 am

≫ Next: Getting-Started :: Version2.6

≪ Previous: Additional-Options :: Version3

Table of Contents [ Hide]

Options

Privacy

About

Reports

Enter Account Info

Swiper1 Android application will operate and process transactions without any customization. The minimum required information for processing is:

Click & Pledge Portal login email
Click & Pledge Login password
Click & Pledge Account number

To help with the continuous use of the application at events provisions are available to minimize the need for repeated login prompts. The following options are available:

Stay logged in: Will keep the session open until the Logout option is clicked from the settings area (accessible through the hamburger menu)
Remember User Id & Account #: Remembers all entries except the password. To log back in after exiting the app will require entry of the password
Show Password: Provides open field entry for password instead of hidden password displayed as stars.

Once logged in the application will check with the Click & Pledge Portal settings to determine if Salesforce CRM has been enabled. Features will be enabled based on various settings in the Click & Pledge Portal, Salesforce, and within the Swiper1 App.

Swiper1 may be customized through the Options menu available at the bottom of each page. The following describes all available options.

Options

All application settings are accessible through the option menu. Click on the "Options" bar located at the bottom of all screens to access the application settings.

The following are the top level options available through the option menu:

Settings

The following options are available for Android devices. iPhone & iPad (iOS) devices will not have the "Device Manager" option available since the hardware will be auto-detected.

Merchant Profile

Confirm the account information as well as the order mode. The default order mode is set to Test allowing for the test credit card to be used. Real credit cards may only be transacted in the Production mode.

Additional Options

Options such as printing, email, receipt format, default product settings as well as additional payments, tax settings, and recurring payments may be set up using the various options in the Additional Options setting.

Device Manager

Select the device being used. This is an important step. Using the wrong device with the wrong settings will result in error.

Event Settings

Store Manager

Backup & Restore

Privacy

The local database may be erased. Clearing the local database will NOT remove the data from the Click & Pledge portal. Reports may be downloaded from the portal at anytime following clearing the local database. The local database maintains a copy of all transactions for reporting and printing the register report. Reports may be printed or emailed prior to clearing.

About

Detailed information about the Swiper1 application as well as contact & support questions may be found through the About link.

Reports

Reports may be downloaded for specific date or period using the local database. The report is available for all transactions performed with the unit and may be cleared using the Privacy link in the Settings area. Reports may be emailed or printed using the Bluetooth printer option. Swiper1 report includes:

Transaction date
Customer name
Card type
CC last 4
Subtotal
Additional fee
Tax
Surcharge
Total due
Total charged
Tax deductible
Recurring Type
Periodicity
#Installments
LoginAccount
LoginEmailId
Location

↧

Getting-Started :: Version2.6

January 14, 2015, 10:04 am

≫ Next: Sample-Programs :: Version2.6

≪ Previous: Configuration :: Version3.9

The following are a few examples of the XML’s that apply to typical applications. If you wish to see a specific example please email us at support@clickandpledge.com and describe the applications and one of our engineers will gladly work on the example for you. For simpler forms you may want to consider using FaaS platform.

All examples in one download: PaaS-Examples.zip

* For simple applications, such as Example 1, you may want to consider using the FaaS platform. FaaS provides majority of the PaaS features and works based on the form’s POST method without any need for XML. The only features not included in the FaaS platform are eTicket and name badges.

Example 1

The following example demonstrates the least number of fields needed for processing a donation.

Sample XML: Minimum donation fields

Points to consider:

Donations are the same as products except that the quantity listed is 1
Using a Checkout page ID (WID) helps with setting up receipt header information.
IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
<OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
<Total> should be posted in pennies. $2 should be posted as 200

Example 2

eCheck option is in addition to the credit card payment methods and may be applied for separately. eCheck requires additional applications with our issuing partner.

Sample XML: Minimum donation fields + eCheck

Points to consider:

Donations are the same as products except that the quantity listed is 1
Using a Checkout page ID (WID) helps with setting up receipt header information.
IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
<OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
<Total> should be posted in pennies. $2 should be posted as 200

Example 3

Custom questions are additional questions that may be asked from the patron during the checkout process. There are no limits on the number of custom questions that may be passed on to the API. Custom questions will be saved and will be included in the receipt.

Sample XML: Minimum donation fields + 3 custom questions

Points to consider:

Donations are the same as products except that the quantity listed is 1
Using a Checkout page ID (WID) helps with setting up receipt header information.
IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
<OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
<Total> should be posted in pennies. $2 should be posted as 200
There are no limits on the number of times the <CustomField> node may be repeated.

Example 4

There are 2 different methods to use the Third Party nodes. The simplest method is by taking advantage of a Classic checkout page. The API provides appropriate nodes to pass the UserID & Password for each of the integrated third party applications, but if you don’t wish wish to include the information in the posted XML you may add it to the account and enable the application with the checkout page.

Here are 4 examples:

Example 4a: Using third party nodes with the userid & password
Example 4b: Using third party nodes without the userid & password
Example 4c: Using only Twitter post
Example 4d: Using only Constant Contact

Points to Consider:

Donations are the same as products except that the quantity listed is 1
Using a Checkout page ID (WID) helps with setting up receipt header information.
IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
<OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
<Total> should be posted in pennies. $2 should be posted as 200
There are no limits on the number of times the <CustomField> node may be repeated.
There are no limits on the number of times the <ListName> may be used. If the user subscribes to multiple lists then the <ListName> node should be repeated for each subscription. Both Constant Contact & MailChimp may be used individually or together.
If Salesforce is active in the administrative system the API will use the Salesforce creditentials as listed in the account setting. There is no need to include the same credential again.
Twitter posts are limited to 140 characters, which is a limit set by Twitter.
ClickandPledge social networking node will be used for comments that will be returned by the RaaS services. Read more

Example 5

With eTicket option, the payment receipt will include a PDF document of an eTicket. The example includes the minimum fields required for an eTicket.

Sample XML: Single product with eTicket option

Points to Consider:

Using a Checkout page ID (WID) helps with setting up receipt header information.
IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
<OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
<Total> should be posted in pennies. $2 should be posted as 200
To add a banner to the eTicket, set up a product and add a ticket to the product. Use the Ticket ID in the API for <TicketID> node. The banner used in the ticket will be used for the eTicket.pdf file which will be emailed with the receipt.
The 2 nodes: <SecurityCode> & <SerialNo> are described in the manual.
If an item has a ticket then there has to be a ticket node for each quantity sold.

Example 6

Sending detailed and well designed eTickets requires addition of a couple of more nodes than the ones shown in Exmaple 5. In this example all eTicket nodes are provided for purchase of 2 tickets.

Sample XML: 2 eTickets puchased with detailed information

Points to Consider

Using a Checkout page ID (WID) helps with setting up receipt header information.
IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
<OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
<Total> should be posted in pennies. $2 should be posted as 200
To add a banner to the eTicket, set up a product and add a ticket to the product. Use the Ticket ID in the API for <TicketID> node. The banner used in the ticket will be used for the eTicket.pdf file which will be emailed with the receipt.
The 2 nodes: <SecurityCode> & <SerialNo> are described in the manual.
If an item has a ticket then there has to be a ticket node for each quantity sold.
Each line in the ticket definition has a specific length requirement. Please refer to the manual for details.

Example 7

Names badges may be sent with each purchase. Name badges are similar to eTickets and will be sent as a PDF attachment to the receipt.

Sample XML: Since product with nam badge and a quantity of 2 purchase.

Points to Consider

• Using a Checkout page ID (WID) helps with setting up receipt header information.
• IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
• <OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
• <Total> should be posted in pennies. $2 should be posted as 200
• To add a banner to the name badge create a name badge as part of a product. Use the Badge ID in the XML as shown in the sample XML: <NameBadgeID>7610</NameBadgeID>
• Customize each line of the name badge using the Footer & CustomFieldList.
• Name badges should be defined for each quantity of a purchased product with name badge.
• Footer may be 1 -3 lines while the custom questions have a limit of 2 questions.

Example 8

Shipping information is similar to billing information and includes the contact as well as the address information.

Sample XML: Single product with Biling & Shipping information

Points to consider:

Donations are the same as products except that the quantity listed is 1
Using a Checkout page ID (WID) helps with setting up receipt header information.
IPAddress: The IP address of the person making the payment. The IP will be used for fraud analysis and it is important that a correct IP address is used.
<OrderMode>: While testing keep the mode as “Test”. Once you are ready to go into product change the mode to “Production”. In Test mode the test credit card will work and real cards will decline.
<Total> should be posted in pennies. $2 should be posted as 200

Example 9

This example includes all available fields except eCheck. The payment method used in this example is credit card and since only one payment method may be used eCheck is not listed.

There are a number of elements that are included in any other example, such as discounts, etc. Refer to the manual for detailed coverage of each node.

Sample XML: Complete listing of all nodes

Helpful Hints

Using Checkout Pages for various receipt settings

While the PaaS platform provides tremendous flexibilitywhere every aspect of a transaction may be posted through the XML, it also takes advantage of various features of checkout pages minimizing the number of nodes needed. For example the following nodes may be omitted by providing the WID of a checkout page as a reference.

<Language>ENG</Language>

<OrganizationInformation>Nonprofit 123</OrganizationInformation>

<ThankYouMessage><![CDATA[Thank you for your support]]></ThankYouMessage>

<TermsCondition><![CDATA[All donations are tax deductible.]]></TermsCondition>

<Deductible>true</Deductible>

<EmailNotificationList>

<NotificationEmail>email@domain.com</NotificationEmail>

</EmailNotificationList>

The above nodes will be taken from the Checkout page if its WID is listed as: <WID></WID>

The RECEIPT node will be as follows:

</Receipt>

To take advantage of WID shortcut follow the steps listed below:

Login to the administrative system
Click on Checkout Pages
Add or use an existing Classic page (any of the easy pages will work).
Customise the following fields. Other fields will be ignored.
Thank you message: Appears in the receipt after the salutation
Terms & Conditions: If applicable – appears at the bottom of the receipt.
Email Notifications: Listed emails will receive a copy of the email. These emails are in addition to the emails set in the Account Info / Profile / Receipt – Email Notification
Once completed copy the WID of the checkout page and use it in the API.

Enabling Third Party Integration

The API provides dynamic integration with the following third party platforms:

Salesforce
ConstantContact
MailChimp
Twitter

The nodes are listed under ThirdParty. Each node requires UserID, Password, and a comment or list name to be posted to the provider. Through the integration with the checkout page the UserID and Password of the provider may be omitted. To take advantage of this shortcut follow the steps listed below.

Login to the administrative system
Click on Account Info / 3rd Party Tab
Enable any of the accounts to be used in the API and update the UserID & Password for the appropriate accounts.
Follow the steps listed before and add or use an existing checkout page.
Edit the checkout page and enable the third party vendors applicable to the AP [Learn more]

Once activated the third patry nodes will take advantage of the Admin settings and use the UserID & P assword setting as set in the administrative system. This feature provides an extra layer of security by not exposing the UserID & Password of these accounts in a configuration xml.

Using Adobe Flash with the PaaS platform

The PaaS platform has cross site scripting enabled allowing for Adobe Flash & Microsoft Silverlight applications to take advantage of the API.

The following provisions are made to help with Flash applications to work with the API.

Based 64 encoded XML’s may be posted using: OperationBase64Encode
Enable cross site scripting and cross domain scripting.

↧

Sample-Programs :: Version2.6

January 14, 2015, 10:04 am

≫ Next: Form-as-a-Service :: Version3.9

≪ Previous: Getting-Started :: Version2.6

Table of Contents [ Hide]

PHP

Flash

The following sample codes provide examples of how to use the API in different languages. The API only responds to secure (https) sites. The site that posts any data to the API has to be hosted on a secure site.

PHP

The following are a few sample codes for using the API in PHP.

Form Samples

The following forms are developed in PHP:

Click to download the following examples: PaaS-Sample_PHP_Forms.zip

Example 001

In the above example, identified as Rent Payment, an amount entered will trigger a convenience fee to be added to the total. The convenience fee is a percentage of the total amount to be paid. The item purchased (paid for) will be identified by the Property Office text box.

The form may be used by removing AccountGuid and AccountID and making them hidden fields.

Example 002

In the above example a donation form allows the patron to make a donation through a radio button. Recurring payment as well as email subscription is also part of the form.

The API allows for integration of Constant Contact and MailChimp (individually or used in combination) into a form. To enable any or both of these services follow the steps listed below:

Login to the administrative system
Click on Account Info (top right hand side)
Click on 3rd Party
Enter the Constant Contact & MailChimp information through the appropriate tabs.

For added security it is recommended that a catalog page is created with 3rd party option enabled for Constant Contact & MailChimp. Using the WID will remove the requirement of UserID & Password for these sites to be added to the XML. Through a checkout page the notification email and receipt header may also be customized through the admin.

Example 003

In the above example the idea of a shopping cart is presented. Items may be added and removed from the basket with additional amounts added prior to making a payment. Recurring donation as well as eNewsletter is also included.

This sample was developed in PHP and is an integrated module in the SugarCRM. The module serves as a virtual terminal inside the CRM package.

Posting Method

Click to download the sample code: PaaS-Sample_PHP.zip

Flash

The following is a sample code for using the API in Flash. Examples are provided for both Flex & standard Flash.

Click to download the sample Flex code: PaaS-Sample_Flex.zip
Click to download the Flash sample code: PaaS-Sample_Flash.zip

Notice of special feature:

OperationBase64Encode

An additional operation was added to resolve problems with those developers using Flash. Flash developers were experiencing problem using the SOAP service. In general Flash changes all the left brackets (>) in the XML to the equivalent HTML code (<). Based on our research the issue is a general problem with Flash & SOAP as reported by other developers in various forums.

↧

Form-as-a-Service :: Version3.9

January 14, 2015, 10:04 am

≫ Next: Connect :: Version4.2

≪ Previous: Sample-Programs :: Version2.6

Join the User Forum: Form-as-a-Service User Group

About:

Forms as a Service is an easy way to take advantage of the flexibilities offered by the API. The FaaS web service allows web designers to design a donation form and use the POST method to process the transactions through the webpage without any need for launching an external site.

Post to FaaS

To process transactions through the FaaS services post the form result to:

https://FaaS.Cloud.ClickandPledge.com

For testing you may use the following site for matching the posted variables against the requirements:

https://Verify.Faas.Cloud.ClickandPledge.com

Three links need to be provided as part of any call to the FaaS service.

Authorization link
Decline link
Error link

The above links instruct the FaaS service what page to respond to when a card authorizes, declines, or when an error is generated. Details of how to setup a page as well as examples are provided in the following sections.

Samples & Downloads

Building forms is quite easy using web development tools such as Adobe Dreamweaver, Microsoft FrontPage, or any other web authoring applications.

The following is the complete form with all fields:

US States pull down menu: US_States_Form.zip
Country pull down menu: Country_Codes_Form.zip
Expiration month & year menu fields: Expiration_Month_Year.zip

The above form will reply back to simple pages with Authorize, Decline, and Error messages. The Replies are provided in the URL.

The following are a few examples created using Dreamweaver: https://clickandpledge.com/Platforms/Donation-Payment/API/FaaS/

All Fields Included: FaaS_Complete_4-21.zip
All Examples in one download: FaaS_All_Examples.zip

Need to see a different example? Please join the forum & let us know.

↧

Connect :: Version4.2

February 14, 2015, 11:50 am

≫ Next: Payment-as-a-Service :: Version3.1

≪ Previous: Form-as-a-Service :: Version3.9

Overview

Click & Pledge Connect is a free peer-to-peer social fundraising platform available to all Click & Pledge customers. Organizations can customize their Organization profile page and create an unlimited number of Campaigns. Then supporters can then create their own Fundraiser pages and solicit funds on behalf of the campaigns.

Enable/disable

By default all Click & Pledge customers will have a profile page ready to customize and use and a campaign so donations can occur. If you wish to disable your organization from Click & Pledge Connect just follow the instructions or watch the video posted below.

1. Login to your Click & Pledge portal: https://portal.clickandpledge.com/
2. Click on Account Info

3. Then under 'Your Profile' tab

scroll to the bottom and find 'Connect Platform'

You will find it is set to 'Active'

4. To make Inactivate:

click EDIT
click box to uncheck it
click UPDATE

You will see your organization is now 'Inactive' on the Connect platform. If you wish to reactive your organization on Connect, just follow these steps again to 'Activate.'

The following video will go through the procedure step-by-step:

Login

To login to the Connect Platform go to the website homepage: https://connect.clickandpledge.com/ and click on Organization Login.

Enter the email address and password associated with your Click & Pledge account.

When you Login you will see your organization's dashboard with a menu on the left panel to customize your Organization's profile and Campaigns.

Dashboard

The Admin Dashboard will have a Preview button to preview your Organization's Profile page and show Top 10 and Campaign quick reports.

A menu will be on the left panel.

Organization

To customize your Organization's profile and settings, click on the plus (+) sign to expand the menu.

Summary

Within Summary you may enter your Organization's profile information. Add your organization's logo and text here using the wiziwig editor. This will be the main section of your organization's webpage. Click Save to save changes.

Page Tabs

Content can organized into tabs on your organization's webpage. The Campaigns tab will be defaulted in the 1st position and you may add up to 4 more tabs. Click on the edit icon (pencil) to add and edit tabs and their content. In edit screen click Update to save changes.

Once a tab editor is open you can edit:

Title: The text that appears on tab

Internal Notes: Text entered here will remain in the system. Not for public viewing.

Mode: Choose Hide or Show mode. In Show mode, tab will appear on organization's page, if in Hide mode tab will not appear.

Order: The order the tabs will appear on your profile page from left to right. Campaign will be defaulted into the 1st position (Order 0).

Content: Use wiziwig editor to enter and edit text and images. Use Source to enter in HTML code.

Social Site URLs

Enter your organization's social network URLs. Please include the http:// and https:// at the beginning of the URLs. Click Save to update.

Note: Please make sure you are entering your public URLs and not the URL you use to administer your social networking site.

Share Message

Enter a default Share Message your supporters can then share and post on their social networks. Enter a message title and message description. Click Save to update.

Fundraiser Settings

Accept Fundraisers: By checking Accept Fundraisers you allow people to create fundraising pages and solicit donations on your behalf.

Automatic Approval: Enter a check to automatically approve fundraisers or if not checked, you will have to manually accept fundraisers’ requests. To manually accept fundraisers, you must login and approve them under Manage Fundraisers.

Show Relationships: Checking the options will show relationship menu between fundraisers and donors. For Salesforce users, thsi will work with Click & Pledge's soft credits (Payment as a Service App version 8.0 and higher)

Emails:

We have provided default text for the following emails: Fundraiser Activation, Federated Activation (login with Facebook), Inactive Fundraiser, and Reject Request. You may customize the text in these emails but please do not delete the verification code and registration link in the Fundraiser Activation Email.

Click Save to update any changes.

Manage Fundraisers

View your fundraisers and change fundraisers' statuses. Use filters to search for specific fundraisers.

Transactions

// release date: February 16, 2015

View, cancel, credit, update recurring transactions through the Transactions tab.

Create New View

Views may be created with different columns and filters. Views may be defined for any 90 day period.

Transaction Detail

Click on an Order Number to view the transaction details. The following actions are available:

Issue Credit: The card may be credited back and an email may be sent to the card holder.
Post to Salesforce (if connected to Salesforce.com): The transaction may be posted to Salesforce.com. A history of the prior posts is also provided.
Send Receipt: A copy of the receipt may be sent to the patron. A different email address may be used for sending from the one originally provided by the patron.
Manage Recurring: A recurring transaction may be cancelled, edited and updated using the available options.
Charge the Card: The card may be charged again for a different amount using the virtual terminal.

Campaigns

While Organization's have profile pages, the donations that transaction will be tied to a specific campaign. Campaigns allow organization to track their fundraising success. For instance, each Campaign has it's own fundraising meter to show its fundraising progress toward its fundraising target or goal. Every Click & Pledge customer will have one default campaign already created so the organization can accept donations throug the Connect platform. The name of the campaign will be the same name as the organization. Each organization can create an unlimited number of campaigns in Connect.

When you click on Campaigns in the menu panel:

When you click on Campaigns in the menu panel (see image above) a Campaign List will show (image below).

Here you may edit existing campaigns and create new campaigns.

New Campaigns

When you select New Campaign you will need to enter the following fields. Click Save to save your campaign. Once you have created your campaign use the icon to customize your campaign settings.

Mode: Select Active, Inactive, or Active and Default

Campaign Name: Public Campaign Name that will show with the campaign image on Connect Platform

URL Alias: text added to the end of the URL. Once an URL Alias is created it cannot be used for a different campaign.

Target: Numerical fundraising goal. Target will appear on CAmpaign page. Progress toward target will track with meter and in percentage on campaign page.

Start Date: Use calendar to enter campaign Start Date

End Date: Use calendar to enter campaign End Date

Campaign Settings

Click a campaign edit (pencil) icon for the campaign settings to appear.

Dashboard

Preview button to preview your campaign page Top 10 Fundraiser reports.

Description

Summary: Enter a short text only summary of this fundraising campaign. This text will appear in the search results.

Detail: This information will appear on your campaign page. Use the wiziwig editor to enter details on your campaign,including headings, dates, images, videos, etc.

Campaign Image

Click Choose File to select a image from your computer. Note the maximum size requirements for the image.

Keywords & Categories

Keywords and Categories are very important. They allow supporters to find your organization using the Connect website's Categories and Search bar.

In keywords enter the words that best describe your organization and service area. Separate all keywords with a semicolon [;].

For Categories click on the category that be represents your organization, then click the > arrow to bring them into the field on right.

You may select up to 3 Categories. Click Save to update.

Widgets

Donation

Donation widget shows on the upper right section of the profile page.You may edit the title, header, recurring policies, amounts and labels. There are 2 payment options: Single and Multiple. Single Payments will show radio buttons and allow a donor to choose one option. With Multiple Payments you may create one or more fields and donors can select from the options or enter their own amounts (depending on Min and Max values). Click Save to update.

Organization Information

If enabled this widget can provide your organization information to appear on the lower right side of your organization's campaign page. Click Save to update.

Social Site URLs

Enter any social network URLs for this campaign or your organization. Please use complete URL including http:// or https://.

Payment Form

Customize your payment form and payment types.

Checkout Page Name: Create a name for your donation page. Checkout Page name will show in your Click & Pledge administrative reporting system.

Donation for (optional): Will appear on supporter's receipts

SKU (optional): SKUs can be applied to donations. SKUs are mostly used by Salesforce users.

Receipt Information (optional): Add text to include on donor's receipts.

Terms & Conditions (optional): Enter your organization's Terms & Conditions. You have three options with Terms & Conditions. Show Terms & Conditions will allow patrons to view your Terms & Condition's statement. You may require patrons to confirm they have read them using a checkbox. Lastly, you may have Terms & Conditions show on receipts.

Payment Types: Choose the payment types you wish to accept for this campaign.

Custom Questions

Custom questions can be added to payment forms. To add custom questions you must create a section then apply questions to the section. Multiple questions can be added to a section and multiple sections can be added to a payment form.

Click Save to update.

Comments

Sort and manage comments from patrons.

Report

Use calendars to choose report beginning and end dates, then download campaign report.

↧

Payment-as-a-Service :: Version3.1

February 21, 2015, 12:55 pm

≫ Next: OpenCart :: Version2.7

≪ Previous: Connect :: Version4.2

Join the User Forum: Payment-as-a-Service User Group

About:

Click & Pledge’s Payment Application Interface (PAI) provides a comprehensive API for the Trio payment and administrative engine. Through the PAI, programmers may interact with the Trio system within their respective applications.

By default all accounts are set up with the API credentials. To access the API information follow the steps listed below:

Login to the administrative system: https://Portal.ClickandPledge.com
Click on the Account Info
Under "Your Profile" tab click on "API Information" sub-tab

Make sure to check the sample code section as well as the Sandbox for testing the XML’s generated by your code. [Check the table of content for links].

Questions? Post your questions to the forum at:

https://forums.clickandpledge.com/forumdisplay.php?33-Payment-as-a-Service-PaaS-Group

Web Service

Please use the following link for connecting with the service:

https://paas.cloud.clickandpledge.com/PaymentService.svc?wsdl
Available methods:

Operation
OperationBase64Encode
Echo

The service will ONLY respond to secure sites. To use the API the site hosting the form has to be hosted on a secure site (https).

Manual, Schema & XML Sample

The following are various documents describing the PAI and its parameters.

Download the Schema: APISchema.zip
Examples: Please refer to the Getting Started section
US States pull down menu_States_Form.zip
Country pull down menu: Country Codes_Form.zip
Expiration month & year menu fields: Expiration_Month_Year.zip
Please visit the sample section for program examples: Sample Programs

Click & Pledge Secured

Click & Pledge is a certified PCI-Level 1 application service provider. Our API has undergone testing and security audit by Control Case and therefore is fully compliant with PCI standards. You may add Click & Pledge secured button to forms. The button will change color according to the page’s security setting.

Download: ClickandPledge_Secured.zip

Support

Due to the nature of the PAI and the many environments that programmers may use, support is only provided through the user forums at:

https://forums.clickandpledge.com/forumdisplay.php?33-Payment-as-a-Service-PaaS-Group

Please join the forum and post your questions to the appropriate list.

↧

OpenCart :: Version2.7

March 24, 2015, 3:39 pm

≫ Next: Gravity-Forms :: Version2.7

≪ Previous: Payment-as-a-Service :: Version3.1

Table of Contents [ Hide]

Open Cart Installation

Click & Pledge Customization

OpenCart is a powerful open source shopping cart system that is designed feature rich and user friendly. OpenCart integrates with Click & Pledge so you can process payments using Click & Pledge and enjoy all the features already built into Click & Pledge's administrative system like reports and email notifications. Also through Click & Pledge you can also take advantage of our Salesforce Integration to capture contacts and purchases.

The following are instructions show you how to integrate OpenCart with Click & Pledge. This integration works with OpenCart version 2.0.1.1

Open Cart Installation

First, you will need to have downloaded OpenCart Platform to your server if you have not already done so. Refer to OpenCart for download instructions. Once Open Cart has been installed with your host, the Click & Pledge integration module needs to be installed. The following provides a step-by-step procedure for installing the Click & Pledge module:

Download the Click & Pledge integration module from GitHub: https://github.com/ClickandPledge/OpenCart
Unzip the downloaded file. There are 2 sub-folders: admin & catalog
Copy all files from the admin & catalog to the OpenCart project folder following the same file hierarchy. Make sure the files are copied to the exact location following the admin & catalog folder structure in OpenCart.

Click & Pledge Customization

After you have installed the OpenCart Platform, there are a few steps you will need to take in order to activate the Click & Pledge Gateway API. Here are the steps:
1. Login to your OpenCart account
2. Hover over Extensions and select Payments
OpenCart - Payments

3. From the provided list find 'Click & Pledge' and click on Install to install the Click And Pledge Gateway API
OpenCart- ClickandPledge

4. Once installed again go to 'Click & Pledge' and select 'Edit'

5. Enter your Click & Pledge Account ID, GUID Key, Transaction Mode, & Status. Click & Pledge Account ID and GUID Key are located within your Click & Pledge administrative system. Instructions to retrieve this information is detailed in the following step. 'Transaction Mode' needs to be set to 'Production' to process [Test mode does allow you to run test transactions with a test credit card number, 4111 1111 1111 1111 (1 four and 15 ones). Test transactions do not transfer into Salesforce.] For Status, you need to change to 'Enabled' to process either 'Test' or 'Production' transactions. Click 'Save' button after editing Account Settings.

6. To obtain your Click & Pledge Account ID and GUID Key, Login to your Click and Pledge account at https://portal.clickandpledge.com/. Then click on 'Account Info' then 'API Information' under the 'Your Profile' tab. See image below.
admin

↧

Gravity-Forms :: Version2.7

March 24, 2015, 3:39 pm

≫ Next: Transaction :: Version10.2

≪ Previous: OpenCart :: Version2.7

References:

http://www.gravityhelp.com/documentation/page/Gravity_Forms_Documentation

Support: 3rd Party Integrations are supported through the forum only. Please post all your questions to: https://forums.clickandpledge.com/forumdisplay.php?f=78

Requirements:

Gravity Forms requires a minimum of WordPress version 3.7+
MySQL 5
PHP 5

Setup:

http://<your_wordpress_home>/wp-login.php
Make sure that Gravity forms plugin installed and enabled (http://www.gravityhelp.com/documentation/page/Getting_Started)
Download the Click & Pledge plugin through GitHub: https://github.com/ClickandPledge/WordPress-GravityForms
Copy Click & Pledge plugin (‘gravityforms-cnp’ folder) as downloaded in step 3 in the WordPress Plugin folder as outlined below:

<your host root>\wp-content\plugins\
Go to ‘plugins->Installed Plugins’ enable the ‘Gravity Forms Click & Pledge’

Click on ‘Forms->Settings->C&P Payments’ to enter Click & Pledge Credentials like ‘Account ID’, ‘API Account GUID’ and to setup other settings

Account ID, API GUID are located at the Click & Pledge administrative portal > Account Info > Profile > API

Click & Pledge API Information

Please follow the documentation here to create a form http://www.gravityhelp.com/documentation/page/New_Form

Assigning From to process through Click & Pledge:

Click on ‘Forms->Click & Pledge’ to display all available forms.
Select the ‘Gravity Form’ to process then click on ‘Save’ button

Setting SKU for an item:

SKU's are added for each item and option as a hidden field. The following example shows how to add SKU to a single item as well as one with options.

Example 1: T-Shirt with SKU=abc-123

Item definition:

Note: In the above example the Field id for the item is shown as: Field ID 2.

Add a hidden field:

Set up the hidden field referencing the Field ID as in the Product setting:

Properties field label: {SKU}{FIELDID=2} - Please note that all fields are case sensitive - SKU & FIELDID should be in all caps.

The Advanced tab is the value of the SKU.

Example 2:

For products with options such as those listed in a pull down menu or a radio button, each option needs to be set up with an SKU. SKU's may be the same or different.

Hidden field format: {SKU}{FIELDID=fid}{OPTION=value}

fid = Field ID of the product as listed in the Product listing
value = Option's label - each option of a product has to be set up with a unique label and that label needs to be listed to identify the SKU's reference.