Quantcast
Channel: Developer's Manual
Viewing all 249 articles
Browse latest View live

Salesforce-Event-Post Installation 2 0 :: Version2.1

$
0
0

Prerequisities


Before installing “Click & Pledge Event Management 2.0” Package you must first:
  • 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
Then 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.
Approve Third Party Access

Step 1: Approve Package API Access
Package Installer Step 1
Step 2: Choose Security Level
Package Installer Step 2
Step 3. Install Package
Package Installer Step 3

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
App Setup
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.
Confirm

You will go back to the Sites page and you will see the URL you created. Click on 'New.'
Sites
Site Creation Instructions:
Site Edit
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.
Site Label

Enable Visualforce

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

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.
Site Details Site Label

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.
Field-Level Security
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
Standard Object Permissions
(c) In section 'Custom Object Permissions'
Give all the access to following Objects, 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
Set Time Zone
To 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
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.
Develop Sites
(b) Move to 'Public Access Settings'
Public Access Settings
(c) Go to 'View Users'
View Users
(d) Open the 'Site User' profile
Event Profile Full Name
(e) Edit the 'Site User' Profile
User-Events Site Guest User
(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’
All Remote Sites

Remote Site Edit

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 /)
Remote Site URL
Keep Site as ‘Active and then Click ‘Save’.










Installation :: Version3.1

$
0
0
Event Management Installation
 
Prerequisites:

To install “Click & Pledge Event Management”  Package:
Visit the Salesforce appExchange for the latest release:
Follow the prompts to install the package. Once finished, follow the Event Management Post Installation Instructions.

Salesforce---PaaS---Post---Installation-v7 :: Version1

$
0
0

After you have followed the installation steps for Click and Pledge's Payment as a Service (PaaS) app on version 7.4000 and later, follow the steps below:

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. Add as many Click & Pledge accounts to your Salesforce account as you like. This will allow your account to process transactions within Salesforce.

CAP Settings Configure Settings

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:

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

Step 2: Set up Contact Matching Preferences

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

CAP Settings Contact and Account

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: 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'
set up

Path

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

Completing Step 3a 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.

C&P Miscellaneous

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

Step 3b: Place 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.
Virtual Terminal button

Drag that button into 'Custom Buttons' area under 'Contact Detail' section. See below:
Custom button
After placing the Virtual Terminal Button, click Save.

After adding this button, you can observe the changes on Contact Detail Page. See below:
VT button on Contact Detail

Step 3c: 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
Select and drag these Related Lists and place it an appropriate place (up to User convenience).
Realted List for Contact Detail Page
For example, you can place it immediately below 'Custom Links' as in image below:
move contact alias

The Click on Save.

Then after adding these 'Related List,' you can view the change on Contact Detail Page (see below):

View Contact Detail Page

Step 3d: Disable 'New Button' on following related lists

'New Button' needs to be disabled for:
  • C&P Autoresponder Queue
  • C&P Autoresponder Sent Email Log
disable button

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

disable button img 2

 disable button img 3

disable button img 4

button disable img 5

disable button img 6

To make useful, add these fields to the related lists:

lists

Step 4: Instructions for setting up Autoresponder with delayed jobs (sending emails on date in future)

To run the scheduled jobs (Autoresponder sending option set with Delayed option) a User needs to create a Job. Follow these steps:

 Click on YourName (at top right) > Developer Console

schedule jobs img1

Open Execute Anonymous Window by following the path shown below

Open Execute Anonymous Window

Then execute following statement:

CnP_PaaS.ScheduledEmailSender.start();

Enter Apex Code

After executing this at Developer Console, you can find the Scheduler job at

 

Administration Setup > Monitoring > Scheduled Jobs

All Scheduled Jobs

Now if you set the Autoresponder’s ‘Send Option’ as ‘Delayed’ or ‘On a specific date & time’ this Scheduler works and delivers the email responder at the set day and time.

Step 5: Settings for using Opportunity Products

Within C&P settings we have an option to “Use Products for each item in an Opportunity".

This option is located under C&P Settings > Opportunity

CAP 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---> 

opportunity products img2

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 Opportunity

Click on Opportunities

Then select Edit Layout

Select Edit Layout

Select Related Lists, then click and hold on C&P Soft Credits, then drag it into page layout.

Opportunities Select Soft Credit

Click SAVE

Click SAVE

Person Accounts

If you have a person account, go to C&P Settings > Contact & Account.

Note: Contact mapping is not available for Person Accounts and is provided for backward compatibility.

Under Account Settings select 'Create and Account/Contact pair (1 to 1)' then choose Person or Business Account and appropriate Record Type.

Personal Accounts

Then you may setup your Account Layout Page, as described in Steps 3a-d for the Contacts Layout Page.



Salesforce-PaaS-Post-Installation :: Version2.7

$
0
0
Salesforce PaaS Post Installation instructions for version 8 and higher.

After you have followed the installation steps for Click and Pledge's Payment as a Service (PaaS) app on version 8.0 and later, follow the steps below:

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. Add as many Click & Pledge accounts to your Salesforce account as you like. This will allow your account to process transactions within Salesforce.
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:
  1. Login to you Click & Pledge Account at  https://portal.clickandpledge.com/
  2. Click 'Account Info' in upper right corner
  3. Under 'Your Profile' tab, click 'API Information'
  4. Find Account ID (C&P Account Number) and API (PaaS/FaaS) Account GUID (C&P Account GUID)
Refer to image below:
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

Contact and Account Mapping

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

Contact Page Layout

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


Related List Properties Autoreponder Queue

Selected Buttons

Manage Buttons

Step 5: Settings for using Opportunity Products

Within C&P settings we have an option to “Use Products for each item in an Opportunity".
This option is located under C&P Settings > Opportunity
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--->
Opportunity 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

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
Fields

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

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
 App Setup
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
 Cannot modify your Force.com domain
Select 'OK' that you agree you cannot modify your domain.
 Not Able To Modify Domain
You will go back to the Sites page and you will see the URL you created. Click on 'New'
 Sites New
Site Creation Instructions:
 Site Edit Site Label
At ‘Site Label’, ‘Site Name’ and ‘Default Web Address’ type your desired text. At ‘Active Site Home Page’ user can select any value. Then click Save. After that, open your created 'Site Label' and modify as suggested below.
SiteLabel
Site is created successfully; you can use this site name for using local images at C&P Designer.

Step 8: Invoice related steps

For using the Invoice feature of the app you need to give following permission at the created site.
Go the Site:
Setup > Develop > Sites , then Click on Site Name

Enable Visualforce
Click on 'SiteLabel"  
Go down to the Site Visualforce Pages section and click on Edit
 Site Visualforce Pages
Enable the following ‘Visualforce Page’ 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.

  • CnP_PaaS.ExternalSitePage 
 Enable Visual Force Page Access
Update 'Public Access Settings'
Then go to 'Public Access Settings' at your created Site
 Step 8 SiteLabel
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 Opportunity object, view as Visible.
Step 8 Field Level Security
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:
  1. C&P Invoice
  2. C&P Invoice Items
  3. C&P Invoice Policy
  4. C&P Invoice Setting
  5. C&P Invoice Payment Policy
  6. C&P Designer
  7. C&P Designer Content Data
 Custom Secuity
(b) At Standard Object Permissions
 Standard Object Permissions
(c) In section 'Custom Object Permissions'
 Custom Object Permissions
Then Save the edited settings.

Step 9: Mail Chimp Integration






Salesforce PaaS Installation :: Version5.1

$
0
0
The Latest Release is Click & Pledge Payment as a Service App Version 8.0. To Install:

Step 1: Install API Class Library

To install “Click & Pledge Payment-as-a-Service” version 8.0 or later package, “Click & Pledge PaaS Class Library" version 2.0 or later must be installed first. This application is available on the Salesforce App Exchange here:


After installing the “Click & Pledge PaaS Class Library" version 2.0 or later, you may then install the “Click & Pledge Payment-as-a-Service” version 8.0 or later packages successfully.

Step 2: Install Payment as a Service (PaaS) App release 8.0 or later


Approve Third-Party Access
Third-Party Access

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

Approve Package API Access

Approve Package API Access

Choose Security Level

Up to your organization to select the Security Level that best suits your needs.

Choose Security Level

Install Package

Install Package

Step 3: Activate Integration between Click & Pledge and Salesforce

For activation instructions go here: http://manual.clickandpledge.com/Salesforce-PaaS-Activation.html

Step 4: Follow Post Installation Instructions

Post Installation instructions for new installations of this application: http://manual.clickandpledge.com/Salesforce-PaaS-Post-Installation.html
If you are upgrading from previous versions go here: http://manual.clickandpledge.com/Version-Upgrades-1.html






Swiper1 :: Version2.3

$
0
0
Swiper1 Mobile Payment

Swiper1 LogoSwipe 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]
  • Free customer support
  • Fully integrated with Salesforce CRM + Salesforce Events attendee Check-in / Check-out
  • 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 fees for manual entry
  • Pricing: $29.95 per unit
  • All standard Click & Pledge merchant account pricing applies

Configuration :: Version3.6

$
0
0

Enter Account Info

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

Swiper1 Login
  • Click & Pledge Portal login email
  • Click & Pledge Login password
  • Click & Pledge Account number
  • Remember me:  Persistent login keeps the user logged in until the user "logs out" through the options menu.  Exiting the application will maintain the session login.
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

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:

Swiper1 - Standard Options

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.

Swiper1- Settings

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.
Swiper1 Merchant Profile

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.

Swiper1 Additional Options

Device Manager (Android ONLY)

Select the device being used.  This setting is for Android devices only and not an option for iPhone or iPad.  Currently there are 2 devices in use.  The IC device has a raised circular surface where the QR Code is present.  Before using the Swiper1 hardware to swipe credit cards the correct hardware has to be selected in the settings.  This is an important step.  Using the wrong device with the wrong settings will result in error.
Swiper1 Android Device Setting

Event Settings

Swiper1 Device Authorization

Store Manager

Swiper1 Store Manager

Backup & Restore

Swiper1 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.

Swiper1 Privacy Options

About

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

Swiper1 About

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

Swiper1 Report


Event-Listing :: Version1.6

$
0
0
C&P Event Listing is a Parent Page for your events. Each Event Listing Page can show an unlimited number of events

Click New button to create new Event Listing

Click on Event Listing Name to go to Event Listing Detail to edit logo, colors, title, main section, and footer. Below is an explanation of fields:
  • Page Design
    • Public Site URL - External web address for User information and registration
    • Page Background - Background color for entire page. Use Hex codes or select from color palette.
    • Page Banner - Graphic, Image or Logo that appears at top of page as banner
  • Title & Info
    • Background Color - Color of title bar. Use Hex codes or select from color palette.
    • Description - Event details such as name, date and location. Appear below Page Banner.
  • Main Section
    • Title Background Color - Background for the Title bar in main section. Use Hex codes or select from color palette.
    • Title - Text area.
    • Section Background Color - Color will appear as background to entire middle section.
    • Description - Text will appear at top of registration form.
  • Footer
    • Background color - Footer background color. Use Hex codes.
    • Description - Footer block text.

Create-Event :: Version2.3

$
0
0
Before creating an Event, make sure you have followed the Event Manage 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.

Items to Note:

1. Zero dollar transactions: For $0.00 event/transactions, you must have invoicing as a payment option enabled in both the Click & Pledge administrative system and in Salesforce under the "C&P Event" tab.

2. To view Event page: Before you can view your event; you must create an event, have at least one registration level, and have created/saved your layout pages. 

Event Management-(SF) :: Version1.3

$
0
0
The Events Management Module provides Salesforce users a FREE platform to create an unlimited number of events and have attendees register and pay using Click and Pledge's PCI certified payment platform. Some of the Event Management Module's features include:
  • Forms customizable with logos and colors
  • Unlimited custom questions
  • Optional Terms & Conditions area
  • Attach PDF files
  • Events have own hyperlink or can use iFrame to appear on website
  • Unlimited Discounts
  • Multiple payment options
  • Customized messages
  • Unlimited registration levels
  • Listing of registered attendees

WooCommerce :: Version1.2

$
0
0

References: http://docs.woothemes.com/documentation/plugins/woocommerce/

WooCommerce (eCommerce plugin)

WooCommerce is a WordPress eCommerce toolkit that helps you sell anything. Beautifully.

Transform your WordPress website into a thorough-bred eCommerce store for free. Delivering enterprise-level quality & features whilst backed by a name you can trust.

Pre-requisites:

  • WooCommerce 2.0+ requires WordPress 3.5 minimum.
  • PHP 5.2.4 or greater
  • MySQL 5.0 or greater
  • The mod_rewrite Apache module (for permalinks)
  • fsockopen support (for payment gateway IPN access)
  • (optional) An SSL certificate if you choose to install any direct payment gateways
  • (optional) Some plugins for WooCommerce require CURL
  • (optional) Some plugins for WooCommerce require SOAP

Source: http://docs.woothemes.com/document/server-requirements/

Note: Here on words we assume that WordPress is installed and working fine

How to install WooCommerce:

Automatic Installation:

  1. Login into your WrodPress admin panel
  2. Select  Plugins->Add New
  3. In the search field type “WooCommerce” and click Search Plugins. Once you’ve found the plugin simply click on ‘Install Now’
  4. Activate the plugin from the Plugins menu within the WordPress admin.

Manual Installation:

  1. Download the plugin to your computer.
  2. Unzip the file.
  3. Using an FTP program, or your hosting control panel, upload the unzipped plugin folder to your WordPress installation’s wp-content/plugins directory.
  4. Activate the plugin from the Plugins menu within the WordPress admin.

Source: http://docs.woothemes.com/document/installation/

How to install Click & Pledge Gateway:

Automatic Plugin Installation:

  1. Go to Plugins > Add New.
  2. Under Search, type in the name of the WordPress Plugin or descriptive keyword, author, or tag in the search form or click a tag link below the search form.
  3. Find the WordPress Plugin you wish to install.
    1. Click Details for more information about the Plugin and instructions you may wish to print or save to help setup the Plugin.
    2. Click Install Now to install the WordPress Plugin.
  4. A popup window will ask you to confirm your wish to install the Plugin.
  5. If this is the first time you've installed a WordPress Plugin, you may need to enter the FTP login credential information. If you've installed a Plugin before, it will still have the login information. This information is available through your web server host.
  6. Click Proceed to continue with the installation. The resulting installation screen will list the installation as successful or note any problems during the install.
  7. If successful, click Activate Plugin to activate it, or Return to Plugin Installer for further actions. 

Manual Plugin Installation:

  1. Download your WordPress Plugin to your desktop.
  2. If downloaded as a zip archive, extract the Plugin folder to your desktop.
  3. Read through the "readme" file thoroughly to insure you follow the installation instructions.
  4. With your FTP program, upload the Plugin folder to the wp-content/plugins folder in your WordPress directory online.
  5. Go to Plugins screen and find the newly uploaded Plugin in the list.
  6. Click Activate Plugin to activate it.

Source: http://codex.wordpress.org/Managing_Plugins

Note: If the installation of Click & Pledge Plugin success you can find it in WooCommerce->Settings-> Payment Gateways->Click & Pledge

Admin login:

http://<your_wordpress_home>/wp-login.php

to log into WordPress admin area.

After login into admin area select WooCommerce->settings to launch WooCommerce Settings Page

How to add Payment Processor?

Then go to WooCommerce-> Settings->Payment Gateways

Then click on Click & Pledge

Select ‘Enable/Disable’. It will display following screen

 

Give ‘Account ID’ and ‘API Account GUID’ in corresponding fields then click on save. Optionally you can select ‘Accepted Credit Cards’. If you don’t select anything it will display all the credit cards in front end.

‘Organization Information to be used’ - Organization information to be used in receipt

‘The Thank You message appearing after the salutation’ - The Thank You message appearing after the salutation

‘The terms & conditions to be added at the bottom of the receipt.’ - The terms & conditions to be added at the bottom of the receipt.

If you what to enable recurring select ‘is Recurring?’. It will display recurring options

 


Adding and Managing Products:

Product Types:

  1. The Simple product type covers the vast majority of any products you may sell. Simple products are shipped and have no options. For example, a can of drink.
  2. A Grouped product is a collection of related products which can be purchased individually and can only consist of simple products. For example, a simple product for a PS3 could be a grouped product as there are 80GB, 120GB and 200GB variations of that same parent product.
  3. An External or Affiliate product is one which you list and describe on your web site, but is sold elsewhere.
  4. A Variable product is a product which has several different variations, each of which may have a different SKU, price, stock options etc. For example a t-shirt available in several different colors and/or sizes.

Note: Product Types: downloadable (digital), or virtual (service) product. Virtual products don’t require shipping – an order containing virtual products won’t calculate a shipping cost.

Source: http://docs.woothemes.com/document/managing-products/

 

Shipping:

WooCommerce > Settings> Shipping

On this page you can find different shipping options

 

Core Shipping Options: WooCommerce comes complete with several basic core shipping methods for offering Flat Rates, Local Pickup, International Delivery, Local Delivery and Free Shipping.

Source: http://docs.woothemes.com/documentation/plugins/woocommerce/getting-started/shipping/core-shipping-options/

Product Shipping Classes:

Source: http://docs.woothemes.com/document/product-shipping-classes/

Source: http://docs.woothemes.com/documentation/plugins/woocommerce/getting-started/shipping/

Taxes:

WooCommerce > Settings> Tax

WooCommerce aims to make setting them up as straightforward as possible.

More options you find on following link

http://docs.woothemes.com/document/setting-up-taxes-in-woocommerce/

 



Get Started :: Version1.5

$
0
0
The integration between Click & Pledge's Payment System and Salesforce allows you to have a World Class CRM with Click & Pledge's feature-rich applications to assist you with your data management and fundraising needs. TO easily get started using Click & Pledge's  Payment as a Service App on the Salesforce platform, follow these easy steps:

Step 1: Apply for a Click & Pledge account

If you already have an account, skip this step. If you do not already have a Click & Pledge account, apply for one here:
https://www.clickandpledge.com/Apply/

Step 2: Apply for a Salesforce account

If you already have a Salesforce account skip this step. For Nonprofit Organizations, you may apply for an account through the Salesforce Foundation. Through the Salesforce Foundation you may receive 10 FREE user licenses for Salesforce CRM. Find out more by going here:
http://www.salesforcefoundation.org/product
Nonprofits must first sign up for a trial version, you choose either the account enabled with the NonProfit Starter Pack or the Enterprise edition.

Then, once you have set up your trial account, you will need to apply for a permanent license from Salesforce: https://www.clickandpledge.com/Platforms/Salesforce/Get_Salesforce.asp#PermanentLicense

Step 3: Install the Click & Pledge Payment Class Library app

This app is available on the Salesforce App Exchange here:
http://appexchange.salesforce.com/listingDetail?listingId=a0N30000009vEKZEA2

Step 4: Install the Click & Pledge Free Payment Processing System or Payment as a Service (PaaS)

To locate the App, use this link:
https://sites.secure.force.com/appexchange/results?type=Apps&keywords=click%20and%20pledge

Step 5: Follow the PaaS Post Installation Instructions

http://manual.clickandpledge.com/Salesforce-PaaS-Post-Installation.html

Step 6: Integrate Click & Pledge and Salesforce.

http://manual.clickandpledge.com/Salesforce-PaaS-Activation.html

Step 7: Run a test transaction

By running a test transaction you will see your contact and transaction data automatically post into your Salesforce account. Here are instructions to run a test transaction:
https://forums.clickandpledge.com/content.php?r=248-Run-a-Test-Transaction

Events :: Version2.5

$
0
0
Event Management Tab

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.

New Event Button
Active Events
: Will list all active Events.
Event Menu
Basic Information - Enter all the basic event details
  • 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*
  • 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.
  • Report Color
  • 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*
  • 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
  • End Date
  • Published Date - Date the event will show on the website

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

C&P Account
C&P Account – If multiple Click & Pledge account, select your account
Display Label- This field will only show if more than 1 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
  1. Login to Click & Pledge portal: https://portal.clickandpledge.com/
  2. then going to Account Info>Accepted Cards
Custom Payment – If you wish to name other payment types, like Cask 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

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
  • Event Coordinator
  • Category
  • Campaign
  • Iframe Code – Iframe code for event is provided
  • Agenda (PDF only) – upload a 
  • Agenda Display Name
  • Event Description
  • Additional Donation – allow patrons to make a donation during registration
  • Label For Additional Donation
  • SKU For Additional Donation
  • Tax Deductible %
  • Campaign For Additional Donation
Levels – select a level to edit the following
Select a Level
  • Name on Reports*
  • Report Color
  • SKU Code
  • Campaign
  • Level Description
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
Receipt
Send Receipt – If choosing to send receipt Click & Pledge will email an itemized receipt to registrant. The following information may be customized with your own text.
  • Organization Information
  • Thank You Message
  • Terms & Conditions
Levels- select a level and customize that level’s Sold Out message. Sold Out message will show if inventory is depleted for that level.

Discount Plans – Create an unlimited number of discount plans. Discount plans may be layered
  • Discount plans are applied to registration levels
  • May be batch uploaded
  • Discounts by  %, Fixed discount or a combination of both
  • Required Start and end date
  • Inventory
  • Coupon code
  • Group discount
Designer-Customize your event page
  • Registration form – Map payee information fields and Custom Questions
  • Widgets – create widgets for your online form for information like weather, maps, etc. If widgets 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.
Check In & Check Out – Check In and Check out attendees using status menu box
  • Authorized devices- using Swiper1 application on smartphones, User devises may be approved to check in and check out attendees.
Registrations – Manage Registrants, Temporary Contacts and manually enter attendees using Box Office

Upcoming Events – Will show events that have a start date greater than today are date.

Archived Events – Events whose end dated have passed.

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.

Box Office – In Box Office you may manually add attendees to an (active) event. Box office can also be accessed through Registrations?
Device Manager – 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.

Troubleshoot :: Version1.4

$
0
0
Updated information coming soon...

Groundwire-Auctions-for-Salesforce :: Version2.4

$
0
0

Overview

In Groundwire Auctions for Salesforce version 3.0 the option to use Click & Pledge as a payment processor has been added. So now, at your auction your patrons can be pre-authorized then charged for their items purchased at the end of the event. Since this will be using the Click & Pledge  Payment as a Serive App, receipts will be automatically emailed to patrons and the organization per usual. And the transaction will be recorded under the Contact's record. 

In order to use Click and Pledge with Groundwire Auctions for Salesforce version 3.0 and higher you need to have:
  • Install Auctions for Salesforce App & follow the installation instruction as provided by the application.  [see documentation]
  • Presumably you should already have a Click & Pledge Account and have installed the Click and Pledge Payment as a Service App on Salesforce. If you have not, you would need do this first.
  • Created an Embedded Virtual Terminal within the Click and Pledge app
  • Complete the 'After Installing' and 'Integrating with a Payment Processor' instructions also available within Groundwire's Install & Configuration Guide. For this you will need to add your Click & Pledge embedded virtual terminal ID and Click & Pledge account ID within custom settings. 

Integrating Auctions for Salesforce with Click & Pledge

Note: These are the instructions as provided in Groundwire's Install & Configuration Guide for version 3.27 updated April 2, 2012. Please refer back to the Groundwire website if this information is outdated.

Auctions for Salesforce provides two integration points that can be configured with Click & Pledge. These integration points are on the ‘Check In’ tab and the ‘Check Out’ tab.

Check In

If you provide a string for the “Credit Card Validate URL Formula” custom setting, the Check In page will then use this property to open a new browser window (or panel) on the provided URL. You will need to provide a URL that invokes the virtual terminal of a credit card processor to capture and validate their credit card info. Various parameters can be specified in the URL Formula, and will be replaced at runtime by data from the page. Here is the list of supported parameters. Note that not all parameters are needed by all providers. Please see the examples and check with your payment processor. Parameter Runtime Value

{0} ID of the Contact

{1} ID of the Auction

{2} Amount

{3} ID of the current Session

{4} Partner Server URL

{5} ID of the Salesforce Organization

For example, the guest's contactId will be substituted into the URL wherever you have {0}, and the auctionId will be substituted into the URL wherever you have {1}.

The following is a sample string you might use for Click & Pledge:

https://evt.salesforce.cloud.clickandpledge.com?SFOrgID={5}&SFeVTID=<you-must-fill-in>&CnPAID=<you-must-fill-in> &SFContactID={0}&b1=Auction Validation Only&up1=0&SubText=Save Payment Info&PreAuth=1&subtxt=Save Payment Info

You will need to fill in the correct Click & Pledge eVT ID and Account ID in the URL above.

Please refer to the documentation for your payment processor to find out what the URL for their virtual terminal is.

Check Out

If you provide a string for the “Credit Card Charge URL Formula” custom setting, the Check Out page will then use this property to open a new browser window (or panel) on the provided URL. You will need to provide a URL that invokes the virtual terminal of a credit card processor to charge their credit card. Please refer to the table for Check In to see what the supported URL Formula parameters are.

The following is a sample string you might use for Click & Pledge:

https://evt.salesforce.cloud.clickandpledge.com?SFOrgID={5}&SFeVTID=<you-must-fill-in>&CnPAID=<you-must-fill-in> &SFContactID={0}&b1=Auction Purchases&up1={2}&showTotal=1&SessionId={3}&ServerURL={4}


For additional resources on Groundwire Auctions for Salesforce see:






Donor-Management :: Version5.1

$
0
0
Join the User Forum:  Salesforce Donor Management User Group

About
Click & Pledge has developed a FREE "real-time" integration with the Salesforce(TM) CRM platform.  Our solution takes advantage of the Salesforce Foundation's FREE offering of 10 Enterprise users to all registered nonprofit organizations.
Below is a recorded overview of the Click and Pledge Payment as a Service Application on the Salesforce AppExchange. Webinar covers:
  • Integration set up
  • Contact creation - control how contacts are created, eliminate duplicates
  • C&P Settings - customize your app
  • Autoresponder - set up automatic email responses based selected criteria
  • Designer - to create custom emails
  • C&P Reports - predefined and custom reports
  • C&P Data - record of data log by transaction
  • Virtual Terminal - for manual transactions, reprocessing, batch processing, inputting cash/check transactions, card swipe
  • Swiper1 - accept transactions from smart phone, integration includes Salesforce lookup
  • and more


Take a Poll
If you are currently using a Donor Management System we would like to know a few things about how you use it and its overall effectiveness in your environment.  Please take a moment to participate in a few polls:

 

Request.Order :: Version2.8

$
0
0
Table of Contents  [ Hide]

Path: CnPAPI.Engine.Request.Order

Elements:

Schema

       <xsd:element name="Order">
              <xsd:complexType>
                     <xsd:sequence>
                           <xsd:element ref="OrderMode"/>
                           <xsd:element ref="Tracker" minOccurs="0"/>
                           <xsd:element ref="Campaign" minOccurs="0"/>
                           <xsd:element ref="GiveBigCampaignAlias" minOccurs="0"/>
                           <xsd:element ref="ConnectCampaignAlias" minOccurs="0"/>
                           <xsd:element ref="CampaignList" minOccurs="0"/>
                           <xsd:element ref="IntegratedPartner" minOccurs="0"/>
                           <xsd:element ref="CardHolder" minOccurs="0"/>
                           <xsd:element ref="ThirdParty" minOccurs="0"/>
                           <xsd:element ref="OrderItemList" minOccurs="0"/>
                           <xsd:element ref="Shipping" minOccurs="0"/>
                           <xsd:element ref="Receipt" minOccurs="0"/>
                           <xsd:element ref="Transaction"/>
                           <xsd:element ref="PassThroughList" minOccurs="0"/>
                     </xsd:sequence>
              </xsd:complexType>
       </xsd:element>

Details for each of the elements are listed below:

OrderMode

Name

 

OrderMode

 

Path

 

CnPAPI.Engine.Request.Order.OrderMode

 

Description

 

Specify the order mode. Test mode may be used for testing and development. In test mode only test credit card numbers may be used. In Production mode transactions are only performed with real credit cards.

 

Data Type

 

String

 

Range

 

Production  -Production Environment

 

Test:  Test environment

 

Default

 

 

Operation

 

Transaction Operation only

 

Input/output

 

Input

 

Version/Release

 

1.2

 

Required

 

yes

 

Example

 

<OrderMode>Test</OrderMode>

 

Schema

 <xsd:element name= "OrderMode" >
  <xsd:simpleType  >
   <xsd:annotation  >
       <xsd:documentation>  Specify the order mode. Test mode may be used for testing and development. In test mode only test credit card numbers may be used. In Production mode transactions are only performed with real credit cards.</xsd:documentation >
   </xsd:annotation  >
   <xsd:restriction base=  "xsd:string" >
    <xsd:enumeration value=  "Production" />
    <xsd:enumeration value=  "Test" />
   </xsd:restriction  >
  </xsd:simpleType  >
 </xsd:element>

Tracker

Name

 

Tracker

 

Path

 

CnPAPI.Engine.Request.Order.Tracker

 

Description

 

Tracker is a simple text that is an optional parameter which is passed along with each transaction. Transactions may be queried in the reporting section based on the Tracker text.

 

Data Type

 

String

 

Range

 

Minimum: blank

 

Maximum: 50 characters

 

Default

 

 

Operation

 

Transaction Operation only

 

Input/output

 

Input

 

Version/Release

 

1.2

 

Required

 

No

 

Example

 

<Tracker>Solicitation20090301</Tracker>

Schema

 <xsd:element name= "Tracker" >
  <xsd:simpleType  >
      <xsd:annotation  >
          <xsd:documentation>  Tracker is a simple text that is an optional parameter which is passed along with each transaction. Transactions may be queried in the reporting section based on the Tracker text.</xsd:documentation >
   </xsd:annotation  >
   <xsd:restriction base=  "xsd:normalizedString" >
    <xsd:minLength value=  "0" />
    <xsd:maxLength value=  "50" />
   </xsd:restriction  >
  </xsd:simpleType  >
 </xsd:element>

Campaign

Name  

Tracker  

Path  

CnPAPI.Engine.Request.Order.Campaign  

Description  

The value for campaign will be matched against the defined campaign in the administrative portal.  It will also post to Salesforce and update the campaign statistics for the matched campaign name.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 80 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

2.30  

Required  

No  

Example  

<Campaign>Spring2020</Campaign>

Schema

Form-Field-Names :: Version9

$
0
0

For a form to post to the FaaS service it has to have fields that match the field names as specified in the API.

Minimum fields required for credit card authorization are as follows:
  • First Name
  • Last Name
  • Credit card number
  • CV2
  • Expiration date (month & year)

     

The following provides a detailed list of field names in the FaaS platform.

Card Holder Information

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

First Name  

 

BillingFirstName  

 

John  

 

50  

 

Middle Initial  

 

BillingMI  

 

G  

 

1  

 

Last name  

 

BillingLastName  

 

Doe  

 

50  

 

Email  

 

BillingEmail  

 

John.Doe@Test.com  

 

50  

 

BillingPhone  

 

BillingPhone  

 

555.111.2222  

 

50

 

Billing Address

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

Address1  

 

BillingAddress1  

 

2200 Kraft Drive  

 

100  

 

Address2  

 

BillingAddress2  

 

Suite 1175  

 

100  

 

Address3  

 

BillingAddress3  

 

 

 

100  

 

City  

 

BillingCity  

 

Blacksburg  

 

50  

 

State or Province

BillingStateProvince

VA  

 

50  

 

Postal Code  

 

BillingPostalCode  

 

24060  

 

20  

 

Country Code  

 

BillingCountryCode  

 

840  

 

3  

 

Shipping Address

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

First Name  

 

ShippingFirstName  

 

John  

 

50  

 

Middle Initial  

 

ShippingMI  

 

C  

 

1  

 

Last Name  

 

ShippingLastName  

 

Smith  

 

50  

 

Email  

 

ShippingEmail  

 

John.Smith@domain.com  

 

50  

 

Phone  

 

ShippingPhone  

 

123 456 7890  

 

50  

 

Address1  

 

ShippingAddress1  

 

2200 Kraft Drive  

 

100  

 

Address2  

 

ShippingAddress2  

 

Suite 1175  

 

100  

 

Address3  

 

ShippingAddress3  

 

 

 

100  

 

City  

 

ShippingCity  

 

Blacksburg  

 

50  

 

State or Province  

 

ShippingStateProvince

Virginia  

 

50  

 

Postal Code  

 

ShippingPostalCode  

 

24060  

 

20  

 

Country Code

 

ShippingCountryCode

840

3

Custom Question

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

Question  

 

FieldName  

 

Employer  

 

200  

 

Answer  

 

FieldValue  

 

Click & Pledge  

 

500  

 

Example:  

 

<input name="FieldName" type="hidden" value="Employer"/>
<input name="FieldValue" type="text" maxlength="500" size="50 />

 

In case of multiple custom questions use a numerical suffix as shown below:

 

<input name="FieldName1" type="hidden" value="Employer"/>
<input name="FieldValue1" type="text" maxlength="500" size="50 />

 

<input name="FieldName2" type="hidden" value="Occupation"/>
<input name="FieldValue2" type="text" maxlength="500" size="50 />

 

<input name="FieldName3" type="hidden" value="Place of Employment"/>
<input name="FieldValue3" type="text" maxlength="500" size="50 />

 

eNewsletter Subscription

Custom question is an optional field

 

Common name

 

FaaS Field name

 

Example

 

Maximum Length

 

Provider

 

eNewsletterName1 /2/ 3

ConstantContact, MailChimp, iContact

 

n/a

 

List name

 

SubscribeList1 /2/ 3/

Membership

 

50  

 


Notes:
The integrated newsletter providers are numbered according to the following list.  The name & the respective list should be numbered accordingly.

 

  • eNewsletterName1 = ConstantContact

     

  • eNewsletterName2 = MailChimp
  • eNewsletterName3 = iContact


Example:

 

    <input name= "eNewsletterName1" type="hidden" value="ConstantContact" /> 

 

    Membership: <input name="SubscribeList1" type="checkbox" id="SubscribeList1" value="Membership" />
    Weekly Updates:  <input name="SubscribeList1" type="checkbox" id="SubscribeList1" value="Weekly Updates" />
    Alerts: <input name="SubscribeList1" type="checkbox" id="SubscribeList1" value="Alerts" />
    Monthly Updates:  <input name="SubscribeList1" type="checkbox" id="SubscribeList1" value="Monthly Updates" />

 

<input name="eNewsletterName2" type="hidden" maxlength="200" size="40" value="MailChimp "/>

 

    Membership: <input name="SubscribeList2" type="checkbox" id="SubscribeList2" value="Membership" />
    Weekly Updates:  <input name="SubscribeList2" type="checkbox" id="SubscribeList2" value="Weekly Updates" />
    Alerts: <input name="SubscribeList2" type="checkbox" id="SubscribeList2" value="Alerts" />
    Monthly Updates:  <input name="SubscribeList2" type="checkbox" id="SubscribeList2" value="Monthly Updates" />
 

Product Information

Common name    

FaaS Field name    

Example    

Maximum Length    

Item ID    

ItemID1   

12345    

20    

Item Name    

ItemName1   

Donation    

50    

Quantity    

Quantity1   

1    

10    

Unit Price    

UnitPrice1   

100    

10    

Other field [special case]*    

Other1   

5.50    

10    

Unit Deductible    

UnitDeductible1   

100    

10    

Unit Deductible %*    

UnitDeductible1   

50% [for 50% tax deductible]    

10    

Unit Tax    

UnitTax1   

0    

10    

Unit Discount    

UnitDiscount1   

0    

10    

SKU  

SKU1  

100-ABCD-2011  

100  

Campaign

Campaign1

Building Fund

80

Important Note:  

 

UnitDeductible: The portion of the UnitPrice that is tax deductible. The amount will be based on the value passed (10 = $10 and 10%=10%). Total tax deductible portion of the item will be calculated based on multiplying the quantity by the UnitDeductible.

 

