This SDK makes it easy to integrate your PHP application with Heartland’s Portico Gateway API, as well as other APIs such as MasterPass. Additionally, this SDK also facilitates integration with Heartland Secure: Out-of-Scope devices, providing for simple semi- integrated EMV acceptance, enabling a true single point of integration for omni-channel developers.
Supported features include:
- Card Not Present (eCommerce and mobile)
- Card Present (Retail and Restaurant)
- Secure Submit single-use tokenization and multi-use tokenization
- Heartland Secure End-to-End Encryption (E3)
- Credit, Gift & Loyalty,and eCheck/ACH
- Recurring Payments
- Direct Communication with Heartland's Out of Scope devices such as PaxS300
| Data Security | API Reference | Testing & Certification |
API Keys | Links |
|---|---|---|---|---|
| Register an Account Partner with Heartland |
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!
Add this SDK to your PHP project and require it once.
<?php
require_once 'Hps.php';
?>Using Composer? Require this library in your composer.json:
{
"require": {
"hps/heartland-php": "*"
}
}and run composer update to pull down the dependency and update your autoloader.
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.
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.
-
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-EP 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 paymentMethod 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
- eCheck
- End-to-End
- Gift
- iFrame Pay Invoice
- iFrame Recurring Signup
- Manual Tokenization
- MasterPass
- Pay Invoice
- Point of Sale/E3 Swipe (mag stripe data only)
- Recurring Signup
Quick Tip: The included test suite can be a great source of code samples for using the SDK!
Note that our SDK provides a Fluent Interface which allows you to replace a charge call that looks like this:
$response = $chargeSvc->charge(17.01, "usd", TestCreditCard::validVisaCreditCard(), TestCardHolder::certCardHolderShortZip());With one that reads like this:
$response = $this->service
->charge()
->withAmount(17.01)
->withCurrency("usd")
->withCard(TestCreditCard::validVisaCreditCard())
->withCardHolder(TestCardHolder::certCardHolderShortZip())
->execute();Between the two samples you can more easily read and understand what the code is doing in the second example than the first. That is a big advantage and helps speed development and reduce errors when using methods that allow a large number of parameters.
Quick Tip: You will find Fluent and Non-Fluent examples in the included test suite.
Quick Tip: You can get a head start on your certification by reviewing the certification tests in the included test suite.
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. For card present testing Heartland can provide you with EMV enabled test cards.
| Name | Number | Exp Month | Exp Year | CVV | Address | Zip |
|---|---|---|---|---|---|---|
| Visa | 4012002000060016 | 12 | 2025 | 123 | 6860 Dallas Pkwy | 75024 |
| MasterCard | 5473500000000014 | 12 | 2025 | 123 | 6860 Dallas Pkwy | 75024 |
| Discover | 6011000990156527 | 12 | 2025 | 123 | 6860 Dallas Pkwy | 75024 |
| Amex | 372700699251018 | 12 | 2025 | 1234 | 6860 Dallas Pkwy | 75024 |
| JCB | 3566007770007321 | 12 | 2025 | 123 | 6860 Dallas Pkwy | 75024 |
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 card brands for authorizations 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:
try
{
$response = $this->service
->charge()
->withAmount(5)
->execute();
}
catch (HpsInvalidRequestException $e)
{
// handle errors for invalid arguments such as a charge amount less than zero dollars
}
catch (HpsAuthenticationException $e)
{
// handle errors related to your HpsServiceConfig (username, pw, api keys etc.)
}
catch (HpsCreditException $e)
{
// handle card-related exceptions: card declined, processing error, etc
}All our code is open sourced and we encourage fellow developers to contribute and help improve it!
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Ensure SDK tests are passing
- Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
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.
Clone this repository locally, install dependencies with Composer, and run PHPUnit against the provided tests.
$ git clone https://github.com/SecureSubmit/heartland-php.git
$ cd heartland-php
$ composer install
$ php vendor/bin/phpunit -c tests/phpunit.xml
This will run through all of our test suites by default. To run a single test suite, pass the --testsuite
option to php vendor/bin/phpunit with one of the following values:
fluentgateway-checkgateway-creditgateway-debitgateway-giftcardgateway-tokengeneralcertification
Example:
$ php vendor/bin/phpunit -c tests/phpunit.xml --testsuite certification
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent