Skip to content


Repository files navigation

Heartland logo

Heartland Ruby SDK

This SDK makes it easy to integrate your Ruby application with Heartland's Portico Gateway API. Supported features include:

Supported Gateway Calls

  • BatchClose
  • CheckSale
  • CheckVoid
  • CreditAccountVerify
  • CreditAddToBatch
  • CreditAuth
  • CreditReturn
  • CreditReversal
  • CreditSale
  • GiftCardActivate
  • GiftCardAddValue
  • GiftCardAlias
  • GiftCardBalance
  • GiftCardDeactivate
  • GiftCardReplace
  • GiftCardReward
  • GiftCardSale
  • GiftCardVoid
  • GiftCardReversal
  • ReportActivity
  • ReportTxnDetail
Data Security API Reference Testing & Certification API Keys Links
Register an Account
Partner with Heartland
Developer Support

Developer Support

You are not alone! If you have any questions while you are working through your development process, please feel free to reach out to our team for assistance.


Ruby 2.3+


The SDK can be added into your application via a Ruby Gem command:

gem install 'hps'

You can also use Bundler Gemfiles to have it automatically installed. Add the following to your gemfile:

gem 'hps'

And then run Bundler :


API Keys

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]( Your keys are located under your profile information.

Developer Keys

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.

Note: Multi-Use tokenization is not enabled by default when creating an account. You can contact Heartland's Specialty Products Team to have this enabled. This is also true if you wish to use Gift & Loyalty, ACH, and Debit.

Data Security

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

You can find the latest SDK documentation along with code examples on our [Developer Portal]( In addition the included [test suite]( can be a great source of code samples for using the SDK!

Testing & Certification

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 contact Heartland in order to initiate a certification project.

Quick Tip: You can get a head start on your certification by reviewing the certification 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.

Name Number Exp Month Exp Year CVV Address Zip
Visa 4012002000060016 12 2025 123 6860 Dallas Pkwy 750241234
MasterCard 5473500000000014 12 2025 123 6860 Dallas Pkwy 75024
Discover 6011000990156527 12 2025 123 6860 750241234
Amex 372700699251018 12 2025 1234 6860 75024
JCB 3566007770007321 12 2025 123 6860 75024

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 and gateway response codes. Please contact 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:

	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

More exceptions can be found here.


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 contains tests that mirror the types of requirements you will encounter when you certify your integration for production.