Total Tax Deduction = UnitDeductible x Quantity

 

Example:

 

Case 1:

 

·  Unit Price = $50

 

·  UnitDeductible = 10

 

o  Total tax deductible = $10

 

Case 2:

 

·  Unit Price = $50

 

·  UnitDeductible = 10%

 

o  Total tax deductible = $5

 

OTHER field

 

FaaS service design is based on simplifying processing payments through simple forms without any need for additional programming. Based on this requirement a problem presents itself when donation forms have donation amounts listed as radio buttons with an additional field which is typically labeled as OTHER.

 

To help with the “OTHER” field problem the following provision is now a feature of FaaS:

 

 

 

  • $10

     

  • $20

     

  • $50

     

  • $100

     

  • OTHER

     

  • [OTHER field]

     

In the above scenario a radio form field passes UnitPrice as the value of the radio field. If the value which is passed by the UnitPrice is “OTHER” then FaaS looks for the amount which is in a text field labeled “OTHER”.

 

The following is a sample HTML demonstrating the above presentation:

 

  <input type="radio" name="UnitPrice1" id="radio" value="$10" />$10<br />

 

  <input type="radio" name="UnitPrice1" id="radio" value="$20" />$20<br />

 

  <input type="radio" name="UnitPrice1" id="radio" value="$30" />$30<br />

 

  <input type="radio" name="UnitPrice1" id="radio" value="$40" />$40<br />

 

  <input type="radio" name="UnitPrice1" id="radio" value="$50" />$50<br />

 

  <input type="radio" name="UnitPrice1" id="radio" value="Other" />Other<br />

 

  Other <input name="Other1" type="text" id="Other1" size="10" />

 

If the radio button option for Other is selected, the Other field text value will be used by FaaS as the value passed.

 

Multiple products

 

As shown in Example 001 multiple products may be added to any form by simply incrementing the fieldname for each item.   The following provides a quick overview example:

 

            <input name="UnitPrice1" type="text" id="UnitPrice1" value="5" size="10" />
            <input name="UnitDeductible1" type="hidden" id="UnitDeductible1" value="100%" /> 
            <input name="ItemID1" type="hidden" id="ItemID1" value="1" />
            <input name="ItemName1" type="hidden" id="ItemName1" value="Cause 1" />
            <input name="Quantity1" type="hidden" id="Quantity1" value="1" />
            <input name="SKU1" type="hidden" id="SKU1" value="ABC-1234" />
            <input name="
Campaign1" type="hidden" id="Campaign1" value="Building Fund" /> 

             <input name="UnitPrice2" type="text" id="UnitPrice2" value="10" size="10" />
            <input name="UnitDeductible2" type="hidden" id="UnitDeductible2" value="5" /> 
            <input name="ItemID2" type="hidden" id="ItemID2" value="2" />
            <input name="ItemName2" type="hidden" id="ItemName2" value="Cause 2" />
            <input name="Quantity2" type="hidden" id="Quantity2" value="1" />
            <input name="SKU2" type="hidden" id="SKU2" value="DEF-1234" />
            <input name="
Campaign2" type="hidden" id="Campaign2" value="Travel Fund" />  

There is no limit on the number of elements that may be passed.

 

Shipping Information

Shipping information is an optional field

 

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

Method  

 

ShippingMethod  

 

FedEx  

 

20  

 

Fee  

 

ShippingValue  

 

30  

 

50  

 

Tax  

 

ShippingTax  

 

2  

 

50

 


Important Note

The following are key points in dealing with shipping.
  • For Shipping to be added to the receipt ShippingMethod has to have a value.  If the value is blank no shipping will be posted.
  • In the absence of "Shipping Address" nodes "Billing Address" will be used for "Shipping Address" nodes.

Receipt Information

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

WID [Required] 1  

 

WID  

 

8354  

 

10  

 

Send Receipt  

 

SendReceipt  

 

true  

 

10  

 

Notification List  

 

EmailNotificationList  

 

test@test.com  

 

45  

 

Transaction Type 2  

 

TransactionType

Payment

 

Authorize
Payment
PreAuthorization

Important Note

1 CheckOutPageID (WID) identifies the checkout page whose information should be used for the receipt information. This is a required field. Other aspects of the checkout page are also carried over to the form. The following are the list of items that are included:

 

  • Salesforce integration

     

  • ConstantContact settings

     

  • MailChimp settings

     

  • Address / Organization Info

     

  • Terms & Conditions

     

  • Notification List

     

TransactionType is only available for Merchant accounts. The setting will be ignored for in-house accounts. The following describes the behavior of each option:

 

  • Authorize: The transaction will be authorized but will not settle. Manual settlement with the gateway will be required.

     

  • Payment: The transaction will be submitted for settlement upon authorization. No manual intervention will be required.
  • PreAuthorization:  The transaction will be submitted as $0.  PreAuthorization posts back the VaultGUID for the credit card which may be used for future transactions.  Nothing will be processed or charged to the card.

Recurring Transactions

Recurring Transaction is an optional field

 

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

Number of payments*  

 

Installment  

 

12  

 

20  

 

Periodicity  

 

Periodicity  

 

Month  

 

Week

2 Weeks  

 

Month  

 

2 Months  

 

Quarter  

 

 6 Months  

 

Year  

 

*The optional “LastPaymentDate” may be used in place of Installments when an end date for a recurring payment is needed. In certain forms a donor may want to choose a recurring option where an end date is selected rather than the number of payments. End date has the following attributes:

 

  •   LastPaymentDate: dd/mm/yyyy

     

End date may also be broken down into its elements as follows:

 

  • LastPaymentDateYear

     (yy)

  • LastPaymentDateMonth

     (mm)

  • LastPaymentDateDay (dd)

Special Condition:
  • Installment = 999:  The special case of 999 translates to indefinite recurring payments.  The receipt message for the recurring payment will NOT display the END DATE and will ask the patron to contact the organization for cancellation.

Mobile Payment [SMS Giving]

Mobile phone number is an optional field

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

Cell phone number*  

 

CellPhoneNumber  

 

15401234567  

 

25

 

Important Note:  

 

The following need to be activated prior to using the Mobile Giving.

 

  • Mobile Giving has to be enabled in the Account Info > Mobile Giving section for the account.

     

  • If a checkout page WID is being used in the form the checkout page has to have Mobile Giving option enabled in its settings.

     

Payment Information

The following payment types are supported:

  • CreditCard
  • Check
  • Invoice
  • Purchase Order

Credit Card

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

Payment Type  

 

PaymentType  

 

CreditCard

 

 

 

Name On Card  

 

NameOnCard  

 

John Smith  

 

50  

 

Card Number  

 

CardNumber  

 

4111111111111111  

 

17  

 

Cvv2  

 

Cvv2  

 

123  

 

4  

 

Expiration Date*  

 

ExpirationDate  

 

04/15  

 

5  

 

Expiration Month  

 

ExpirationMonth  

 

04  

 

2  

 

Expiration Year  

 

ExpirationYear  

 

15  

 

2  

 

Expiration Date may be passed on as a single value as 04/15 or it may be passed individually as month and year. This provision is designed to help with a simple form where month and year are pull-down menus and are posted individually.

 

Check

Gateways: Transfirst

Common name   

 

FaaS Field name   

 

Example   

 

Maximum Length   

 

Payment Type   

 

PaymentType   

 

Check

  

 

Routing Number 

 

RoutingNumber  

 

123456  

 

9   

 

Account Number  

 

AccountNumber

 

123456

17   

 

Account Type

AccountType   

 

CheckingAccount, SavingsAccount  

 

  

 

Check Type 

 

CheckType  

 

Company, Personal

  

 

Check Number

 

CheckNumber

12345 

 

10   

 

The following additional fields required for Global Payments gateway.

 

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

ID Type  

 

IdType  

 

Driver or Military or State  

 

 

 

ID Number  

 

IdNumber  

 

12345678910  

 

30  

 

ID State Code  

 

IdStateCode  

 

VA [state abbreviation code]  

 

 

 

Invoice

Common name   

 

FaaS Field name   

 

Example   

 

Maximum Length   

 

Payment Type 

 

PaymentType

Invoice  

 

  

 

Invoice Number

InvoiceNumber

12345

50

Purchase Order

Common name   

 

FaaS Field name   

 

Example   

 

Maximum Length   

 

Payment Type   

 

PaymentType

PurchaseOrder  

 

  

 

Purchase Order Number 

PurchaseOrderNumber   

 

123456789

50

Service Response

Common name  

 

FaaS Field name  

 

Minimum Length  

 

Maximum Length  

 

Authorization URL  

 

OnSuccessUrl  

 

https://mydomain.com/authorize.html  

 

100  

 

Decline URL  

 

OnDeclineUrl  

 

https://mydomain.com/decline.html  

 

100  

 

Error URL  

 

OnErrorUrl  

 

https://mydomain.com/error.html  

 

100

 

The following responses are sent back as part of the URL upon Authorization:

 

  • on = Order number

     

  • vg = Vault GUID

     

  • au = Authorization code

     

  • gn = Gateway transaction number

     

  • RefID = Reference ID (post back of RefID as shown below).
  • HashResponse = The hash code response based on the security code.  Format:  [SecurityCode][Order Number][Amount]
    • Login to the administrative portal
    • Click on Account Info > Profile > API Information
    • In the FaaS Security Service:
      • Secret Key:  Enter a maximum of 50 characters as a secret key.  The secret key will be included in the hashcode
      • Hash Algorithm:  MD5, SHA-1, SHA-256, SHA-348, SHA-512
    • [Amount] needs to be the full amount with decimal included, for example:  25.00

example:  https://www.clickandpledge.com/developers/faas/example/response/authorize.asp?on=1182513157454111&vg=5f86601d-0ae0-4c0f-9d74-dba9a70fa349&au=220632&gn=4e552ade-9e98-3000-0034-0003ba9896f7&RefID=Example-000

The following forum posts may also be of help:

  • https://forums.clickandpledge.com/showthread.php?t=660
  • https://forums.clickandpledge.com/showthread.php?t=1735

Reference ID

Common name  

 

FaaS Field name  

 

Minimum Length  

 

Maximum Length  

 

Reference ID  

 

RefID  

 

0  

 

No Limit  

 

Reference ID (RefID) may be passed as a hidden variable. The value of RefID will be posted back to the service response URL upon authorization, decline, or error.

 

Account Information

Common name  

 

FaaS Field name  

 

Example  

 

Maximum Length  

 

Guid*  

 

AccountGuid  

 

ddd31189-9a80-41d9-99e7-fdbb4350893c 

 

36  

 

Account ID*  

 

AccountID  

 

14521  

 

10  

 

* Account information may be combined through AccountToken. AccountToken format is as follows:

 

  • AccountToken: AccountGuid/AccountID/CheckoutPageID/Tracker

     

If CheckOutPageID is not needed use -1 as the value

 

  • AccountToken: AccountGuid/AccountID/-1/Tracker

     

AccountToken is useful when a form needs to post all account information fields as an option. For example an organization may have three accounts and wants to use one donation form to accept donations for all three accounts giving the donor the option for donating to a specific account, e.g. Foundation, PAC, and Building Fund. In this case a radio button may be used and AccountToken will be used to pass the account information with each radio button.

 

Order Mode

Common name  

FaaS Field name  

Example

Maximum Length  

Order Mode  

OrderMode  

Production

Production / Test  

Tracker  

Tracker  

Campaign123  

50

Campaign

Campaign

Spring 2011

80

DecimalMark

Amounts may be entered by the end user using comma as a thousand separator or period as thousand separator.  This problem does not have an easy solution from a usability perspective.  The programmer needs to either write a JavaScript to unify the number format or show an error / warning message asking the end user not to use a thousand separator.  To help those programmers that do not know JavaScript the following option offers a regional setting that forces the FaaS system to respond according to a set standard.  See examples for details.

Common name    

FaaS Field name    

Values    

Maximum Length    

DecimalMark  

DecimalMark  

US, ISO  (Default = US)  

3


