User Guide for
Brickwork Version: 4.5013 Last Updated: June 20th, 2016 iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Table of Contents 1
Document Version ...................................................................................................................... 4
2
iATS Payments Contact Information........................................................................................... 5
3
Overview .................................................................................................................................... 6
4
3.1
Brickwork of Brickwork Training and Features ............................................................................. 6
3.2
User Guide Training Workflow: .................................................................................................. 6
3.3
Custom Objects and Features of Brickwork ................................................................................. 7
How To: Process Transactions in Brickwork (iATS Button) ....................................................... 15 4.1
Process One-Time Transactions via the iATS Virtual Terminal ....................................................... 15
4.2
Schedule a Recurring iATS Transaction using the iATS Virtual Terminal ......................................... 19
4.2.1
Schedule Recurring Transactions using the NPSP Payments Object.......................................... 19
4.2.2
Schedule Recurring Transactions using the NPSP Recurring Donations Object ........................... 23
4.2.3
Schedule Recurring Payments to utilize one Opportunity Record (Standard iATS Method) .......... 29
4.3 5
How To: Integrate the iATS Virtual Terminal within “Auctions for Salesforce”......................... 34 5.1
6
Cancel an iATS Customer Code Recurring Schedule or Edit Payment Details ................................... 32
Add Brickwork Check In & Check Out Virtual Terminals to Auctions ............................................... 34
How To: Integrate Aura online processing with Campaign ID’s and/or Record Types .............. 36 6.1.1
Method 1 - Add Campaign ID and/or Record Type ID’s onto the web page Button/link URL
(Recommended) .......................................................................................................................... 37
7
6.1.2
Method 2 - Add Campaign ID and/or Record Type ID’s onto the Salesforce Site ........................ 38
6.1.3
Method 3 - Add Campaign ID and/or Record Type ID’s on URL hyperlink ................................. 39
Workflows for Aura Payment Processing via a Webpage .......................................................... 41 7.1
Aura / Brickwork Integration Workflow – One-Time Transaction ................................................... 41
7.2
Aura / Brickwork Integration Workflow – Recurring Transaction .................................................... 42
7.3
Aura to Salesforce Post Error – Email Notification ....................................................................... 44
8
How To: Refund an iATS Transaction ........................................................................................ 45
9
Download Journal Import for iATS Transactions – Process flow .............................................. 46 9.1
Transaction Import Workflow ................................................................................................... 47
9.2
(New) NA ACH/EFT Returns Workflow ....................................................................................... 48
9.3
(New) UK Direct Debit BACS Returns Workflow .......................................................................... 49
Page 2 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9.4
Download Journal Notification Emails: ....................................................................................... 50
9.5
Schedule the Automatic Nightly Download Journal ...................................................................... 52
9.6
Reviewing or Cancelling the Nightly Download Journal ................................................................. 53
9.7
Manual Download Journal Import .............................................................................................. 54
10 (New) iATS Returns for NA ACH and UK Direct Debit ............................................................... 55 10.1
Special notes for UK Direct Debit clients re: BACS Reports ..................................................... 56
10.2
iATS Return Workflow for UK BACS Clients ........................................................................... 58
10.2.1
Workflow ...................................................................................................................... 58
10.2.2
Visual Workflow ............................................................................................................ 59
10.3
iATS Return Workflow for NA ACH/EFT Clients ...................................................................... 60
10.3.1
Workflow ...................................................................................................................... 60
10.3.2
Visual Workflow ............................................................................................................ 61
11 Administrative Tasks ................................................................................................................ 62 11.1
Confirm your Current Brickwork Version Number .................................................................. 62
11.2
Grant iATS Personnel Temporary Access to Salesforce ........................................................... 62
11.3
Manually Re-schedule the Payments Apex Class ................................................................... 64
11.4
Cumulative Roll-up Fields................................................................................................... 65
12 Brickwork Reporting ................................................................................................................ 66 13 FAQ’s........................................................................................................................................ 67 13.1
View Additional Details in Brickwork Custom Tabs ................................................................. 67
13.2
View Additional Fields in iATS Related List’s ......................................................................... 67
13.3
Subsequent Recurring Transactions..................................................................................... 67
13.4
Rejected Transactions ....................................................................................................... 68
13.5
Opportunity/Donation Names ............................................................................................. 68
13.6
Survey Fields ................................................................................................................... 68
13.7
Virtual Terminal (iATS Button) Visibility Issues ..................................................................... 68
13.8
Guest User Modifications.................................................................................................... 69
13.9
iATS Aura Setup tab issues ................................................................................................ 71
13.9.1
Internet Explorer: ......................................................................................................... 71
13.9.2
Chrome ........................................................................................................................ 73
Page 3 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
1 Document Version Document
Change
4.5011
•
Replaced images of Virtual Terminal to include new “Edit”
Date of Change: April 18th, 2016
expiry date feature. •
Added Best Practices details throughout guide.
•
Updated Import Customer Codes section to use the Data Import Wizard tool from Salesforce.
4.5
•
Addition of iATS Returns object to track ACH/EFT Return notices
Sep 8th, 2015
and UK Direct Debit BACS reports (section 9). 4.3004
•
Various Bug Fixes
Feb 25th, 2015
4.3002
•
Various Bug Fixes
Jan 22nd, 2015
4.3001
•
Updates to Download Journal notes, and new section (9.3.1)
Dec 18th, 2014
added to provide information on Notification Emails. •
New Section (9.5) added to provide information on roll-up fields and how to disable the trigger.
•
Update to maximum number of iATS Merchant Accounts from 3 to unlimited.
4.2
NPSP 3.0 Households Integration & Invoice Mapping
Oct 6th, 2014
4.1512
Recurring Donation Mapping
July 3rd, 2014
4.1506
Various Bug Fixes
Feb 11th, 2014
4.1505
Various Bug Fixes
Jan 14th, 2014
4.15
Guide updated to include new Recurring Donation and Payments
Dec 10th, 2013
integrations (Section 5.2).
Page 4 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
2 iATS Payments Contact Information North America: www.iatspayments.com UK/Europe: www.uk.iatspayments.com Customer Care: Email:
[email protected] Phone: North America: 1-888-955-5455 | UK/Europe: 0808-234-0466 Hours: 7:30am – 5:00pm Pacific Standard Time, Monday to Friday 8:00am – 4:00pm Pacific Standard Time, Saturday Sales and Marketing: Email:
[email protected] Phone: North America: 1-866-300-4287 | UK/Europe: 0808-234-0466 Hours: 6:00am – 4:30pm Pacific Standard Time, Monday to Friday For the most up to date versions of our documentation, this Brickwork Installation & Configuration Guide, the Brickwork User Guide, and Aura Guides can be downloaded by visiting our website. As a Level 1 Payment Card Industry (PCI) certified company, iATS Payments ensures all transactions are handled with the highest industry standards in security and confidentiality.
Page 5 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
3 Overview 3.1 Brickwork of Brickwork Training and Features Brickwork is a native Salesforce (www.salesforce.com) Application that brings the power of iATS Payment Processing directly into your Salesforce environment. Whether donations are received via the phone or through your website, Brickwork enables your organization to process credit card payments and maximize your revenue. With the ability to process one-time transactions and schedule recurring payments, Brickwork eliminates the hassle of manual data entry into your Salesforce CRM. Real-time processing allows for greater workload efficiency and rapid results. With the ability to create donation pages directly using Brickwork‘s Aura custom tab, taking your fundraising efforts online is a snap. Brickwork is fully integrated with the Non Profit Starter Pack, including the Recurring Donations App and the standard Payments object within the Contacts & Organizations App, and the NPSP 3.0 Households Account Data Model. If not already done, please click here to download our Brickwork Installation and Configuration guide for more information on how to customize Brickwork to interact with your unique Salesforce instance. Please also take a look at our Brickwork Video Series, found here.
3.2 User Guide Training Workflow:
Ensure all steps from Installation and Customization Guide have been completed
Page 6 of 73
Read User Guide and Watch our Virtual Terminal Videos
Review steps on best practice for processing transactions with Brickwork Virtual Terminal and/or NPSP
Perform tests using the iATS Button (Virtual Terminal) for both onetime and recurring
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Train Staff on how to use BW and reach out to iATS Customer Care if you have any questions
Brickwork User Guide Version 4.5
3.3 Custom Objects and Features of Brickwork iATS Merchant Account iATS Client Codes and passwords are stored as iATS Merchant Accounts, which replaces the need for traditional Merchant numbers. Brickwork currently supports up to three merchant accounts, and up to 99 unique iATS SubCodes (for example TEST88), 10 of which can be “Active” for manual use within in the Brickwork Virtual Terminal. For more information on iATS Client Codes, please contact us at
[email protected].
iATS Customer Codes iATS Customer Codes are unique tokens that represent the donors payment information and recurring schedule details which have been securely stored within the iATS servers. The last four digits of the Credit Card and/or bank account and related recurring details are displayed. The Brickwork Virtual Terminal can be used to create these tokens, and make any necessary edits in the future.
Page 7 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
iATS Transactions iATS Transactions are individual Credit Card or ACH/EFT transactions which have been processed via your iATS Payments merchant account. Each iATS Transaction is represented by a unique Transaction ID and contains details pertinent to the charge such as Approval or Rejection status and the Date & Time.
Refund Transactions In addition, full Credit Card Refunds can be processed within Brickwork via the iATS Transaction.
Page 8 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Brickwork Virtual Terminal Also known as the iATS Button, the Brickwork Virtual Terminal is used to charge Single Credit Card or ACH/EFT transactions, to schedule Recurring Credit Card or ACH/EFT/Direct Debit transactions, and to amend all saved payment details and schedule details within an iATS Customer Code.
Additional Virtual Terminal features: •
Manual or Credit Card Swipe (non-encrypted) payment details entry. The Card Swipe option can be set as the default entry method if selected on the iATS Settings tab.
•
Create iATS Customer Codes and Opportunity (Donation) records directly within the terminal.
•
Can be added to the Contact, Opportunity and/or Account objects.
Page 9 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
iATS Settings The iATS Settings tab is where all customizations are set to tell your unique Salesforce environment how Virtual Terminal and Aura transactions should be handled by Brickwork (Stage, Contact Role, etc) and if the Non Profit Start Pack applications are being used.
For more information about the Nonprofit Starter Pack, including information on the Recurring Donations App and the Payments Object (within the Contacts & Organizations App) please visit the following helpful link: General NPSP: http://www.salesforcefoundation.org/products/nonprofit_starter_pack
Page 10 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Aura and AuraLink – Secure Online Donation Web Form Integration Aura and AuraLink refer to the secure online donation web form which integrates seamlessly into an existing website, and connects to Salesforce using Sites. Aura and AuraLink have built-in integration with Brickwork to ensure that all online transactions are imported into Salesforce automatically.
For more information about how to build an Aura online donation form, please refer to the Aura Installation Guide, which can be downloaded at www.iatspayments.com, or the AuraLink documentation which is available by contacting iATS Customer Care
[email protected].
Page 11 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Download Journal Import The Manual or Automated Download Journal retrieves an iATS Journal report containing all transaction data processed the prior day, or for a span of dates. This ensures all recurring iATS Transactions are imported within your Salesforce environment as iATS Transactions. As of September 2015 all returned ACH/EFT and UK Direct Debit transactions are also included and imported as new iATS Return records.
For more information on how the Download Journal process works, please refer to the visual workflow diagram within the Brickwork User Guide.
Multi-Currency Integration Brickwork is fully compatible with the Multi-Currency feature within Salesforce. For more information on how choose a Multi-Currency option, please visit: https://help.salesforce.com/apex/HTViewHelpDoc?id=admin_currency.htm&language=en_US
Campaign and Record Type Integration Online Aura form processing (Opportunity/Donations & Contacts) can be customized to use specific Record types or be related to specific Campaigns within Salesforce if required. Campaign ID’s and Contact and Opportunity Record Type ID integration can be added to your Aura donation form in three different ways to provide maximum flexibility. For complete instructions on how to associate Aura online processing to Campaigns and assign Record Types, please see the “Integrate Aura online processing with Campaign ID’s and/or Record Types” section of this guide.
Page 12 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Recurring Payment Tracking Options As of Version 4, Brickwork is fully integrated with the Payments object within the Contacts & Organization NPSP App, and the Recurring Donations NPSP App to record and organization recurring payments! We now offer four unique methods of recording recurring transaction and Opportunity data. Before configuring Brickwork, please review the below options: 1. Standard iATS option - One Opportunity with multiple iATS Transactions: When Brickwork is installed this is the default method to record all online Aura recurring transaction and Opportunity data. iATS Customer Codes are created automatically and related to one new Opportunity Record for online Aura donation form processing. All future transactions (approved or rejected) for that donor’s recurring schedule will be processed by iATS and imported into Salesforce as individual iATS Transactions related to that single Opportunity. Opportunities and Payments can also be set up manually via the iATS Virtual Terminal. 2. Payments Integration - Multiple Payment Records related to one Opportunity: When the NPSP Contacts & Organizations Payments option is enabled and configured within iATS Settings, an iATS Customer Code and Payment records are created automatically and related to one new Opportunity Record for online Aura donation form processing. All future transactions (approved or rejected) for that donor’s recurring schedule will be processed by iATS and imported into Salesforce as individual iATS Transactions and related to each Payment record based on Date and Amount. Each Payment record will be marked as “Paid” based on the approval or status of the iATS Transaction. Note: All single/one-time online transactions will have one Opportunity and one Payment record created for reporting purposes. 3. Recurring Donation Integration - Multiple Opportunities related to one Recurring Donation: When the NPSP Recurring Donations App is installed and configured within iATS Settings, an iATS Customer Code and Recurring Donation record is created automatically for online Aura donation form processing. As per the Recurring Donation App settings, multiple child Donation (Opportunity) records will be created with the stage of Pledged and related to the parent Recurring Donation. All future transactions (approved or rejected) for that donor’s recurring schedule will be processed by iATS and imported into Salesforce as individual iATS Transactions and related to each child Donation record based on Date and Amount. Each Donation record will be marked as “Posted” based on the approval status of the iATS Transaction. Note: All single/one-time online transactions will have one Opportunity record created as the NPSP Recurring Donation app is used to record recurring transactions only. 4. No Opportunity Records option: iATS Customer Codes are created automatically and related to the Contact Record for online Aura donation form processing. All future transactions (approved or rejected) for that donor’s recurring schedule will be processed by iATS and imported into Salesforce as individual iATS Transactions related to that iATS Customer Code and Contact Record. Opportunities will not be created automatically by Brickwork at any time. To watch our video on the Brickwork Recurring Payment options, click here!
Page 13 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
(New) iATS Returns for ACH and UK Direct Debit Transactions Launched in September 2015, Brickwork now includes a new custom record called iATS Returns. These records are automatically imported from iATS Payments to Salesforce via the Brickwork Nightly Download Journal process, providing added visibility into returned NA ACH/EFT and UK Direct Debit iATS Transactions. Where you previously needed to review the iATS Portal or the Smart Debit UK website, now your data is where you need it…within Salesforce!
For more information on iATS Returns, please see Section 9 of this User Guide.
Page 14 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
4 How To: Process Transactions in Brickwork (iATS Button) The Virtual Terminal, or iATS Button, is used to process Credit Card and ACH/Direct Debit transactions directly within Brickwork, and used to set up recurring transactions. The Virtual Terminal securely sends donor information directly to iATS Payments, and should be used to process all One-time transactions, set-up all Recurring transaction schedules, and to make any changes to an existing iATS Customer Code. •
The Virtual Terminal can be placed on the Contact, Opportunity, Account, and/or Recurring Donation objects as needed and each one works directly with that object.
•
Credit Card data can be entered into the Virtual Terminal manually or by swiping the credit card (nonencrypted readers only at this time). To utilize the Card Swipe option, a separate non-encrypted USB Card Reader is required.
•
To refund a Credit Card iATS Transaction, please see the “How To: Refund an iATS Transaction” section of this guide. Non-encrypted simply means the card details are clear text within the VT fields, this does not affect the security of the Virtual Terminal connection to iATS.
•
To cancel or edit a recurring transaction schedule, the Virtual Terminal must be used to access iATS Servers. Please see the “Cancel an iATS Customer Code Recurring Schedule or Edit Payment Details” section of this guide for more information.
The following series of instructions refer to the recommended workflow for processing Single and Recurring transactions using Brickwork to ensure transaction record information is related to other Salesforce records properly. As all internal organization processes and workflows differ, these steps are recommended guidelines only.
4.1 Process One-Time Transactions via the iATS Virtual Terminal Also known as the iATS Button, the Brickwork Virtual Terminal is used to charge Single Credit Card or ACH/EFT transactions, to schedule Recurring Credit Card or ACH/EFT/Direct Debit transactions, and to amend all saved payment details and schedule details within an iATS Customer Code.
Page 15 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
•
When the Create New Donation checkmark box is selected, Opportunity/Donation record will be created as: DONOR NAME – iATS CC Single Payment DATE. For example: “Joe Smith – iATS CC Single Payment 5/22/2012”. If not checked, no new Donation record will be created.
•
If the optional Save Payment Information checkmark box is selected, an iATS Customer Code record will be created and the donor’s payment information will be securely stored within iATS Payments. If not checked, payment details will only be recorded within the transaction detail.
To process a single one-time iATS Transaction against the Contact Record: 1. Locate the “Contact” record for the donor. 2. Click the iATS Button to open the Virtual Terminal window. 3. Select the appropriate iATS Merchant Account (Sub-Code from iATS) using the drop-down menu in Account Name. Page 16 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
4. If a One-time use Customer Code already exists for the donor, it can be selected via the drop-down menu on the top right side of the terminal. Please note that we do not recommend utilizing a Recurring scheduled Customer Code for One-time transactions due to reporting purposes. If a new One-time Customer Code needs to be created, all previously stored information can be cleared from view by selecting “None” from the menu. 5. The donor’s contact information will automatically populate the “Payer Information” section of the Terminal from data contained within the donor’s Contact Record. 6. By default, the “One Time Payment” button will be selected. 7. Select “Credit Card” or “Bank Withdrawal”. Note: Our Pound Sterling users with Direct Debit abilities are unable to process one time transactions due to BACS regulations. For Credit Card transactions, enter:
Page 17 of 73
•
Total Amount
•
Card Type (Manually or via Card Reader) iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
•
Card Number (Manually or via Card Reader)
•
Expiry Date (Manually or via Card Reader)
•
Invoice Number (optional)
For Bank Account transactions, enter: •
Total Amount
•
Account Type
•
Bank Number (CDN Only)
•
Transit Number (CDN) or Routing Number (US)
•
Bank Account Number
•
Invoice Number (optional)
8. The “Save Payment Information” check mark box allows you to securely store the Credit Card or Bank Account details directly on the iATS Servers. When this option is selected, an iATS Customer Code will be created. Note: Please ensure you have the iATS Customer Code related list on the page layout for Contact and Opportunity/Donation. 9. The “Create New Donation” check mark box will create a new Opportunity/Donation record for this one time transaction (recommended). If desired, this checkmark can be defaulted via iATS Settings. In addition, if the NPSP Payments Object is enabled, creating a new Donation (Opportunity) will also create a new Payment record for the one-time transaction. 10. Click the "Process One Time Payment" button to process the payment or click the "Cancel" button to cancel the payment. 11. The transaction results will be displayed. Click the "Close this Window" link or manually close the Virtual Terminal window. 12. Refresh the Contact record to view newest iATS Transaction, Opportunity and if applicable, iATS Customer Code information.
Page 18 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
4.2 Schedule a Recurring iATS Transaction using the iATS Virtual Terminal The Virtual Terminal, or iATS Button, is utilized to set-up Recurring Credit Card and ACH/Direct Debit Transactions. iATS Customer Codes are unique tokens that represent the donor’s payment and recurring schedule information which has been securely stored in the iATS servers for automatic processing. •
Subsequently processed recurring iATS Transaction details are retrieved from the iATS servers via the Nightly Download Journal, and posted to related Brickwork records the day after the transaction has been processed. This Apex Class should have been scheduled during the installation steps on an automated nightly basis (recommended), or can also be pulled manually via the iATS Settings Tab. For more information regarding the Download Journal, please see the “Administrative Tasks” section of this Guide.
The following series of instructions refer to the recommended workflow for scheduling recurring transactions within Brickwork to ensure each iATS Transaction record is related to other Salesforce records properly.
4.2.1 Schedule Recurring Transactions using the NPSP Payments Object Comments on Brickwork and the Payments object: • • • • • •
Payments can be created manually or automatically via Aura and will relate to all future iATS Transactions. No need to use the standard Payments Schedule Wizard provided by Salesforce as the Virtual Terminal (iATS Button) schedules new Payments for you! Use the “Do Not Automatically Create Payment” checkmark on the main Opportunity when scheduling manually to avoid having an extra Payment record created. Edits to the schedule or payment records should only be done via the Virtual Terminal (iATS Button) and will affect existing Payments as per options controlled via the iATS Settings Tab (image below). Standard Payments roll-ups are utilized. New future Payment records will be created automatically via an Apex which was scheduled during installation of the Payments add on extension. Should the Apex need to be re-created (for example if the user who installed Brickwork has left the organization, or if it was deleted), the Class name is 'IATSPayments_Payments_SCHED'. Instructions on how to create the Apex can be found in Section 10.5 of this User Guide.
** Important**: Instead of using the default Payments schedule Wizard, please use the iATS Virtual Terminal to create a new Customer Code and recurring schedule. Once done, new Payments will be created as per the schedule and limits set within iATS Settings. Any modifications should also be done via the iATS Virtual Terminal, and not the Payments Wizard.
Page 19 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
1. Create a New Donation (Opportunity) to house new Payments: A. Locate the Contact record for the donor in order to create a new Opportunity/Donation record. If created via the related list on the Contact record, the new record will automatically be related to the Contact. Data from the new Donation (Opportunity) will be imported into the iATS Virtual Terminal, and be used to create the new Payment Records.
B. Name the record using our recommended format if desired: Donor Name – iATS MOP Recurring Payment – Date. For ex: Joe Smith- iATS CC Recurring Payment 5/11/2012 C. Check the Do Not Automatically Create Payment field. If not visible, please add to your Opportunity page layout. This will prevent one Payment being created and added to the opportunity and allow you to make all needed future payments at once using the Virtual Terminal in the next steps. D. Complete the required fields and any that are pertinent to your unique organization.
Page 20 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
2. Instead of using the Payments Wizard, click the iATS Button to launch the Virtual Terminal from within the newly created Record:
3. Select the appropriate iATS Merchant Account using the drop down menu in Account Name. 4. Click the “Recurring Payments” button. 5. Select “Credit Card” or “Bank Withdrawal”. 6. Select the recurring schedule information in the Recurring Payments section: •
Recurring Amount to be charged each time (value will populate the Payment amount field)
•
Begin Date (UK Direct Debit: Begin Date must be at least 13 days in the future)
•
End Date
•
Schedule Type
•
Schedule Date – For the “Weekly” schedule type, Sunday is the first (1) day of the week. Note: This option is not visible when scheduling Quarterly or Annual recurring transactions as the Begin Date acts as the Schedule Date.
Page 21 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
7. You should now have multiple Payment Records created based on the schedule selected, and a related iATS Customer Code:
Please note that iATS Transactions will be imported via the nightly download journal and related the day after they have been charged by iATS, and will be related to each Payment:
8. Should the iATS Customer Code or Payment schedules need to be edited or modified in the future, please use the iATS Button to access the iATS Customer Code. Any changes made to the schedule or amount, will be automatically applied to the future unpaid Payment Records.
Page 22 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
4.2.2 Schedule Recurring Transactions using the NPSP Recurring Donations Object There are two different options for creating new Recurring Donation child records, Open Ended or Non-Open Ended. Additional information can be found here. Open Ended Donations - Open ended Recurring Donations creates a set of Opportunities per a predefined schedule out to a certain time in the future (default is 12 months). As Opportunities are closed, statistics are updated on the Recurring Donation object to reflect the changes. In addition, every evening the Recurring Donation checks to see if additional Opportunities need to be created to maintain 12 (or whatever your settings are configured to) months’ worth of Opportunities, based on the schedule you define.
Non-open-ended Donations - Non-open-ended Recurring Donations create a set of Opportunities per a predefined schedule at the time the Recurring Donations record is updated. Any subsequent updates or edits to the Recurring Donations record or the associated Opportunities will not affect either the Opportunities or Recurring Donations record itself. The Brickwork Virtual terminal compensates for this and will make changes/delete records if used to the edits/changes.
Comments on Recurring Donations and Brickwork: •
New child Donation Records can be created manually via the iATS Button (Virtual Terminal) from the parent Recurring Donation record, or automatically via Aura.
•
Edits to the schedule should be done via the iATS Button on the parent Recurring Donation record so that all changes affect the iATS Customer code record on iATS servers, and will be automatically applied to existing open child Donations as per the “Change” option selected within the iATS Settings Tab.
•
Standard Salesforce Recurring Donation roll-ups are utilized.
Page 23 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Important: By default the stage for all new “open” child Donation records created by the Recurring Donations NPSP app or via Aura will be 'Pledged' as this is the default of the app. When they are closed automatically by the nightly download journal import or closed because of schedule date changes made via the Virtual Terminal, Brickwork will change the stage to the “Closed” value chosen within the 'Stage if iATS Transaction is Approved/Rejected' fields on the iATS settings page:
•
To view your current Stage Types, please click on Setup -> App Setup -> Opportunity -> Fields -> and click on Stage within the Opportunity Standard Fields section. Types can be 3 values: Open, Closed/Won, and Closed/Lost, however Brickwork doesn't update opportunity records that are closed (Closed/Won and Closed/Lost) because it is assumed that a payment (via IATS transaction or any other payment method) has already been received for the opportunity or that the opportunity is lost.
4.2.2.1
Open-Ended Recurring child Donations:
1. Locate the Contact record for the donor in order to create a new parent Recurring Donation record to house the child Donation records. If created via the related list on the Contact record, the new record will automatically be related to the Contact. Also, Data from the new Recurring Donation record will be imported into the iATS Virtual Terminal, and be used to create the new child Donations.
2. Name the record using our recommended format if desired: Donor Name – MOP iATS Recurring Payment – Date. For ex: Joe Smith- iATS CC Recurring Payment 5/11/2012 3. Complete the required fields as per the below suggestions:
Page 24 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Open Ended Status = Open
Date Established = Date of first charge
Next Donation Date = Can be set to first transaction date or left empty.
Amount = Amount to be charged for each recurring transaction (copies to Installment Amount upon Saving)
Installment Period = Schedule (iATS Schedule options are Monthly, Weekly, Quarterly, Annual)
Installments = Can be set to blank or the number of known transactions.
4. Click Save. 5. You should now have multiple Donations created:
6. ** Important**: In order to schedule the recurring payments, an iATS Customer Code needs to be created and stored within the iATS servers. To create the Customer Code, click the iATS Button (Virtual Terminal). Page 25 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
7. Most fields will be auto populated from the Recurring Donations record however the Credit Card (or ACH Bank Account details) will need to be added. 8. Click Create recurring Payments, and close the terminal. Refresh the page to view the new iATS Customer Code:
9. ** Important**: The iATS Customer Code will not automatically be related to the Contact Record. If desired, open the Customer Code and relate it to the Contact using the Lookup field (spy glass).
Page 26 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
4.2.2.2
Non Open-Ended Recurring child Donations:
1. Locate the Contact record for the donor in order to create a new parent Recurring Donation record. If created via the related list on the Contact record, the new record will automatically be related to the Contact. Also, data from the new parent Recurring Donation Record will be imported into the iATS Virtual Terminal, and be used to create the new child Donations.
2. Name the record using our recommended format if desired: Donor Name – iATS MOP Recurring Payment – Date. For ex: Joe Smith – iATS CC Recurring Payment 5/11/2012 3. Complete the required fields as per the below suggestions:
Open Ended Status = None
Date Established = Date of first charge
Next Donation Date = Date of first Charge or leave blank
Last Donation Date = Date of Last Charge
Amount = Total Amount to be charged (copies to Total field upon Saving)
Installment Period = Schedule (iATS Schedule options are Monthly, Weekly, Quarterly, Annual)
Installments = Number of Donations within Schedule
4. Click Save. You should now have multiple Donations created:
Page 27 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
5. ** Important**: In order to schedule the recurring payments, an iATS Customer Code needs to be created and stored within the iATS servers. To create the Customer Code, click the iATS Button (Virtual Terminal).
Page 28 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
6. Most fields will be auto populated from the Recurring Donations record however the Credit Card (or ACH Bank Account details) will need to be added. 7. Click Create recurring Payments, and close the terminal. Refresh the page to view the new iATS Customer Code:
8. ** Important**: The iATS Customer Code will not automatically be related back to the Contact Record. If desired, open the Customer Code and relate it to the Contact using the Lookup field (spy glass).
4.2.3 Schedule Recurring Payments to utilize one Opportunity Record (Standard iATS Method) 1. Locate the Contact record for the donor in order to create a new Opportunity/Donation record. If created via the related list on the Contact record, the new record will automatically be related to the Contact.
1. During the Opportunity/Donation creation process, name the record using our recommended format if desired: Donor Name – iATS MOP Recurring Payment – Date. For ex: Joe Smith – iATS CC Recurring Payment 5/11/2012 2. From within the newly created Opportunity/Donation record, click the iATS Button to launch the Virtual Terminal. 3. Select the appropriate iATS Merchant Account using the drop down menu in Account Name. 4. Click the “Recurring Payments” button. 5. Select “Credit Card” or “Bank Withdrawal”. 6. Select the recurring schedule information in the Recurring Payments section:
Page 29 of 73
•
Recurring Amount
•
Begin Date (UK Direct Debit: Begin Date must be at least 13 days in the future)
•
End Date
•
Schedule Type
•
Schedule Date – For the “Weekly” schedule type, Sunday is the first (1) day of the week.
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Note: This option is not visible when scheduling Quarterly or Annual recurring transactions as the Begin Date acts as the Schedule Date.
7. Enter Credit Card or Bank Account details: For Credit Card Transactions, manually or via Card Reader enter: •
Card Type
•
Card Number
•
Expiry Date
For Bank Account Transactions, enter:
Page 30 of 73
•
Account Type
•
Bank Number (CDN Only)
•
Transit Number (CDN), Routing Number (US) or Sort Code (UK) iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
•
Bank Account Number
8. North American Users: Click the "Create Recurring Payments" button to schedule the recurring transaction and create the iATS Customer Code. Once clicked, the scheduled details are securely stored in the iATS servers, and an iATS Customer Code is created. 9. UK Users: The Direct Debit Bank Account details must first be successfully validated before the Recurring Payment schedule can be created. To validate the details, please click the Validate button as detailed in the below screenshot.
If successfully validated, the donor’s bank name and details will be displayed within the Virtual Terminal in addition to the Direct Debit Reference number. These details should be confirmed with the donor, then click the “Create Recurring Payments” button. Once done, the Customer Code is created, the Reference number stored on the iATS Payments servers and the Customer Code record, and the Direct Debit instruction information will be passed to our Direct Debit acquirer Smart Debit. 10. Refresh the Opportunity/Donation record to view the iATS Customer Code details. To ensure all subsequent iATS Transactions are also related to the Contact record, click on the iATS Customer Code and relate it to the Contact record using the Contact Field look up option (edit pencil). Note that there is no iATS Transaction related to the Opportunity/Donation or Contact immediately displayed for Recurring schedules. A new iATS Transaction will post the day after the first recurring payment is processed via the scheduled Download Journal. Future transactions will also post via the Download Journal. Important: Once created, the iATS Customer Code record in Salesforce should not be edited unless accessed via the iATS Button. Editing or deleting the iATS Customer Code record directly within Salesforce will not affect the record on the iATS Servers or cancel the schedule. For more information regarding editing the information within an iATS Customer Code, please see the next section of this Guide. Page 31 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
4.3 Cancel an iATS Customer Code Recurring Schedule or Edit Payment Details The Virtual Terminal, or iATS Button, should also be utilized to cancel the recurring schedule and/or make any modifications to the details that have been stored on the iATS Servers as an iATS Customer Code. Important: Once created, the iATS Customer Code record in Salesforce should not be edited unless accessed via the iATS Button. Editing or deleting the iATS Customer Code record directly within Salesforce will not affect the record on the iATS Servers or cancel the schedule. The following details can only be edited via the iATS Button located on the Contact, Opportunity/Donation or Account Record: •
Recurring Status (“Active” or “Off”)
Note: UK Clients with Direct Debit abilities can “Cancel” a Direct Debit instruction by selecting “Off”. This instruction cannot be turned back to “Active” as per BACS regulations and a new Instruction and reference number will need to be created. •
Begin Date
•
End Date
•
Amount
•
Schedule Type
•
Schedule Date
•
Credit Card Number or Bank Account Number
•
Expiry Date
•
Name, Address, Company Name and Email Address of the donor that is stored on the iATS Servers as an iATS Customer Code.
1. Click the iATS Button to launch the Virtual Terminal. 2. Select the appropriate iATS Merchant Account (processing sub-code) and then the iATS Customer Code from the Customer Code drop-down list on the top right hand side. Note: The recurring iATS Customer Code will indicate the related Opportunity/Donation record for reference. Page 32 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
3. Click the “Recurring Payments” button. 4. At this stage, you can edit all fields with the exception of the Payment details. 5. Once all amendments have been made, click “Update Recurring Payments” in order to save the details to the iATS Customer Code, and save the new information on the iATS servers. 6. To edit the Payment details, click the “Edit Saved Payment Information” link. Please note this will open all payment fields. Note: UK Direct Debit users may update the Bank Account details using the Virtual Terminal, but these details are not sent to Smart Debit and will not affect future payments. Please have the Donor contact their bank to properly update their Bank Account details. 7. Once finished, click “Update Recurring Payments” in order to save the details to the iATS Customer Code, and save the new information on the iATS servers. 8. Refresh the Opportunity/Donation record to view the changes, or click directly on the iATS Customer Code.
Page 33 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
5 How To: Integrate the iATS Virtual Terminal within “Auctions for Salesforce” Brickwork (Version 2.6 and higher) can be integrated with the Auctions for Salesforce Check In and Check Out tabs for secure registration and payment processing. The below Check In and Check Out URL’s should be added to the Auctions Settings section of Auctions for Salesforce. •
Important: The Salesforce server your organization uses must be added to each URL to ensure proper check in and checkout functionality (see step 6 below).
5.1 Add Brickwork Check In & Check Out Virtual Terminals to Auctions To register attendees and store their credit card details using Brickwork, please follow the below steps which detail how to add the URL to the Salesforce Auction Settings. Please note that the URL’s for Check In (called “Credit Card Validate URL Formula”) and Check Out (called “Credit Card Charge URL Formula”) vary slightly and are not interchangeable:
Check In Terminal
Check Out Terminal
1. In Set-up (click on your username and choose Set-up), locate the “App Setup” section. Within “Develop”, select “Custom Settings”. 2. Locate “Auctions Settings” and click the “Manage” button. 3. Click on the settings option for your Auction, and click “Edit”. 4. Enter the following Check Out URL into the “Credit Card Charge URL Formula” box: https://iatspayment.na2.visual.force.com/apex/IATSPaymentsContact?id={0}&objectType=contact&aid={1}&amt={2}&gwa=c Note: Please ensure there are no extra spaces included at the end of the URL if pasting the above.
5. Enter the following Check In URL into the “Credit Card Validate URL Formula” box: https://iatspayment.na2.visual.force.com/apex/IATSPaymentsContact?id={0}&objectType=contact&aid={1}&gwa=s Note: Please ensure there are no extra spaces included at the end of the URL if pasting the above.
Page 34 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
6. Replace the highlighted and strikethrough Salesforce server code example in the above URL’s with the server code used by your organization. This can be found within the URL address bar when you are logged into your organizations Salesforce instance.
For further instructions regarding using the Auctions for Salesforce application, please refer to the Auctions for Salesforce Installation & Configuration Guide supported by DJH Consulting.
Page 35 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
6 How To: Integrate Aura online processing with Campaign ID’s and/or Record Types Online Aura processing can be integrated with Salesforce Campaigns, and configured to utilize Contact, Opportunity, and Recurring Donation (NPSP) Record types within Salesforce. When a Transaction is processed via an Aura webpage that is connected to Salesforce, iATS will pass certain variables and ID’s to Salesforce that allow the Opportunity/Donation record to be linked to a specific Campaign, and for any new Contacts, Opportunities, or Recurring Donations to be assigned a specific Record Type when they are created by Brickwork. This can be done via three different methods: Method 1. Add the variable(s) and your Campaign ID and/or Record Type ID’s onto the URL of the “Donate” button or link which hosts the embedded Aura form. This method will ensure all iATS Transaction data processed via this Aura webpage will be assigned the specified values. Method 2. Add the variable(s) and your Campaign ID and/or Record Type ID’s onto the end of the Salesforce Site within Aura Setup while creating the Aura event on the iATS website. If using Aura Connect for Facebook, this is the option which should be used. This method will ensure all iATS Transaction data processed via this specific Aura webpage will be assigned the specified values. Note: Adding the ID’s via this method will not transmit ID information to the iATS Download Journal Report, which is necessary for iATS to relate records via the Download Journal in the future if needed. Method 3. Add the variable(s) and your Campaign ID and/or Record Type ID’s onto the end of a URL, such as included within an email blast, or online Ad. This method allows for the flexibility of receiving different ID information from donors via one Aura webpage. For this method to function properly, please ensure there are no other ID’s added as per method 1 and 2 above. The Variables that will be used in the following instructions:
Page 36 of 73
•
Opportunity Primary Campaign ID variable: caid
•
Contact Record Type ID variable: cortid
•
Opportunity Record Type ID variable: oprtid
•
Recurring Donation (NPSP) Record Type ID Variable: rertid
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
6.1.1 Method 1 - Add Campaign ID and/or Record Type ID’s onto the web page Button/link URL (Recommended)
1. Create an Aura donation page by following the instructions within the Aura User Guide. If an Aura donation page is already hosted on your website, skip this step. 2. Obtain the Salesforce Campaign Record ID by going to the Campaign within Salesforce and copying the ID number listed after the Salesforce web address from the URL. Example: https://na6.salesforce.com/701A0000000dzhU 3. Add the Campaign ID and variable onto the end of the URL for the “Donate” button or link to the website that hosts the Aura payment box by modifying the coding of the button or link. This step may need to be completed by a Web Developer. 4. As per the example below, the first character after the URL link should be a question mark, followed by the Campaign ID variable caid, then an equal’s sign and the ID itself. Example: www.genericdonationwebpage.com/Donate?caid=701A0000000dzhU 5. If desired, a Contact and/or Opportunity Record Type can also be added by using the Record Type ID variables cortid, oprtid, or rertid described above. When adding a second variable ID into the URL link, they must be separated by an ampersand (&). Example: www.genericdonationwebpage.com/Donate?caid=701A0000000dzhU&cortid=012A000000 0zJ6O&oprtid=012A0000000zJ6Y 6. Processing a test transaction through the Aura page is recommended to ensure the correct Campaign and/or Record types are functioning as expected. Note: If an incorrect ID (does not exist for example) is used, the Opportunity and Contact records will not be related to any Campaign and will display the Salesforce defaulted Record type instead. Page 37 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
6.1.2 Method 2 - Add Campaign ID and/or Record Type ID’s onto the Salesforce Site 1. Create an Aura donation page by following the instructions within the Aura User Guide. If an Aura donation page is already hosted on your website, skip this step. 2. Obtain the Salesforce Campaign Record ID by going to the Campaign within Salesforce and copying the ID number listed after the Salesforce web address from the URL. Example: https://na6.salesforce.com/701A0000000dzhU 3. Add the Campaign ID and variable onto the end of the Salesforce Site URL, in the Post Back URL Field of Aura Set-up.
Example:
4. As per the example below, the first character after the URL link should be a question mark, followed by the Campaign ID variable caid, then an equals sign and the ID itself.
Example: 5. If desired, a Contact and/or Opportunity Record Type can also be added by using the Record Type ID variables cortid, oprtid, or rertid described above. When adding a second variable ID into the Salesforce Site URL, they must be separated by an ampersand (&). Page 38 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Example: ?caid=701A0000000dzhU&cortid=012A0000000zJ6O&oprtid=012A0000000zJ6Y 6. Processing a test transaction through the Aura page is recommended to ensure the correct Campaign and/or Record types are functioning as expected. Note: If an incorrect ID (does not exist for example) is used, the Opportunity and Contact records will not be related to any Campaign and will display the Salesforce defaulted Record type instead.
6.1.3 Method 3 - Add Campaign ID and/or Record Type ID’s on URL hyperlink 1. Create an Aura donation page by following the instructions within the Aura User Guide. If an Aura donation page is already hosted on your website, skip this step. 2. Obtain the Salesforce Campaign Record ID by going to the Campaign within Salesforce and copying the ID number listed after the Salesforce web address from the URL. Example: https://na6.salesforce.com/701A0000000dzhU 3. Copy and paste the donation page URL into the body of an email (for example). 4. Add the Campaign ID and variable onto the end of the pasted URL hyperlink.
5. As per the example below, the first character after the URL link should be a question mark, followed by the Campaign ID variable caid, then an equals sign and the ID itself. Example: www.genericdonationwebpage.com/Donate?caid=701A0000000dzhU Page 39 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
6. If desired, a Contact and/or Opportunity Record Type can also be added by using the Record Type ID variables cortid, oprtid, or rertid described above. When adding a second variable ID into the URL hyperlink, they must be separated by an ampersand (&). Example: www.genericdonationwebpage.com/Donate?caid=701A0000000dzhU&cortid=012A000000 0zJ6O&oprtid=012A0000000zJ6Y 7. When the URL is clicked, the donor will be directed to the Aura hosted webpage, and the ID’s entered will be displayed in the URL of the site, and pushed to iATS/Salesforce with the transaction details.
8. Processing a test transaction through the URL hyperlink is recommended to ensure the correct Campaign and/or Record types are functioning as expected. Note: If an incorrect ID (does not exist for example) is used, the Opportunity and Contact records will not be related to any Campaign and will display the Salesforce defaulted Record type instead.
Page 40 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
7 Workflows for Aura Payment Processing via a Webpage Aura and AuraLink refer to the secure online donation web form which integrates seamlessly into an existing website and Brickwork using a Salesforce Site. These payment forms allow a donor to submit both Single and Recurring transactions directly to secure iATS servers and Salesforce. •
For more information regarding setting up an Aura webpage, please refer to the Aura Installation Guide, or the AuraLink documentation which is available by contacting iATS Customer Care.
•
Custom Contact Match settings can be utilized for Aura webpage processing within the iATS Settings tab. Instructions on how to utilize this section can be found in the Brickwork Installation Guide.
7.1 Aura / Brickwork Integration Workflow – One-Time Transaction •
An Opportunity/Donation record will be created with default format of Donor Name – iATS MOP Single Payment – Date. For example: “Joe Smith – iATS CC Single Payment 5/22/2012”
1. The donor enters the donation details and payment information directly on the secure Aura page which has been embedded within the existing website. 2. The Transaction data is pushed to iATS and sent to the bank for authorization. 3. The Donor instantly receives an Approval or Rejection response message for Credit Card transactions. ACH Transactions are processed same day, but not immediately. All ACH iATS Transactions will post via the scheduled Download Journal the day after the payment is processed. 4. Via the “Post Back URL” feature of Aura, the transaction details are pushed to Salesforce via Brickwork and cross referenced with existing contacts and the Brickwork iATS Settings tab for default preferences. 5. Using the Contact Match options within iATS Settings, the new iATS Transaction is either added to an existing Contact Record and a new Opportunity is created, or a new Contact and new Opportunity record is created.
Page 41 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Aura One-time Transaction Process flow: Aura One-Time (Single) Transaction
Yes
Aura Donation Form Single Transaction Option Selected
New iATS Transaction created and related to existing Contact. Opportunity (Donation) with new Payment (if enabled via iATS Settings) also created.
Is there a Contact
No
New Contact created and related to new iATS Transaction. Opportunity (Donation) with new Payment (if enabled via iATS Settings) also created.
7.2 Aura / Brickwork Integration Workflow – Recurring Transaction •
An Opportunity/Donation or Recurring Donation will be created (depending on which Recurring Payments model has been selected) with default format of Donor Name – iATS MOP Recurring Payment – Date, within the Brickwork iATS Settings tab. For example: “Joe Smith – iATS CC Recurring Payment 5/22/2013”
1. The donor enters the donation details, including the recurring schedule information, and enters the payment information directly on the secure Aura page which has been embedded within the existing website. 2. The transaction data and recurring schedule information is pushed to iATS and stored within our secure servers. An iATS Customer Code is created to represent the payment and schedule details. 3. Via the “Post Back URL” feature of Aura, the donor’s details are pushed to Salesforce and cross referenced with existing contacts and the Brickwork iATS Settings tab for default preferences. 4. Using the Contact Match options within iATS Settings, the iATS Customer Code record is either added to an existing Contact Record and a new recurring Opportunity is created, or a new Contact and a new recurring Opportunity is created, and the iATS Customer code is related. Note that there are no iATS Transaction records related to the Opportunity/Donation or Contact. A new iATS Transaction will post via the scheduled Download Journal the day after the first recurring payment is processed. Subsequent transactions will also post via the Download Journal. Page 42 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
5. On the Schedule Date, the payment details are charged. An Approved or Rejected transaction is recorded on the iATS system, and added to the Download Journal overnight. 6. Via the scheduled automatic Nightly Download Journal, the transaction details are pushed to Salesforce. Using the unique iATS Transaction ID, iATS Customer Code and Contact Match settings within iATS Settings, the new iATS Transaction is either added to an existing Contact and Opportunity Record, or a new Contact and Opportunity Record is created and the iATS Customer Code is recorded. Aura Recurring Payment Schedule Process flow:
Aura Recurring Payment Schedule
Yes
Aura Donation
Records Created: - New Opportunity (Donation) - Payments (if enabled) - Recurring Donation (if enabled) - Multiple Donations (if enabled) - iATS Customer Code
Transaction processed on scheduled date
Above new records related to existing Contact.
Form Recurring Option Selected
Contact
No
Page 43 of 73
Records Created: - New Contact - Opportunity (Donation) (unless Recurring Donations object enabled) - Payments (if enabled) - Recurring Donation (if enabled) - Multiple Donations (if enabled) - iATS Customer Code
imported via Nightly Download
Is there a match?
iATS Transaction
Transaction processed on scheduled date
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
7.3 Aura to Salesforce Post Error – Email Notification During the post from iATS to Salesforce, rare connection issues (for example if Salesforce is down for maintenance) could cause the Aura post to fail resulting in the Aura transaction data to not appear in Salesforce. In these cases, you will receive an email containing the cause of the error, the details the donor entered on the Aura form, and a hyperlink which can be used to manually “re-post” the data from iATS to Salesforce. Subject line: Error received during import from iATS Aura online form Body of Email: There was an error importing new donation details from your Aura online donation page to Salesforce. Please review the error message detail posted below and address accordingly. Once the reason for the error message has been corrected, the donation details can be imported via the manual import tool on the iATS Settings tab in Salesforce if needed. If you have any questions about the error or require further assistance, please contact iATS Customer Care at
[email protected] or 1-888-955-5455, option 1. Organization Name: **Name of client** Organization ID: **Salesforce Org ID of client** Error Type: Aura online donation import error Error Message: **Error message varies per scenario** Error Line Number: **Error number varies per scenario** ___ **All details the donor entered into Aura donation form** ___ Brickwork Version: **varies per client** Full URL: **URL hyperlink will be displayed**
Page 44 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
8 How To: Refund an iATS Transaction Full Credit Card Refunds can be processed via the iATS Transaction record however at this time partial Credit Card refunds or ACH/EFT Refunds can only be processed via the iATS Portal www.iatspayments.com, or www.uk.iatspayments.com for our international clients.
1. Locate the record for the donor that contains the iATS Transaction related list. This will normally be the Contact or Opportunity record. 2. Locate the iATS Transactions related list, and click on the iATS Transaction ID of the transaction that needs to be refunded. 3. Click the “Refund” button.
4. In the newly opened dialogue box, confirm the amount to be refunded and click “Process refund” Close the dialogue box and refresh the donor’s record. The status of the iATS Transaction has been changed from “Approved” to “Refunded”.
Page 45 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9 Download Journal Import for iATS Transactions – Process flow The Download Journal enables Brickwork to retrieve an iATS Journal report containing all transaction data processed the prior day for Credit Card, and for the prior four consecutive days for North American ACH processing. NA ACH/EFT Return data and UK Direct Debit BACS reports are also imported to create iATS Return records. This tool ensures that all recurring transactions are recorded in Brickwork the day after they have been processed, and any missing Single iATS Transactions are imported into Salesforce. The Download Journal tool utilizes the iATS Client Codes that are saved as iATS Merchant Accounts to access iATS’ servers to obtain processing data. For more information on how the Download Journal Import tool works, please see the workflow included on the next page. Important Details: •
Only System Administrators are permitted to schedule the Download Journal. If the Salesforce User who creates the Apex Class is set to Inactive or deleted from Salesforce, the nightly Download Journal will no longer run, and will need to be rebuilt by the new Admin.
•
The download journal imports in batches of 10,000 iATS Transactions at a time, up to 100,000 maximum. If an error message is received during the import process the current batch and all future batches are aborted, however prior successful batches are not.
•
Credit Card transactions are imported daily at each scheduled import time, and include yesterday’s transactions. ACH North American transactions are imported daily at each scheduled import time, and include all transactions from the prior four days.
Visual Workflows of the download import process for iATS Transactions and iATS Returns can be found on the following sections.
Page 46 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9.1 Transaction Import Workflow
Page 47 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9.2 (New) NA ACH/EFT Returns Workflow
Page 48 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9.3 (New) UK Direct Debit BACS Returns Workflow
Page 49 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9.4 Download Journal Notification Emails: 1. Successful Manual or Auto Download Journal: Subject line: Brickwork iATS Payments Download Journal Import - Successful Body of Email: Dear **Name of client**, The iATS Transaction and iATS Return batch download to Salesforce is now complete for iATS Account(s): **client sub-code(s) **. Please note the following details: The Download Journal import process was successful for date period 01/03/2013 - 26/03/2013. Number Number Number Number Number
of of of of of
new new new new new
iATS Transaction Records created (Approval and Rejected): 80 iATS Customer Code Records created: 78 Contact Records created: 18 Opportunity (Donation) Records created: 78 iATS Return Records created: 0
Please note that if the above details indicate ‘0’ records were inserted, it means there was no new iATS Transaction or Return data to import into Salesforce. If you receive an iATS Returns error after this message, please address the details and try the import again. To ensure all ACH iATS Transactions are imported after weekends and Holidays, the scheduled Nightly Download Journal will import the prior four days of North American ACH processing. If you have any questions, please contact iATS Customer Care for additional assistance at
[email protected] or 1-888-955-5455, option 1. Thank you, iATS Payments
2. Failed Manual or Auto Download Journal for iATS Transactions ONLY: Subject line: Brickwork iATS Payments Download Journal Import – Error Received for Transactions Body of Email: Dear **Name of client**, The iATS Transactions batch download to Salesforce for date period 10/22/2014 - 10/22/2014 was unable to complete for iATS Account(s): **client sub-code(s) **, as the following error message has been received: **Error message varies per scenario** Please address the error details, and manually reattempt the batch download via the iATS Settings tab in Salesforce. If your Organization processes ACH or Direct Debit transactions with Brickwork, iATS Returns are imported only after a successful import of iATS Transactions has been completed. Once the iATS Transactions are imported successfully, iATS Returns will be attempted and if unsuccessful an error message will be sent.
Page 50 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
If you have any questions about the error or require further assistance, please contact iATS Customer Care at
[email protected] or 1-888-955-5455, option 1. Thank you, iATS Payments
3. Failed Manual or Auto Download Journal for iATS Returns ONLY: Subject line: Brickwork iATS Payments Download Journal Import – Error Received for Returns Body of Email: Dear **Name of client**, The iATS Returns batch download to Salesforce for date period 10/22/2014 - 10/22/2014 was unable to complete for iATS Account(s): **client sub-code(s) **, as the following error message has been received: **Error message varies per scenario** Please address the error details, and manually reattempt the batch download via the iATS Settings tab in Salesforce. If you have any questions about the error or require further assistance, please contact iATS Customer Care at
[email protected] or 1-888-955-5455, option 1. Thank you, iATS Payments
Logic of email functionality: • •
•
If the Transaction and Return imports are successful, you will get a Success template indicating the numbers of transactions, otpy's, contacts, and returns that were imported. If the Transaction import is successful but the Return isn't, you should get one success template (# of Returns imported would equal 0), and one Returns Error template explaining why the Returns import failed. You can then re-run the download journal and import the Returns. At that point you would receive the success import template indicating 0 transactions and the # of returns imported. If the Transaction import fails, the Return import isn't attempted. You should get the Transaction Error message (no mention of returns) so you can fix the errors. Then when you run the manual import you will get the success template showing them the number of transactions and returns that were imported. Should the Returns import actually fail, you should get the returns error message (no mention of transactions) allowing you to fix the reason for the returns fail. When you run the manual import you should get the success template indicating the number of returns imported.
To ensure your organization is receiving these email notifications, please add your email address to the “Notification Email” field and check the “Nightly Batch Download Notification” checkbox within Additional Settings on the iATS Settings tab.
Page 51 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9.5 Schedule the Automatic Nightly Download Journal The Download Journal enables Brickwork to retrieve an iATS Journal report containing all transaction data processed the prior day for Credit Card, and for the prior four consecutive days for North American ACH processing. This tool ensures that all recurring transactions are recorded in Brickwork the day after they have been processed, and any missing Single iATS Transactions are imported into Salesforce. The Download Journal tool utilizes the iATS Client Codes that are saved as iATS Merchant Accounts to access iATS’ servers to obtain processing data. For more information on how the Download Journal Import tool works, please see the workflow included on the prior pages. Important Details: •
Only System Administrators are permitted to schedule the Download Journal. If the Salesforce User who creates the Apex Class is set to Inactive or deleted from Salesforce, the nightly Download Journal will no longer run, and will need to be rebuilt by the new Admin.
•
The download journal imports in batches of 200 iATS Transactions at a time, up to 10,000 maximum. If an error message is received during the import process the current batch and all future batches are aborted, however prior successful batches are not.
•
Credit Card transactions are imported daily at each scheduled import time, and include yesterday’s transactions. ACH North American transactions are imported daily at each scheduled import time, and include all transactions from the prior four days.
1. In Setup (click on your username and choose Setup or the setup button if using the Enhanced menu), under the “App Setup” or “Build” section select “Develop” then “Apex Classes”, and click the “Schedule Apex” button. 2. Name the job iATS Nightly Download Journal. 3. Click the “Apex Class” look up button and select IATSPayments_journal_log. 4. Set the “Frequency” as Weekly. 5. Check off each day of the week. 6. The Start Date will default to Page 52 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
today, but be sure to select an End Date in the future. We recommend at least 5 years. There is no restriction on future End Date. 7. Set the “Preferred Start Time”. Please select a time between 7am and 7pm (Your own time zone) Note: Internal iATS updates and maintenance may occur between 11:00pm and 4:00am nightly. Setting the “Preferred Start Time” during this window is not recommended. Salesforce/Brickwork Multicurrency users are recommended to schedule the start time between 1112pm GMT to ensure the prior day’s report has been created in both the UK and North American time zones. 8. Click “Save” to register the new Apex Schedule. 9. If desired, you can receive daily notifications regarding the import by checking the Download Journal Notification option within the iATS Settings tab.
9.6 Reviewing or Cancelling the Nightly Download Journal 1. Within Set-up (click on your username and choose Set-up) locate the “Administration Setup”, then “Monitoring”, then “Schedules Jobs” section. If using the Enhanced setup menu option, click the Setup button, then locate the “Monitoring” section and select “Jobs”. Click “Scheduled Jobs”.
2. Locate the job “iATS Nightly Download Journal”. Note: You may have named the job differently. 3. Click on “Manage” to view the job details, or click “Del” to delete the job.
Page 53 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
9.7 Manual Download Journal Import The Manual Download Journal enables Brickwork to retrieve an iATS Journal report for a span of time, containing all transactions, ACH/EFT and UK Direct Debit returns processed on your iATS Merchant Accounts that don’t contain the “Do Not Include in Download Journal” checkbox option. 1. Click on the “iATS Settings” tab. 2. Locate the “Batch Download Transactions” section at the bottom. 3. Choose a Begin Date and End Date. Note: •
The Download Journal can be run for a maximum of 31 days at a time, for transactions processed in the past two years.
•
UK DD Returns are only manually imported if tool is run one day at a time (begin date field).
4. Click Continue. A message will appear at the top of the page advising that a notification email will be sent once the Download is complete.
Page 54 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
10 (New) iATS Returns for NA ACH and UK Direct Debit Launched in September 2015, Brickwork now includes a new custom object called iATS Returns. These records are automatically imported from iATS Payments to Salesforce via the Brickwork Nightly Download Journal process, providing added visibility into returned NA ACH/EFT and UK Direct Debit iATS Transactions. Where you previously needed to review the iATS Portal or the Smart Debit UK website to get information about returned ACH transactions, now your data is where you need it…within Salesforce! •
What are Returns? Returns for bank withdrawal transactions are like credit card chargebacks. They represent a donor or their banks request for money to be returned to the account holder’s bank account.
Returns are issued after an ACH/Direct Debit transaction is marked as approved (successful), usually within a few days, and will often contain a reason such as “Insufficient Funds” where it was determined the bank account didn’t have enough money for the debit, or “Account Closed” where the bank account you are trying to debit no longer exists or has been closed by the bank. There are a number of reasons for a return, and the details will be posted within the iATS Return detail page.
•
How do I start importing iATS Returns into Salesforce? If you have your ACH iATS Client Code saved as an iATS Merchant Account and the Nightly Download Journal APEX job scheduled you don’t have to do a thing! As of version 4.5, Brickwork will automatically import your ACH Transactions
Page 55 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
during the nightly import (or via the manual import option within iATS Settings) to create new iATS Return records. °
For NA returns, we use a new field called “Journal ID” which we are now posting to all iATS Transactions and iATS Returns. The return looks for the Journal ID on the iATS Transaction to find a match.
°
For UK Direct Debit returns, we look for the Reference Number located on the iATS Transaction and iATS Customer Code records. We also back up the match by comparing the amount and date of the original transaction where applicable.
•
I’m an existing Brickwork client. How do I ensure our users can see the new iATS Returns? If you are an existing client and recently upgraded to Version 4.5, we recommend you follow the update steps located in our “Update to Version 4.5” document as page layout modifications are recommended if you currently accept ACH or Direct Debit with iATS Payments. For help please contact our Customer Care Department at
[email protected], or reach out to your Salesforce Administrator.
•
What do I do with iATS Returns? You can action a returned ACH transaction in the same way you are now, usually this means contacting the donor or marking their records to indicate you didn’t actually receive their donation. Brickwork will automatically update the status of a related iATS Transaction from “Approved” to “Return” to help distinguish returns, but won’t update any other related records such as Opportunity, Payments, or Recurring Donations at this time.
•
Can I report on iATS Returns? You bet! We’ve designed three new reports which you can find within the iATS Brickwork Reports section: °
All Returns - Details all returned ACH/Direct Debit iATS Transactions
°
Returns with Customer Codes - Details ACH/Direct Debit iATS Returns when they are linked to a recurring iATS Customer Code
°
Returns with Transactions - Details ACH/Direct Debit iATS Returns when they are linked to an iATS Transaction
10.1 Special notes for UK Direct Debit clients re: BACS Reports Brickwork now imports all four BACS report types from Smart Debit: ADDACS (Automated Direct Debit Amendment and Cancellation Service) 1. Issued if the donor contacts their bank to cancel the donation or if their account, name or address details have changed. Notification time varies as it is dependent upon a cancellation request. May or may not be linked to an iATS Transaction, depending on the reason. AUDDIS (Automated Direct Debit Instruction Service)
Page 56 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
2. Issued if there is a problem setting up the debit instructions at the donors bank. Notification time varies as it is dependent upon a cancellation request. Always linked to an iATS Customer Code but never an iATS Transaction. ARUDD (Automated Return of Unpaid Direct Debit) 3. Generally Issued due to insufficient funds or if a donation has been cancelled. Notification is issued 2-4 days after the Charge or Collection date. Always linked to an iATS Transaction. DDICA (Direct Debit Indemnity Claim) 4. Issued by the Payer or Bank which reverses the original transaction. Always linked to an iATS Transaction. Each UK DD iATS Return detail page includes a special section called “UK BACS Return Information” dedicated to posting details if/when they are included on the BACS reports (1), the type of BACS Report that was issued to create the new record (2), and a link for more information on BACS Returns including important Action Items for UK users (3).
Page 57 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
10.2 iATS Return Workflow for UK BACS Clients 10.2.1
Workflow
The end to end process to trigger the creation of a Return in Salesforce via Brickwork is as follows: 1. Your donor provides you the necessary data to start a new DDI. This can be done via your staff using the Brickwork Virtual Terminal on the Recurring Donation or Opportunity record, or via your online Aura website if enabled with iATS. 2. The new Reference number is sent to Smart Debit/BACS to start the 12 day registration process. 3. If the new Reference number isn’t registered properly: a.
BACS/Smart Debit will generate a new BACS report called an AUDDIS.
b.
Brickwork performs a daily scan for new reports and will pick up the AUDDIS report the following day.
c.
Based on the data in the AUDDIS report, a new iATS Return record will be created to house the data. It will be related to the iATS Customer Code record that contains the Reference Number for the donor.
4. If the new Reference number is registered properly iATS will attempt a transaction against the bank data on the pre-scheduled date. 5. Brickwork performs a daily scan for all new iATS Transactions and will import them into Salesforce via Brickwork the following day with the Status of “Approved”. 6. Based on the data in the transaction, a new iATS Transaction record is created to house the data. It will be related to the iATS Customer Code that contains the reference number, and the Donation or Payment record. 7. Should that iATS Transaction ultimately be rejected by BACS or the donors bank (say they don’t have enough money in the bank account), BACS/Smart Debit will create a new BACS reports called an ARUDD. a.
Brickwork performs a daily scan for new reports and will pick up the ARUDD report the following day.
b.
Based on the data in the ARUDD report, a new iATS Return record will be created to house the data. It will be related to the iATS Transaction record that contains the Reference Number, and has the correct charge date/Amount listed in the ARUDD report.
c.
The Status field of the related iATS Transaction will be changed to “Return”.
8. If the iATS Transaction was approved by BACS and the donor’s bank, they could decide to change the values of the DDI at some later point. For example, should the donor choose to cancel their gift permanently, they could call their bank to stop the debits. a.
BACS/Smart Debit will generate a new BACS report called an ADDACS. This report will contain a reason code/description to cancel the DDI.
b.
Brickwork performs a daily scan for new reports and will pick up the ADDACS report the following day.
Page 58 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
c.
Based on the data in the ADDACS report, a new iATS Return record will be created to house the data. It will be related to the iATS Customer Code and/or the iATS Transaction, whichever is referenced in the report.
d.
If related to an iATS Transaction, the Status field will be changed to “Return” as the donor would have received their money back.
e.
Your staff would then manually cancel the iATS Customer Code by opening the iATS Button on the Recurring Donation or Opportunity record, and changing to Active Status to “OFF”. This sends a message to Smart Debit and BACS to cancel the Reference Number permanently.
9. This would be the same process for the DDICA type of BACS report which is only used when the donor claims they have been debited fraudulently.
10.2.2
Page 59 of 73
Visual Workflow
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
10.3 iATS Return Workflow for NA ACH/EFT Clients 10.3.1
Workflow
The end to end process to trigger the creation of a Return in Salesforce via Brickwork is as follows: 1. Your donor provides you the necessary data to start a new recurring ACH debit, or a one-time donation. This can be done via your staff using the Brickwork Virtual Terminal on the Recurring Donation or Opportunity record, or via your online Aura website if enabled with iATS. 2. The new Reference number is sent to Smart Debit/BACS to start the 12 day registration process. 3. Brickwork performs a daily scan for all new iATS Transactions and will import them into Salesforce via Brickwork the following day with the Status of “Approved”. Each transaction will contain a unique ID called a “Journal ID”. 4. Based on the data in the transaction, a new iATS Transaction record is created to house the data. It will be related to the iATS Customer Coder, and the Donation or Payment record. 5. Should that iATS Transaction ultimately be rejected by the donor or their bank (say they don’t have enough money in the bank account), iATS will create a new return transaction on our server. a.
Brickwork performs a daily scan for new returns and will pick it up from the ACH Returns report the following day.
b.
Based on the data in the return, a new iATS Return record will be created to house the data. It will be related to the iATS Transaction record contains the matching “Journal ID”.
c.
Page 60 of 73
The Status field of the related iATS Transaction will be changed to “Return”.
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
10.3.2
Page 61 of 73
Visual Workflow
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
11 Administrative Tasks The following sections describe common Admin tasks of Brickwork and Salesforce.
11.1 Confirm your Current Brickwork Version Number 1. In Set-up (click on your username and choose Set-up), locate the “App Setup” or “Build” section. Within “Deploy”, select “Installed Packages”.
Locate “iATS Payments” from the Package list. The Brickwork version number will appear under the Version Number column.
11.2 Grant iATS Personnel Temporary Access to Salesforce For troubleshooting purposes, you may be asked to grant iATS staff access to your Salesforce environment. •
This access is temporary, and can be removed by your organization at any time.
•
Any changes iATS staff may make while logged in are recorded in an audit trail.
1. If using the standard menu, click Setup, and locate the “Personal Set-up” menu. Click on “My Personal Information”, then “Grant Login Access”.
Page 62 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
If using the Enhanced Setup menu, click on Your Name, then “My Profile”. Click the “Personal” option and select “Grant Login Access”. 2. Locate First American Payment Systems Support (FAPS is iATS’ parent company). If the publisher is not listed on this page, it is for one of the following reasons: •
A system administrator disabled the ability for non-administrators to grant access.
•
The user does not have a license for the package.
•
The package is not Aloha enabled.
•
The package is licensed to the entire organization. Only administrators with the “Manage Users” permission enabled on their profile can grant access.
3. Select the length of time iATS will be able to access your environment in the “Access Duration” drop down menu and click “Save”.
Page 63 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
11.3 Manually Re-schedule the Payments Apex Class The Payments Apex class is automatically created and scheduled when the Brickwork Payments add on extension is downloaded via the Salesforce App Exchange. If the user who initially installed the extension leaves the organization, or the Apex is deleted by accident, it can be re-created manually. 1. If using the standard setup menu, in Set-up (click on your username and choose Set-up), under the “App Setup” section select “Develop” then “Apex Classes”, and click the “Schedule Apex” button. If using the Enhanced setup menu opion, click Setup, then “Build”, then “Develop”, then “Apex Classess”.
2. Name the job iATSPayments Payment Schedule. 3. Click the “Apex Class” look up button and select IATSPayments_Payments_SCHED. 4. Set the “Frequency” as Weekly. 5. Check off each day of the week. 6. The Start Date will default to today, but be sure to select an End Date in the future. We recommend at least 5 years. There is no restriction on future End Date. 7. Set the “Preferred Start Time” between 3-5am. 8. Click “Save” to register the new Apex Schedule.
Page 64 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
11.4 Cumulative Roll-up Fields The Opportunity can be customized to include Brickworks roll-up fields:
• • •
Total Number of Approved Transactions Total Number of Rejected Transactions Total Amount of Approved Transactions
These fields will automatically update based on the number of iATS Transactions that are related to the Opportunity record. The fields are updated each time a new iATS Transaction is added, or edited. The fields will also be updated overnight via a scheduled APEX Class. If desired, the trigger which updates the fields in real-time can be disabled. This is recommended if the trigger is conflicting with another one, such as the roll-up fields within the NPSP. 1. To disable the trigger open the Setup menu, and go to Develop (Within App Setup or Build) -> Custom Settings, and click the Manage Button. 2. Click Edit on the page, and add a checkmark to the checkbox for Disable iATS Transaction Rollup Trigger. Click Save.
Page 65 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
12 Brickwork Reporting The following Brickwork reports have been added to the iATS Brickwork folder of the Reports Tab in Salesforce to help manage iATS Transactions, iATS Customer Codes, and donors:
For detailed information on each report, please refer to the chart below: Report Name
Report Contents
Accounts with Transactions
Transactions that have a related account. Grouped by Account.
ACH (bank withdrawal)
Details all ACH (Bank Withdrawal) iATS Transactions
Transactions All Customer Codes
Details all iATS Customer Codes.
All Transactions
Details all iATS Transactions
All Returns
Details all returned ACH/Direct Debit iATS Transactions
Approved Transactions
Details all approved iATS Transactions
Contacts with Transactions
Transactions that have a related contact. Grouped by Contact.
Credit Card Transactions
Details all Credit Card iATS Transactions
Customer Codes with Transactions
Transactions that have a related iATS Customer Code. Grouped by
Page 66 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Customer Code. Online Donation (Opportunities)
Details all Opportunities (Donations) that were created via an Aura online webpage. Includes related transaction records. Grouped by Opportunity/Donation.
Opportunities with Transactions
Transactions that have a related Opportunity/donation. Grouped by Opportunity/Donation.
Recurring Payment Customer Codes
Details all iATS Customer Codes that contain recurring payment information
Refunded Transactions
Details all refunded iATS Transactions
Rejected Transactions
Details all rejected iATS Transactions
Returns with Customer Codes
Details ACH/Direct Debit iATS Returns when they are linked to a recurring iATS Customer Code
Returns with Transactions
Details ACH/Direct Debit iATS Returns when they are linked to an iATS Transaction
13 FAQ’s 13.1 View Additional Details in Brickwork Custom Tabs Q: How can I see more information when I click on the iATS Transaction or iATS Customer Codes tab in Brickwork? A: Additional information can be added by editing the “All” View, or by creating a new View for these tabs in Salesforce.
13.2 View Additional Fields in iATS Related List’s Q: I’ve added the iATS Transactions and iATS Customer codes to my Contacts tab, however I’d like to add more information such as the Recurring Schedule, or Method of Payment. A: You can add or remove any fields from a Related List via Page Layouts in the Set-up Menu. If you are an Administrator, you can click on the Blue Arrow on the far right side when on the tab. When in Edit Layout, locate the iATS Related list, and click the Wrench icon to add or remove fields.
13.3 Subsequent Recurring Transactions Q: I have a Recurring Credit Card transaction that is processed on the 15th of each month. When will the iATS Transaction be posted to Brickwork? Page 67 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
A: Please ensure you have the Nightly Download Journal scheduled. Instructions can be found in the “Download Journal” section of this User Guide. When scheduled, the iATS Transaction will be retrieved from iATS the day after the charge. The iATS Transaction record will be posted on the 16th of each month.
13.4 Rejected Transactions Q: Will rejected transactions automatically be re-attempted? A: No, if a transaction is declined, it will not automatically be re-attempted. This includes both Credit Card and ACH/EFT transactions for either one-time or recurring schedules.
13.5 Opportunity/Donation Names Q: What Opportunity/Donation names are used when processing iATS Transactions? A: The following names are used when Aura/Brickwork automatically creates Opportunity records for iATS Transactions. For Credit Card: •
Single Transaction: DONOR NAME – iATS CC Single Payment DATE
•
Recurring Schedule: DONOR NAME – iATS CC Recurring Payment DATE
For ACH: •
Single Transaction: DONOR NAME – iATS ACH Single Payment DATE
•
Recurring Schedule: DONOR NAME – iATS ACH Recurring Payment DATE
13.6 Survey Fields Q: Where are the answers to my Aura Survey questions posted in Brickwork? A: Survey answers are posted in the Opportunity in fields iATS Item 1 though 6. If you cannot see these fields, they can be added via Page Layout. Click here for more information regarding editing a page layout.
13.7 Virtual Terminal (iATS Button) Visibility Issues Q: Some staff members cannot see the iATS Button or the Virtual Terminal window. A: The Virtual Terminal is a Visual Force page, and the user may not have been granted permission to view Visual Force pages. The following steps can be taken to grant this visibility permission: 1. Go to Setup | Administration | Manage Users | Profiles 2. Click on the profile label. 3. Scroll down to the “Enabled Visualforce Page Access” section for that Profile. Page 68 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
4. Click the "Edit" button at the top of that section. 5. Select all of the iATS items in the LEFT window labeled "Available Visualforce Pages". Then click the "Add" button to add them to the RIGHT window labeled "Enabled Visualforce Pages" window.
6. Click the "Save" button. OR 1. Login to salesforce.com 2. Click on Setup | App Setup | Develop | Pages 3. Click security next to the page 4. Add profiles. 5. Click Save.
13.8 Guest User Modifications Q: When Brickwork is installed, does it automatically create a “Guest User” Salesforce User? A: No, the “Guest User” is automatically created when the Salesforce Site is created. The Salesforce Site is used to connect Aura to Brickwork/Salesforce. If you would prefer that Aura transaction records are not listed under this user, they can be re-assigned using a Workflow Rule. •
To modify the access rights or other settings of the Guest User, Salesforce has posted this help item to Setting Data Access Permissions for Salesforce Objects.
Page 69 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
•
When created, the default Time Zone for the Guest User profile will be set as (GMT +00:00) Greenwich Mean Time (GMT). This may cause some iATS Transactions to be created within Salesforce with a different time stamp than what is posted within the iATS Journal Reports which is set to Pacific Time. To compensate for this issue: 1. In Set-up (click on your username and choose Set-up), under the “App Setup” section select “Develop” then “Sites”. 2. Click the on the Site Label for the Salesforce Site which was saved within your online Aura webpage.
3. Click the “Public Access Settings” button. 4. Click on the “View Users” button. 5. Click Edit beside the applicable Guest User for the Site which was saved within your online Aura webpage.
6. Within the Locale Settings section, modify the Time Zone to reflect your Salesforce default time zone, and click Save. The default time zone is usually the same as your organizations time zone. Page 70 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
Q: How do I modify the default Record Type for Aura transactions associated with the Salesforce Site Guest User? A: The Record type for a variety of objects can be set for the Guest User profile associated with the Salesforce Site. To access the settings, please: 1. Click on your name to access the Salesforce Setup menu. 2. Click Develop, then Sites. 3. Locate the site label for Brickwork/Aura site and click it. 4. Click the Public Access Settings button, and scroll down to the Record Type section. 5. Click Edit beside the Object to change the default Record Type for these objects (Opportunity, Contacts that are created by Brickwork, etc).
13.9 iATS Aura Setup tab issues 13.9.1
Internet Explorer:
Users with IE11 may report issues using the iATS Aura Setup tab. If that occurs, we recommend switching to the Chrome or Firefox browsers however the following IE workaround may help: 1. In IE, click the Tools
button, and then click Internet Options.
2. Click the Privacy tab, and then under Settings, click the Advanced button as shown below:
Page 71 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
3. Under Privacy Settings, follow the settings as shown below:
4. Page 72 of 73
Click “OK” to apply these settings. iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com
Brickwork User Guide Version 4.5
13.9.2
Chrome
Users with Chrome may report issues using the iATS Aura Setup tab. Sometimes it may block third party cookies which prevent Salesforce from seeing the Aura setup page on our portal. If that occurs, the following settings can be applied: 1. From Chrome settings, locate ‘Privacy’. 2. Click Content settings button. 3. Under Cookies, click ‘Manage exceptions’.
4. Click the ‘Hostname pattern’ field and enter the domain name www.iatspayments.com and www.uk.iatspayments.com if you use any currency outside of Canadian/USD. We recommend that you create exceptions for the entire domain. This can be done by inserting [*.] before the domain name. 5. Use the dropdown menu and select ‘Allow’ to choose the behavior for the site or domain. 6. Click Finished when done.
Page 73 of 73
iATS Payments Suite 600 1188 West Georgia St, Vancouver, BC V6E 4A2 Toll Free: 1-888-955-5455 | Fax: 604-682-1715 | email:
[email protected] www.iatspayments.com