hps 2.3.2 → 2.4.0

data/PRIVACY.txt

@@ -1,66 +1,66 @@
-Online Privacy & Cookie Policy Statement ("Privacy Policy")
-
-Last modified on June 21, 2012
-
-Heartland Payment Systems, Inc. (�Heartland,� �we,� �us,� �our�) recognizes the importance of maintaining effective privacy practices.  This Privacy & Cookie Policy explains the online data collection and use policies that apply to the websites, mobile applications and online services (collectively �Services�) that are owned or controlled by Heartland and are linked to this Policy page.
-Click below to jump to a particular topic:
-
-1.       Information Collection and Use
-2.       Sharing of Information
-3.       Children�s Privacy
-4.       Your Choices
-5.       Data Protection and Storage
-6.       Third-Party Websites and Services
-7.       Changes to Our Privacy Policy
-8.       Contact Us
-
-1.   Information Collection and Use
-
-We collect information from various sources to provide our Services to you, to analyze and improve our Services, and to communicate with you (e.g., to send you updates or notices about our organization, or emails about products or services that we believe may be of interest to you). 
-Information that you provide to us:  We collect information that you provide to us when you set up an account with us, use our Services, or communicate with us.  For example, if you register for an online account with us, then we may request your personal information (e.g., name, postal address, email address, DOB, telephone number, credit/debit card number, security code) or as applicable your business information, to complete the registration process, to process transactions, to send you information about our products, to send you promotional offers from third parties that we think may be of interest to you, or to otherwise provide our Services to you.  Similarly, if you request information from us through an online contact form (or if you email us), we collect the information you provide (e.g., name, telephone number, email address) so that we can respond to you.
- 
-Information collected from third parties:  We may collect information about you or your business from third parties in the course of providing our Services to you.  For example, we may obtain information from our merchant customersor we may collect information from a school or university about consumer/students to provide services to those consumer/student.  For some services,we may also collect information from third parties, such as credit reporting agencies or financial institutions, or other entities with information pertaining to the Services that we are providing to you. 
- 
-Information collected through technology:  When you visit our websites or mobile applications (or when you use any of our online services) we may collect certain information about your computer or device through technology such as cookies, web beacons, or other tracking/recording tools.  The information collected may include, but is not limited to, IP addresses, referring URLs, access times, browser types, device types, mobile device identifiers, or information about your interactions with our websites, applications or services.  (Note that a �cookie� is a text file placed on a computer�s hard drive or stored on a mobile device; a �web beacon,� also known as an Internet tag, pixel tag or clear GIF, is used to transmit information back to a web server.)  We may use the information described in this paragraph to, among other things, (i) operate our Services, including by remembering information so that you will not have to re-enter it during your visit or the next time you sign in to your account, (ii) identify and protect our customers, (iii) control unauthorized use or abuse of our Services, (iv) provide custom, personalized content and information, which could include advertising, (v) monitor aggregate traffic patterns on our websites and services, and (vi) analyze and improve our Services.  
-
-2.   Sharing of Information
-
-We do not sell or share your information with third parties outside Heartland and our group of companies (which include any parents, subsidiaries and affiliates), without your consent, except as described below and in this Policy: 
-We may share your information with our service providers and business partners (e.g., financial institutions or card brands that issue payment cards or are involved in transaction processing; entities that assist with fraud prevention or collections; merchants that sell gift cards managed through our websites or services; schools), who assist us in providing our Services.  We may also share information with our service providers and business partners to help us monitor usage and other analytics regarding our Services, and to help us improve these offerings.  When we share your information with our service providers and business partners, we only provide the information that these third parties reasonably need to perform their functions.
-We may aggregate, or strip information of personally identifying characteristics, and may share that aggregated or anonymized information with third parties.
-We may share or disclose your information if we determine, in our sole discretion, that we are required to do so under applicable law or regulatory requirements, or if we reasonably believe disclosure is necessary to prevent harm or financial loss, or in connection with preventing fraud or illegal activity, and/or to enforce our Terms of Use.
-We reserve the right to transfer any information we collect in the event we sell or transfer all or a portion of our business or assets (including any shares in the company) or any portion or combination of our products, services, businesses and/or assets.  Should such a transaction occur (whether a divestiture, merger, acquisition, bankruptcy, dissolution, reorganization, liquidation, or similar transaction or proceeding), we will use reasonable efforts to ensure that any transferred information is treated in a manner consistent with this Privacy Policy.
-3.   Children�s Privacy
-
-Heartland�s websites, mobile applications and services are intended for use strictly by adults.  Heartland does not knowingly solicit or collect personal information from children under the age of 13.  If Heartland obtains knowledge that it has collected personal information from a child under 13 in retrievable form in its files, Heartland will delete that information.
-
-4.   Your Choices
-
-Email Communications.  From time to time, we may send you emails regarding updates to our websites, mobile applications or products/services, notices about our organization, or information about products/services we offer (or promotional offers from third parties) that we think may be of interest to you.  If you wish to unsubscribe from such emails, simply click the �unsubscribe link� provided at the bottom of the email communication.  Note that you cannot unsubscribe from certain Services-related email communications (e.g., account verification, confirmations of transactions, technical or legal notices).
-
-Modifying Account Information.  If you have an online account with us, you may have the ability to modify certain information in your account (e.g., your contact information) through �profile,� �account,� �settings,� or �preferences� options provided on the website or service.  If you have any questions about modifying or updating any information in your account, please contact us at the email address, postal address, or telephone number provided below. 
-
-Cookie Controls.  You may be able to set your Internet browser or mobile device to block cookies or other tracking/recording tools, including cookies associated with our websites or Services, or to indicate when a cookie is being set by us. However, it is important to remember that many of our websites or Services may not function properly if your cookies are disabled.  For information and instructions about how to manage your cookies, refer to your Internet browser�s or mobile device�s technical information.  Further information on how to adjust your cookie preferences through your browser is available at the external, third-party informational website www.allaboutcookies.org.
- 
-5.   Data Protection and Storage
-
-Heartland maintains reasonable administrative, technical and physical safeguards to protect the confidentiality of information transmitted online, including but not limited to encryption, firewalls and SSL (Secure Sockets Layer). Heartland has implemented policies and practices pursuant to various security rules and regulations relating to the security and safeguarding of payment cardholder data, including the Payment Card Industry Data Security Standards (PCI-DSS).  Heartland is not liable for loss of passwords due to user negligence.  If you believe your password has been lost or compromised, we recommend that you immediately change your password.
-
-We may store and process information in the United States or any other country in which Heartland or its parents, subsidiaries, affiliates or service providers maintain facilities. Heartland may transfer information that we collect about you, including personal information, to parents, subsidiaries, affiliates, or service providers across borders and from your country or jurisdiction to other countries or jurisdictions around the world.  If you are located in the European Union or other regions with laws governing data collection and use that may differ from U.S. law, please note that we may transfer information, including personal information, to a country and jurisdiction that does not have the same data protection laws as your jurisdiction, and you consent to the transfer of information to the U.S. or any other country in which Heartland or its parent, subsidiaries, affiliates or service providers maintain facilities and to the use and disclosure of information as described in this Privacy Policy. 
-
-6.   Third-Party Websites and Services
-
-Our websites or Services may provide links to (or links from) third-party websites or services � none of which are governed by this Privacy Policy.  To the extent that any linked third-party websites or services you visit are not owned or controlled by Heartland, we are not responsible for those websites� or services� content or information practices.  We strongly encourage you to review the privacy policies of any site or service before providing any personal information.
-
-7.   Changes to Privacy Policy
-
-We reserve the right to change this Privacy Policy from time to time in our sole discretion.  We will post changes on this page and indicate the �last modified� date at the top of this page.  Please check back often for any updates.  Your continued use of our website, mobile application or services after any change in this Privacy Policy will constitute your acceptance of such change.
-
-8.   Contact Us
-
-For additional inquiries about this Privacy Policy, please contact Heartland at 1-888-798-3131 to speak to a legal representative, or send us an email at PrivacyPolicy@e-hps.com, or letter.
-
-General Counsel Office
-Heartland Payment Systems, Inc.
-90 Nassau Street
+Online Privacy & Cookie Policy Statement ("Privacy Policy")
+
+Last modified on June 21, 2012
+
+Heartland Payment Systems, Inc. (�Heartland,� �we,� �us,� �our�) recognizes the importance of maintaining effective privacy practices.  This Privacy & Cookie Policy explains the online data collection and use policies that apply to the websites, mobile applications and online services (collectively �Services�) that are owned or controlled by Heartland and are linked to this Policy page.
+Click below to jump to a particular topic:
+
+1.       Information Collection and Use
+2.       Sharing of Information
+3.       Children�s Privacy
+4.       Your Choices
+5.       Data Protection and Storage
+6.       Third-Party Websites and Services
+7.       Changes to Our Privacy Policy
+8.       Contact Us
+
+1.   Information Collection and Use
+
+We collect information from various sources to provide our Services to you, to analyze and improve our Services, and to communicate with you (e.g., to send you updates or notices about our organization, or emails about products or services that we believe may be of interest to you). 
+Information that you provide to us:  We collect information that you provide to us when you set up an account with us, use our Services, or communicate with us.  For example, if you register for an online account with us, then we may request your personal information (e.g., name, postal address, email address, DOB, telephone number, credit/debit card number, security code) or as applicable your business information, to complete the registration process, to process transactions, to send you information about our products, to send you promotional offers from third parties that we think may be of interest to you, or to otherwise provide our Services to you.  Similarly, if you request information from us through an online contact form (or if you email us), we collect the information you provide (e.g., name, telephone number, email address) so that we can respond to you.
+ 
+Information collected from third parties:  We may collect information about you or your business from third parties in the course of providing our Services to you.  For example, we may obtain information from our merchant customersor we may collect information from a school or university about consumer/students to provide services to those consumer/student.  For some services,we may also collect information from third parties, such as credit reporting agencies or financial institutions, or other entities with information pertaining to the Services that we are providing to you. 
+ 
+Information collected through technology:  When you visit our websites or mobile applications (or when you use any of our online services) we may collect certain information about your computer or device through technology such as cookies, web beacons, or other tracking/recording tools.  The information collected may include, but is not limited to, IP addresses, referring URLs, access times, browser types, device types, mobile device identifiers, or information about your interactions with our websites, applications or services.  (Note that a �cookie� is a text file placed on a computer�s hard drive or stored on a mobile device; a �web beacon,� also known as an Internet tag, pixel tag or clear GIF, is used to transmit information back to a web server.)  We may use the information described in this paragraph to, among other things, (i) operate our Services, including by remembering information so that you will not have to re-enter it during your visit or the next time you sign in to your account, (ii) identify and protect our customers, (iii) control unauthorized use or abuse of our Services, (iv) provide custom, personalized content and information, which could include advertising, (v) monitor aggregate traffic patterns on our websites and services, and (vi) analyze and improve our Services.  
+
+2.   Sharing of Information
+
+We do not sell or share your information with third parties outside Heartland and our group of companies (which include any parents, subsidiaries and affiliates), without your consent, except as described below and in this Policy: 
+We may share your information with our service providers and business partners (e.g., financial institutions or card brands that issue payment cards or are involved in transaction processing; entities that assist with fraud prevention or collections; merchants that sell gift cards managed through our websites or services; schools), who assist us in providing our Services.  We may also share information with our service providers and business partners to help us monitor usage and other analytics regarding our Services, and to help us improve these offerings.  When we share your information with our service providers and business partners, we only provide the information that these third parties reasonably need to perform their functions.
+We may aggregate, or strip information of personally identifying characteristics, and may share that aggregated or anonymized information with third parties.
+We may share or disclose your information if we determine, in our sole discretion, that we are required to do so under applicable law or regulatory requirements, or if we reasonably believe disclosure is necessary to prevent harm or financial loss, or in connection with preventing fraud or illegal activity, and/or to enforce our Terms of Use.
+We reserve the right to transfer any information we collect in the event we sell or transfer all or a portion of our business or assets (including any shares in the company) or any portion or combination of our products, services, businesses and/or assets.  Should such a transaction occur (whether a divestiture, merger, acquisition, bankruptcy, dissolution, reorganization, liquidation, or similar transaction or proceeding), we will use reasonable efforts to ensure that any transferred information is treated in a manner consistent with this Privacy Policy.
+3.   Children�s Privacy
+
+Heartland�s websites, mobile applications and services are intended for use strictly by adults.  Heartland does not knowingly solicit or collect personal information from children under the age of 13.  If Heartland obtains knowledge that it has collected personal information from a child under 13 in retrievable form in its files, Heartland will delete that information.
+
+4.   Your Choices
+
+Email Communications.  From time to time, we may send you emails regarding updates to our websites, mobile applications or products/services, notices about our organization, or information about products/services we offer (or promotional offers from third parties) that we think may be of interest to you.  If you wish to unsubscribe from such emails, simply click the �unsubscribe link� provided at the bottom of the email communication.  Note that you cannot unsubscribe from certain Services-related email communications (e.g., account verification, confirmations of transactions, technical or legal notices).
+
+Modifying Account Information.  If you have an online account with us, you may have the ability to modify certain information in your account (e.g., your contact information) through �profile,� �account,� �settings,� or �preferences� options provided on the website or service.  If you have any questions about modifying or updating any information in your account, please contact us at the email address, postal address, or telephone number provided below. 
+
+Cookie Controls.  You may be able to set your Internet browser or mobile device to block cookies or other tracking/recording tools, including cookies associated with our websites or Services, or to indicate when a cookie is being set by us. However, it is important to remember that many of our websites or Services may not function properly if your cookies are disabled.  For information and instructions about how to manage your cookies, refer to your Internet browser�s or mobile device�s technical information.  Further information on how to adjust your cookie preferences through your browser is available at the external, third-party informational website www.allaboutcookies.org.
+ 
+5.   Data Protection and Storage
+
+Heartland maintains reasonable administrative, technical and physical safeguards to protect the confidentiality of information transmitted online, including but not limited to encryption, firewalls and SSL (Secure Sockets Layer). Heartland has implemented policies and practices pursuant to various security rules and regulations relating to the security and safeguarding of payment cardholder data, including the Payment Card Industry Data Security Standards (PCI-DSS).  Heartland is not liable for loss of passwords due to user negligence.  If you believe your password has been lost or compromised, we recommend that you immediately change your password.
+
+We may store and process information in the United States or any other country in which Heartland or its parents, subsidiaries, affiliates or service providers maintain facilities. Heartland may transfer information that we collect about you, including personal information, to parents, subsidiaries, affiliates, or service providers across borders and from your country or jurisdiction to other countries or jurisdictions around the world.  If you are located in the European Union or other regions with laws governing data collection and use that may differ from U.S. law, please note that we may transfer information, including personal information, to a country and jurisdiction that does not have the same data protection laws as your jurisdiction, and you consent to the transfer of information to the U.S. or any other country in which Heartland or its parent, subsidiaries, affiliates or service providers maintain facilities and to the use and disclosure of information as described in this Privacy Policy. 
+
+6.   Third-Party Websites and Services
+
+Our websites or Services may provide links to (or links from) third-party websites or services � none of which are governed by this Privacy Policy.  To the extent that any linked third-party websites or services you visit are not owned or controlled by Heartland, we are not responsible for those websites� or services� content or information practices.  We strongly encourage you to review the privacy policies of any site or service before providing any personal information.
+
+7.   Changes to Privacy Policy
+
+We reserve the right to change this Privacy Policy from time to time in our sole discretion.  We will post changes on this page and indicate the �last modified� date at the top of this page.  Please check back often for any updates.  Your continued use of our website, mobile application or services after any change in this Privacy Policy will constitute your acceptance of such change.
+
+8.   Contact Us
+
+For additional inquiries about this Privacy Policy, please contact Heartland at 1-888-798-3131 to speak to a legal representative, or send us an email at PrivacyPolicy@e-hps.com, or letter.
+
+General Counsel Office
+Heartland Payment Systems, Inc.
+90 Nassau Street
 Princeton, NJ 08542

data/README.md

@@ -1,213 +1,213 @@
-<a href="http://developer.heartlandpaymentsystems.com/SecureSubmit" target="_blank">
-	<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-heartland-logo" alt="Heartland logo" title="Heartland" align="right" />
-</a>
-
-# Heartland Ruby SDK
-
-This SDK makes it easy to integrate your Ruby application with Heartland's [**Portico Gateway API**](http://developer.heartlandpaymentsystems.com/Portico). Supported features include:
-
-* Card Not Present (eCommerce and mobile)
-* Card Present (Retail and Restaurant)
-* <a href="http://developer.heartlandpaymentsystems.com/SecureSubmit" target="_blank">Secure Submit</a> single-use tokenization and multi-use tokenization
-* <a href="https://www.heartlandpaymentsystems.com/about-heartland-secure/" target="_blank">Heartland Secure</a> End-to-End Encryption (E3)
-* [Credit](http://developer.heartlandpaymentsystems.com/Documentation/credit-card-payments/), [Gift & Loyalty](http://developer.heartlandpaymentsystems.com/Documentation/gift-card-payments/)</a>,and eCheck/ACH
-* [Recurring Payments](http://developer.heartlandpaymentsystems.com/Documentation/recurring-payments/)
-
-Supported Gateway Calls
-
-* BatchClose
-* CheckSale
-* CheckVoid
-* CreditAccountVerify
-* CreditAddToBatch
-* CreditAuth
-* CreditReturn
-* CreditReversal
-* CreditSale
-* GiftCardActivate
-* GiftCardAddValue
-* GiftCardAlias
-* GiftCardBalance
-* GiftCardDeactivate
-* GiftCardReplace
-* GiftCardReward
-* GiftCardSale
-* GiftCardVoid
-* GiftCardReversal
-* ReportActivity
-* ReportTxnDetail
-
-|  <a href="#data-security"><b>Data Security</b></a> | <a href="#api-reference"><b>API Reference</b></a>  |  <a href="#testing--certification"><b>Testing & Certification</b></a> | <a href="#api-keys">API Keys</a> | Links |
-|:--:|:--:|:--:|:--:|:--|
-| [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-secure)](#data-security)  | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-resources)](#documentation-and-examples)  | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-tools)](#certification--testing) | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-keys)](#api-keys) | <a href="http://developer.heartlandpaymentsystems.com/Account/Register" target="_blank">Register an Account</a> <br> <a href="http://www.heartlandpaymentsystems.com/partners/" target="_blank">Partner with Heartland</a> <br> <a href="http://developer.heartlandpaymentsystems.com/SecureSubmit/Support" target="_blank">Developer Support</a>  |
-
-#### Developer Support
-
-You are not alone! If you have any questions while you are working through your development process, please feel free to <a href="mailto:entapp_devportal@e-hps.com?Subject=Developer Support Request">reach out to our team for assistance</a>.
-
-## Requirements
-
-Ruby 2.3+
-
-## Installation
-
-The SDK can be added into your application via a Ruby [Gem](http://guides.rubygems.org/rubygems-basics/) command:
-
-> gem install 'hps'
-
-You can also use [Bundler Gemfiles](http://bundler.io/v1.5/gemfile.html) to have it automatically installed. Add the following to your gemfile:
-
-> gem 'hps'
-
-And then run Bundler :
-
-> Bundler
-
-## API Keys
-
-<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-keys" align="right"/>
-To begin creating test transactions you will need to obtain a set of public and private keys. These are easily obtained by creating an account on our [developer portal](http://developer.heartlandpaymentsystems.com/).
-Your keys are located under your profile information.
-
-[![Developer Keys](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-devportal-keys)](http://developer.heartlandpaymentsystems.com/Account/KeysAndCredentials)
-
-You will use your public key when implementing card tokenization and your private key will be used when communicating with our Portico Gateway. More details can be found in our [documentation](http://developer.heartlandpaymentsystems.com/SecureSubmit).
-
-Note: Multi-Use tokenization is not enabled by default when creating an account. You can contact <a href="mailto:SecureSubmitCert@e-hps.com?subject=Multi-use Token Request&body=Please enable multi-use tokens on my developer portal account which was signed up under the following email : ">Heartland's Specialty Products Team</a> to have this enabled. This is also true if you wish to use Gift & Loyalty, ACH, and Debit.
-
-
-## Data Security
-
-<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-secure" align="right"/>
-If your app stores, processes, or transmits cardholder data in cleartext then it is in-scope for PA-DSS. If your app is hosted, or the data in question otherwise comes into your organization, then the app and your entire company are in-scope for PCI DSS (either as a merchant or a service provider). Heartland offers a suite of solutions to help keep integrators' applications and/or environments shielded from cardholder data, whether at motion or at rest.
-
-- **Secure Submit** for eCommerce web or mobile applications ("card-not-present"), which leverages single-use tokenization to prevent card data from passing through the merchant or integrator's webserver. It only requires a simple JavaScript inclusion and provides two options for payment field hosting:
-	- **Self-Hosted Fields** - this approach relies upon the standard, appropriately named, HTML form controls on the integrator's served web page.
-	- **Heartland Hosted Fields** - this approach combines the Secure Submit service with iframes to handle presentation of the form fields and collection of sensitive data on Heartland servers. Since PCI version 3.1 the PCI Council and many QSAs advocate the iframe-based approach as enabling a merchant to more readily achieve PCI compliance via the simplified SAQ-A form. Check out the CoalFire's [whitepaper](http://developer.heartlandpaymentsystems.com/Resource/Download/coalfire-white-paper) for more information.
-- **Heartland Secure** for card-present retailers, hospitality, and other "POS" applications, comprises three distinct security technologies working in concert:
-	- **End-to-End Encryption** (E3) - combines symmetric and asymmetric cryptography to form an "Identity-Based Encryption" methodology which keeps cardholder data encrypted from the moment of the swipe.
-	- **Tokenization** - replaces sensitive data values with non-sensitive representations which may be stored for recurring billing, future orders, etc.
-	- **EMV** - though less about data security and more about fraud prevention, EMV or chip card technology guarantees the authenticity of the payment card and is thus an important concern for retailers.
-
-Depending on your (or your customers') payment acceptance environment, you may need to support one or more of these technologies in addition to this SDK. This SDK also supports the ability to submit cleartext card numbers as input, but any developer who does so will be expected to demonstrate compliance with PA-DSS. Likewise any third party integrator who is planning on handling cleartext card data on behalf of other merchants will be expected to demonstrate their PCI DSS compliance as a Service Provider prior to completing certification with Heartland.
-
-If you implement Secure Submit tokenization for your web or mobile application you will never have to deal with handling a card number - Heartland will take care of it for you and return a token to initiate the charge from your servers.
-
-Similarly, if you implement Heartland Secure with E3 (for both swiped and keyed entry methods) then your POS application will be out-of-scope for PA-DSS. Heartland Secure certified devices will only ever return E3 encrypted data which can safely be passed through your systems as input to this SDK. Heartland Secure devices include many popular models manufactured by PAX and Ingenico.
-
-To summarize, when you create a payment method using this SDK you have the following options for securely avoiding interaction with sensitive cardholder data:
-
-- Card data (track or PAN) may be sent directly from a web browser to Heartland, returning a SecureSubmit single use token that is then sent to your server.
-- Encrypted card data (track or PAN) may be obtained directly from a Heartland Secure device and passed to the SDK
-
-## Documentation and Examples
-
-<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-resources" align="right"/>
-You can find the latest SDK documentation along with code examples on our [Developer Portal](http://developer.heartlandpaymentsystems.com/documentation).
-In addition the included [test suite](http://github.hps.com/DevPortal/Ruby-SDK/tree/master/tests) can be a great source of code samples for using the SDK!
-
-## Testing & Certification
-
-<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-tools" align="right"/>
-Testing your implementation in our Certification/Sandbox environment helps to identify and squash bugs before you begin processing transactions in the production environment. While you are encouraged to run as many test transactions as you can, Heartland provides a specific series of tests that you are required to complete before receiving Certification. Please <a href="mailto:SecureSubmitCert@e-hps.com?Subject=Certification Request&Body=I am ready to start certifying my integration! ">contact</a> Heartland in order to initiate a certification project.
-
-*Quick Tip*: You can get a head start on your certification by reviewing the [certification tests](https://github.com/hps/heartland-ruby/tree/master/tests) in the included test suite.
-
-#### Test Card Data
-
-The following card numbers are used by our Certification environment to verify that your tests worked. Note that while variations (such as 4111111111111111) will work for general testing the cards listed below are required to complete certification.
-
-<table align="center">
-	<thead>
-		<tr>
-			<th scope="col">Name</th>
-			<th scope="col">Number</th>
-			<th scope="col">Exp Month</th>
-			<th scope="col">Exp Year</th>
-			<th scope="col">CVV</th>
-			<th scope="col">Address</th>
-			<th scope="col">Zip</th>
-		</tr>
-	</thead>
-	<tbody>
-		<tr>
-			<td>Visa</td>
-			<td>4012002000060016</td>
-			<td>12</td>
-			<td>2025</td>
-			<td>123</td>
-			<td>6860 Dallas Pkwy</td>
-			<td>750241234</td>
-		</tr>
-		<tr>
-			<td>MasterCard</td>
-			<td>5473500000000014</td>
-			<td>12</td>
-			<td>2025</td>
-			<td>123</td>
-			<td>6860 Dallas Pkwy</td>
-			<td>75024</td>
-		</tr>
-		<tr>
-			<td>Discover</td>
-			<td>6011000990156527</td>
-			<td>12</td>
-			<td>2025</td>
-			<td>123</td>
-			<td>6860</td>
-			<td>750241234</td>
-		</tr>
-		<tr>
-			<td>Amex</td>
-			<td>372700699251018</td>
-			<td>12</td>
-			<td>2025</td>
-			<td>1234</td>
-			<td>6860</td>
-			<td>75024</td>
-		</tr>
-		<tr>
-			<td>JCB</td>
-			<td>3566007770007321</td>
-			<td>12</td>
-			<td>2025</td>
-			<td>123</td>
-			<td>6860</td>
-			<td>75024</td>
-		</tr>
-	</tbody>
-</table>
-
-#### Testing Exceptions
-
-During your integration you will want to test for specific issuer responses such as 'Card Declined'. Because our sandbox does not actually reach out to issuers we have devised specific transaction amounts that will trigger  [issuer response codes](https://cert.api2.heartlandportico.com/Gateway/PorticoDevGuide/build/PorticoDeveloperGuide/Issuer%20Response%20Codes.html) and [gateway response codes](https://cert.api2.heartlandportico.com/Gateway/PorticoDevGuide/build/PorticoDeveloperGuide/Gateway%20Response%20Codes.html). Please <a href="mailto:SecureSubmitCert@e-hps.com?subject=Hard Coded Values Spreadsheet Request">contact</a> Heartland for a complete listing of values you can charge to simulate AVS, CVV and Transaction declines, errors, and other responses that you can catch in your code:
-
-```ruby
-begin
-	credit_service.charge(-5, 'usd', credit_card, card_holder)
-rescue HpsInvalidRequestException => e
-	# handle error for amount less than zero dollars
-rescue HpsAuthenticationException => e
-	# handle errors related to your HpsServiceConfig
-rescue HpsCreditException => e
-	# handle card-related exceptions: card declined, processing error, etc
-end
-````
-
-More exceptions can be found [here](https://github.com/hps/heartland-ruby/tree/master/lib/hps/infrastructure).
-
-## Contributing
-
-All our code is open sourced and we encourage fellow developers to contribute and help improve it!
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Ensure SDK tests are passing
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
-
-
-#### Included Test Suite
-
-The included test suite can help ensure your contribution doesn't cause unexpected errors and is a terrific resource of working examples that you can reference. As mentioned earlier, the [certification folder](http://github.hps.com/DevPortal/Ruby-SDK/blob/master/tests/cert_tests.rb) contains tests that mirror the types of requirements you will encounter when you certify your integration for production.
+<a href="http://developer.heartlandpaymentsystems.com/SecureSubmit" target="_blank">
+	<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-heartland-logo" alt="Heartland logo" title="Heartland" align="right" />
+</a>
+
+# Heartland Ruby SDK
+
+This SDK makes it easy to integrate your Ruby application with Heartland's [**Portico Gateway API**](http://developer.heartlandpaymentsystems.com/Portico). Supported features include:
+
+* Card Not Present (eCommerce and mobile)
+* Card Present (Retail and Restaurant)
+* <a href="http://developer.heartlandpaymentsystems.com/SecureSubmit" target="_blank">Secure Submit</a> single-use tokenization and multi-use tokenization
+* <a href="https://www.heartlandpaymentsystems.com/about-heartland-secure/" target="_blank">Heartland Secure</a> End-to-End Encryption (E3)
+* [Credit](http://developer.heartlandpaymentsystems.com/Documentation/credit-card-payments/), [Gift & Loyalty](http://developer.heartlandpaymentsystems.com/Documentation/gift-card-payments/)</a>,and eCheck/ACH
+* [Recurring Payments](http://developer.heartlandpaymentsystems.com/Documentation/recurring-payments/)
+
+Supported Gateway Calls
+
+* BatchClose
+* CheckSale
+* CheckVoid
+* CreditAccountVerify
+* CreditAddToBatch
+* CreditAuth
+* CreditReturn
+* CreditReversal
+* CreditSale
+* GiftCardActivate
+* GiftCardAddValue
+* GiftCardAlias
+* GiftCardBalance
+* GiftCardDeactivate
+* GiftCardReplace
+* GiftCardReward
+* GiftCardSale
+* GiftCardVoid
+* GiftCardReversal
+* ReportActivity
+* ReportTxnDetail
+
+|  <a href="#data-security"><b>Data Security</b></a> | <a href="#api-reference"><b>API Reference</b></a>  |  <a href="#testing--certification"><b>Testing & Certification</b></a> | <a href="#api-keys">API Keys</a> | Links |
+|:--:|:--:|:--:|:--:|:--|
+| [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-secure)](#data-security)  | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-resources)](#documentation-and-examples)  | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-tools)](#certification--testing) | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-keys)](#api-keys) | <a href="http://developer.heartlandpaymentsystems.com/Account/Register" target="_blank">Register an Account</a> <br> <a href="http://www.heartlandpaymentsystems.com/partners/" target="_blank">Partner with Heartland</a> <br> <a href="http://developer.heartlandpaymentsystems.com/SecureSubmit/Support" target="_blank">Developer Support</a>  |
+
+#### Developer Support
+
+You are not alone! If you have any questions while you are working through your development process, please feel free to <a href="mailto:entapp_devportal@e-hps.com?Subject=Developer Support Request">reach out to our team for assistance</a>.
+
+## Requirements
+
+Ruby 2.3+
+
+## Installation
+
+The SDK can be added into your application via a Ruby [Gem](http://guides.rubygems.org/rubygems-basics/) command:
+
+> gem install 'hps'
+
+You can also use [Bundler Gemfiles](http://bundler.io/v1.5/gemfile.html) to have it automatically installed. Add the following to your gemfile:
+
+> gem 'hps'
+
+And then run Bundler :
+
+> Bundler
+
+## API Keys
+
+<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-keys" align="right"/>
+To begin creating test transactions you will need to obtain a set of public and private keys. These are easily obtained by creating an account on our [developer portal](http://developer.heartlandpaymentsystems.com/).
+Your keys are located under your profile information.
+
+[![Developer Keys](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-devportal-keys)](http://developer.heartlandpaymentsystems.com/Account/KeysAndCredentials)
+
+You will use your public key when implementing card tokenization and your private key will be used when communicating with our Portico Gateway. More details can be found in our [documentation](http://developer.heartlandpaymentsystems.com/SecureSubmit).
+
+Note: Multi-Use tokenization is not enabled by default when creating an account. You can contact <a href="mailto:SecureSubmitCert@e-hps.com?subject=Multi-use Token Request&body=Please enable multi-use tokens on my developer portal account which was signed up under the following email : ">Heartland's Specialty Products Team</a> to have this enabled. This is also true if you wish to use Gift & Loyalty, ACH, and Debit.
+
+
+## Data Security
+
+<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-secure" align="right"/>
+If your app stores, processes, or transmits cardholder data in cleartext then it is in-scope for PA-DSS. If your app is hosted, or the data in question otherwise comes into your organization, then the app and your entire company are in-scope for PCI DSS (either as a merchant or a service provider). Heartland offers a suite of solutions to help keep integrators' applications and/or environments shielded from cardholder data, whether at motion or at rest.
+
+- **Secure Submit** for eCommerce web or mobile applications ("card-not-present"), which leverages single-use tokenization to prevent card data from passing through the merchant or integrator's webserver. It only requires a simple JavaScript inclusion and provides two options for payment field hosting:
+	- **Self-Hosted Fields** - this approach relies upon the standard, appropriately named, HTML form controls on the integrator's served web page.
+	- **Heartland Hosted Fields** - this approach combines the Secure Submit service with iframes to handle presentation of the form fields and collection of sensitive data on Heartland servers. Since PCI version 3.1 the PCI Council and many QSAs advocate the iframe-based approach as enabling a merchant to more readily achieve PCI compliance via the simplified SAQ-A form. Check out the CoalFire's [whitepaper](http://developer.heartlandpaymentsystems.com/Resource/Download/coalfire-white-paper) for more information.
+- **Heartland Secure** for card-present retailers, hospitality, and other "POS" applications, comprises three distinct security technologies working in concert:
+	- **End-to-End Encryption** (E3) - combines symmetric and asymmetric cryptography to form an "Identity-Based Encryption" methodology which keeps cardholder data encrypted from the moment of the swipe.
+	- **Tokenization** - replaces sensitive data values with non-sensitive representations which may be stored for recurring billing, future orders, etc.
+	- **EMV** - though less about data security and more about fraud prevention, EMV or chip card technology guarantees the authenticity of the payment card and is thus an important concern for retailers.
+
+Depending on your (or your customers') payment acceptance environment, you may need to support one or more of these technologies in addition to this SDK. This SDK also supports the ability to submit cleartext card numbers as input, but any developer who does so will be expected to demonstrate compliance with PA-DSS. Likewise any third party integrator who is planning on handling cleartext card data on behalf of other merchants will be expected to demonstrate their PCI DSS compliance as a Service Provider prior to completing certification with Heartland.
+
+If you implement Secure Submit tokenization for your web or mobile application you will never have to deal with handling a card number - Heartland will take care of it for you and return a token to initiate the charge from your servers.
+
+Similarly, if you implement Heartland Secure with E3 (for both swiped and keyed entry methods) then your POS application will be out-of-scope for PA-DSS. Heartland Secure certified devices will only ever return E3 encrypted data which can safely be passed through your systems as input to this SDK. Heartland Secure devices include many popular models manufactured by PAX and Ingenico.
+
+To summarize, when you create a payment method using this SDK you have the following options for securely avoiding interaction with sensitive cardholder data:
+
+- Card data (track or PAN) may be sent directly from a web browser to Heartland, returning a SecureSubmit single use token that is then sent to your server.
+- Encrypted card data (track or PAN) may be obtained directly from a Heartland Secure device and passed to the SDK
+
+## Documentation and Examples
+
+<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-resources" align="right"/>
+You can find the latest SDK documentation along with code examples on our [Developer Portal](http://developer.heartlandpaymentsystems.com/documentation).
+In addition the included [test suite](http://github.hps.com/DevPortal/Ruby-SDK/tree/master/tests) can be a great source of code samples for using the SDK!
+
+## Testing & Certification
+
+<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-tools" align="right"/>
+Testing your implementation in our Certification/Sandbox environment helps to identify and squash bugs before you begin processing transactions in the production environment. While you are encouraged to run as many test transactions as you can, Heartland provides a specific series of tests that you are required to complete before receiving Certification. Please <a href="mailto:SecureSubmitCert@e-hps.com?Subject=Certification Request&Body=I am ready to start certifying my integration! ">contact</a> Heartland in order to initiate a certification project.
+
+*Quick Tip*: You can get a head start on your certification by reviewing the [certification tests](https://github.com/hps/heartland-ruby/tree/master/tests) in the included test suite.
+
+#### Test Card Data
+
+The following card numbers are used by our Certification environment to verify that your tests worked. Note that while variations (such as 4111111111111111) will work for general testing the cards listed below are required to complete certification.
+
+<table align="center">
+	<thead>
+		<tr>
+			<th scope="col">Name</th>
+			<th scope="col">Number</th>
+			<th scope="col">Exp Month</th>
+			<th scope="col">Exp Year</th>
+			<th scope="col">CVV</th>
+			<th scope="col">Address</th>
+			<th scope="col">Zip</th>
+		</tr>
+	</thead>
+	<tbody>
+		<tr>
+			<td>Visa</td>
+			<td>4012002000060016</td>
+			<td>12</td>
+			<td>2025</td>
+			<td>123</td>
+			<td>6860 Dallas Pkwy</td>
+			<td>750241234</td>
+		</tr>
+		<tr>
+			<td>MasterCard</td>
+			<td>5473500000000014</td>
+			<td>12</td>
+			<td>2025</td>
+			<td>123</td>
+			<td>6860 Dallas Pkwy</td>
+			<td>75024</td>
+		</tr>
+		<tr>
+			<td>Discover</td>
+			<td>6011000990156527</td>
+			<td>12</td>
+			<td>2025</td>
+			<td>123</td>
+			<td>6860</td>
+			<td>750241234</td>
+		</tr>
+		<tr>
+			<td>Amex</td>
+			<td>372700699251018</td>
+			<td>12</td>
+			<td>2025</td>
+			<td>1234</td>
+			<td>6860</td>
+			<td>75024</td>
+		</tr>
+		<tr>
+			<td>JCB</td>
+			<td>3566007770007321</td>
+			<td>12</td>
+			<td>2025</td>
+			<td>123</td>
+			<td>6860</td>
+			<td>75024</td>
+		</tr>
+	</tbody>
+</table>
+
+#### Testing Exceptions
+
+During your integration you will want to test for specific issuer responses such as 'Card Declined'. Because our sandbox does not actually reach out to issuers we have devised specific transaction amounts that will trigger  [issuer response codes](https://cert.api2.heartlandportico.com/Gateway/PorticoDevGuide/build/PorticoDeveloperGuide/Issuer%20Response%20Codes.html) and [gateway response codes](https://cert.api2.heartlandportico.com/Gateway/PorticoDevGuide/build/PorticoDeveloperGuide/Gateway%20Response%20Codes.html). Please <a href="mailto:SecureSubmitCert@e-hps.com?subject=Hard Coded Values Spreadsheet Request">contact</a> Heartland for a complete listing of values you can charge to simulate AVS, CVV and Transaction declines, errors, and other responses that you can catch in your code:
+
+```ruby
+begin
+	credit_service.charge(-5, 'usd', credit_card, card_holder)
+rescue HpsInvalidRequestException => e
+	# handle error for amount less than zero dollars
+rescue HpsAuthenticationException => e
+	# handle errors related to your HpsServiceConfig
+rescue HpsCreditException => e
+	# handle card-related exceptions: card declined, processing error, etc
+end
+````
+
+More exceptions can be found [here](https://github.com/hps/heartland-ruby/tree/master/lib/hps/infrastructure).
+
+## Contributing
+
+All our code is open sourced and we encourage fellow developers to contribute and help improve it!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Ensure SDK tests are passing
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+
+#### Included Test Suite
+
+The included test suite can help ensure your contribution doesn't cause unexpected errors and is a terrific resource of working examples that you can reference. As mentioned earlier, the [certification folder](http://github.hps.com/DevPortal/Ruby-SDK/blob/master/tests/cert_tests.rb) contains tests that mirror the types of requirements you will encounter when you certify your integration for production.