Example:
The end user enters $1234.56 (One thousand two hundred thirty four Dollars and 56 Cents using a thousand separator as:  $1,234.56

The FaaS service will interpret the value differently based on the following settings:
  • US:   $1,234.56
  • ISO:  $1.23

While there is no easy solution for this problem, the suggested solution offers the most freedom for developers to set the standard based on their regional or standard preference.

Convenience Fee

Convenience fee may be added to approved transaction types.

Common name

FaaS Field name

Example

Maximum Length

Convenience Fee Rate 

ConvenienceFeeRate

3 (for 3%)


Convenience Fee Fixed 

ConvenienceFreeFixed

1.50 (for $1.50)


Postback

Postback method may be set to Post or Get for the authorization response.

Common name

FaaS Field name

Example

Maximum Length

Postback 

Postback

Post or Get



Response description:

  • Get (default):  Authorization code will post back to the Authorize URL.
  • Post:  All posted form values will be posted back in addition to the authorization, decline, and error messages.

ChargeDate

Common name    

FaaS Field name    

Example   

Maximum Length    

Charge date YEAR   

ChargeDateYear   

2013

4

Charge date MONTH

ChargeDateMonth   

10

2

Charge date DAY   

ChargeDateDay   

25

2

The following special treatment is provided for convenience:

  • Charge date Year: If YEAR is NOT passed the current YEAR will be assumed by default
  •  Charge date Month: If MONTH Is NOT passed the current MONTH will be assumed by default

 A payment form may ask the patron to start her payment on a specific date, e.g. beginning of the month. In this case regardless of the day of the month that the payment is being initiated the payment will be charged on the first of the month. If the requested day is invalid (February 31) an error will be returned as invalid date so it is important that the form does not allow for invalid dates to be set for processing.

Please note:

Initiating a payment on the 31st of the month will set the payment to be processed on the first month that has 31 days.

Here are a few examples:

Example 1:

  • Transaction date: January 2, 2013
  • Request processing date: 1st of the month
  • Transaction will process on February 1, 2013

Example 2:

  • Transaction date: January 2, 2013
  • Request processing date: 31st of the month
  • Transaction will process on March 31, 2013

Example 3:

  • Transaction date: January 2, 2013
  • Request processing date: January 1
  • Transaction will process on January 1, 2014

Example 4:

  • Transaction date: January 2, 2013
  • Request processing date: 3rd day of the month
  • Transaction will process on January 3, 2013

Recommendation:

A typical scenario is when a donor wishes to start a recurring payment but wants the payment to be processed on the first of each month and continue every month, e.g. January 1, February 1, March 1, etc.

In such a case it is recommended that the only value that is passed be the ChargeDateDay and the rest not be posted. The following node needs to be added:

  • <input name="ChargeDateDay" type="hidden" id="ChargeDateDay" value="1" />

If a pull down menu is to be provided for selecting the date it is strongly recommended that the pull down menu does not offer 29, 30, 31 as available days to avoid problems with such months as February, April, etc.

Installation :: Version2.9

$
0
0

App Installation

Swiper1 Google Play Store QR CodeSwiper1 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 > Connect 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.
  1. Connected App Name:  Swiper1 (name for internal use only and may be labeled according to internal policies)
  2. API Name: Swiper1
  3. Contact Email: Organization's Admininistrator Email Address
  4. Enable the OAuth Settings 
  5. Callback URL:  This is the most important setting and has to be set up exactly as listed:  https://portal.clickandpledge.com/YourAccount/default.aspx
  6. Selected OAuth Scopes: Full access(full) + Perform requests on your behalf at any time (refresh_token)
  7. Click on SAVE and exit

Swiper1 App Permissions

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.'

Connected App Name Swiper1

Enabling Swiper1 in the Click & Pledge Application

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

CAP Settings
  1. Click on C&P Settings
  2. Click on Swiper1 tab
  3. Check the Activate Swiper1 checkbox
  4. 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:
  1. Login to the Click & Pledge administrative portal [https://portal.clickandpledge.com]
  2. Click on Account Info > 3rd Party > Salesforce Swiper1
  3. 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 /)
  4.  Swiper1 Salesforce Instance URL
  5. Copy the Consumer Key and Consumer Secret from Salesforce in the previous step.
  6. Click on Verify connection to establish connection.
  7. A new tab will be opened with Salesforce login page.
  8. Login to Salesforce to verify connection
  9. Upon confirmation save the settings and exit.
CAP Third Party Swiper1

eNewsletters :: Version2.8

$
0
0

Path: CnPAPI.Engine.Request.Order.eNewsletters

Elements:

Schema

      <xsd:element name="eNewsletters">

            <xsd:complexType>

                  <xsd:sequence>

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

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

eNewsletterProvider

Path: CnPAPI.Engine.Request.Order.eNewsletters.eNewsletterProvider

Elements:

Schema

      <xsd:element name="eNewsletterProvider">

            <xsd:complexType>

                  <xsd:sequence>

                        <xsd:element ref="eNewsletterName"/>

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

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

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

                        <xsd:element ref="SubscribeList"/>

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

Example

<eNewsletters>

<eNewsletterProvider>

 <eNewsletterName>ConstantContact</eNewsletterName>

 <eNewsletterUserID>CCUserID</eNewsletterUserID>

 <eNewsletterPassword>CCPassword</eNewsletterPassword>

 <SubscribeList>

 <ListName><![CDATA[General Interest]]></ListName>

<ListName><![CDATA[Membership News]]></ListName>

 </SubscribeList>

</eNewsletterProvider>

<eNewsletterProvider>

 <eNewsletterName>MailChimp</eNewsletterName>

 <eNewsletterUserID>MCUserID</eNewsletterUserID>

 <eNewsletterPassword>MCPassword</eNewsletterPassword>

 <SubscribeList>

 <ListName><![CDATA[aSampleList]]></ListName>

 </SubscribeList>

</eNewsletterProvider> 

</eNewsletters>

eNewsLetterName

Name

eNewsletterName

Path

CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.eNewsletterName

Description

eNewsletter company name. Only the integrated companies may be used.

Data Type

String

Range

ConstantContact, MailChimp, iContact

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

1.4

Required

No

Example

<eNewsletterName>ConstantContact</eNewsletterName>

Schema

       <xsd:element name="eNewsletterName">

              <xsd:simpleType>

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

                           <xsd:enumeration value="ConstantContact"/>

                           <xsd:enumeration value="MailChimp"/>

                           <xsd:enumeration value="iContact"/>

                           <xsd:enumeration value="PredictiveResponse"/>

                     </xsd:restriction>

              </xsd:simpleType>

       </xsd:element>

eNewsLetterUserID

To avoid entry of UerID & Password enable the provider in the administrative system and add it to a checkout page. Use the WID in the API. The API will retrieve the information from the administrative system. To subscribe a user to a list, post the ListName as the only required field.

Name

eNewsletterUserID

Path

CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.eNewsletterUserID

Description

eNewsletter company account UserID

Data Type

String

Range

Minimum: 1 character

Maximum: 50 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

2.0

Required

No

Example

< eNewsletterUserID>myUserID</eNewsletterUserID >

Schema

      <xsd:element name="eNewsletterUserID">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

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

                        <xsd:minLength value="1"/>

                        <xsd:maxLength value="50"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

Notes:

To avoid entry of UerID & Password enable the provider in the administrative system and add it to a checkout page. Use the WID in the API. The API will retrieve the information from the administrative system.  To subscribe a user to a list, post the ListName as the only required field.

eNewsLetterPassword

To avoid entry of UerID & Password enable the provider in the administrative system and add it to a checkout page. Use the WID in the API. The API will retrieve the information from the administrative system. 

Name

eNewsletterPassword

Path

CnPAPI.Engine.Request.Order.ThirdPartyeNewsletters.eNewsletterPassword

Description

eNewsletter company account password

Data Type

String

Range

Minimum: 1 character

Maximum: 50 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

1.3

Required

No

Example

<eNewsletterPassword>myPassword</eNewsletterPassword>

Schema

      <xsd:element name="eNewsletterPassword">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

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

                        <xsd:minLength value="1"/>

                        <xsd:maxLength value="50"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

Notes:

eNewsletterPassword is optional if the information is set for the checkout page ID used for the WID node. If the provider is enabled for the checkout page, the API will automatically take the settings provided in the administrative system.

eNewsLetterCustomParam1

The parameter is used for providers that require additional information, e.g. iContact and the use of URL.

Name

eNewsletterCustomParam1

Path

CnPAPI.Engine.Request.Order.ThirdPartyeNewsletters.eNewsletterCustomParam1

Description

eNewsletter API additional parameter if needed

Data Type

String

Range

Minimum: 1 character

Maximum: 200 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

2.52

Required

No

Example

<eNewsletterCustomParam1>myPassword</ eNewsletterCustomParam1>

Schema

      <xsd:element name="eNewsletterCustomParam1">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

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

                        <xsd:maxLength value="200"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>   

 

SubscribeList

Path: CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.SubscribeList

Element:

Schema

      <xsd:element name="SubscribeList">

            <xsd:complexType>

                  <xsd:sequence>

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

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

 

ListName

Name

ListName

Path

CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.SubscribeList.ListName

Description

List to subscribe. Repeat this node for all subscribed lists.

Data Type

String

Range

Minimum: 1 character

Maximum: 50 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

1.3

Required

No

Example

<ListName >Monthly Newsletter</ListName >

<ListName >Activity Report</ListName >

Schema

      <xsd:element name="ListName">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

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

                        <xsd:minLength value="1"/>

                        <xsd:maxLength value="50"/>

                  </xsd:restriction>

            </xsd:simpleType>

Viewing all 249 articles
Browse latest View live




Latest Images