Developer Portal

Get Started

Click an option below for steps on getting started with your integration.

Ecommerce Overview

An overview of our Ecommerce products.

Card Payments

Tokenize and take payments with credit cards.

Check Payments

Take payments with ACH/eCheck.

Gift & Loyalty Payments

Take payments with gift and loyalty.

Recurring Payments

Take tokenized, subscription card and check payments.

Fraud

Stop fraud before the payment is complete.

Plugins & Integrations

Plugins for leading carts, platforms and online ordering.

Reporting

Pull transactions and details for a date range.

Demo

How Heartland tokenization works

Ecommerce Plugins & Integrations

Get up and running quickly and easily with our feature-rich extensions into the world's leading retail shopping carts and Ecommerce platforms.

Browse All


References

Explore our SDK documentation and get started with our in-depth guides to each request and response type.

SDK Documentation

Useful Resources

Test Cards
Support
Logos and Assets
Portico Gateway

Semi Integrated

This solution allows you to build requests from your POS to an already EMV certified payment application. This type of integration is the desired route for anyone looking to integrate quickly to Heartland.

Fully Integrated

This solution allows you to build requests from the ground up allowing you to fully customize the solution. This type of integration is the desired route for anyone looking for full control over the integration to Heartland.

POS EMV Middleware Connectors

Heartland for MicrosOPI & Aloha

Learn More

Terminals

Check out terminal and hardware options for semi-integrated payments.

Learn More

Portico Gateway Documentation

Heartland Portico Gateway Documentation

Learn More


References

Explore our SDK documentation and get started with our in-depth guides to each request and response type.

SDK Documentation

Useful Resources

Test Cards
Support
Logos and Assets
Portico Gateway

IoT Overview

An overview of our IoT offerings.

Payments

Credit, Debit and gift payments.

eWallet

Securely vault credit and debit cards.

Subscriptions

Take subscription payments.

Stored Value

Save money by avoiding frequent small charges.

Loyalty

Extend offers to customers.

API Overview

An overview of a few of Heartland's APIs.

Gift & Loyalty

Direct, non-SDK integration to gift & loyalty.

Bill Pay

Explore solutions for paying invoices and bills.

Payroll

Explorer payroll, time and attendance.



References

Explore our SDK documentation and get started with our in-depth guides to each request and response type.

SDK Documentation

Useful Resources

Test Cards
Support
Logos and Assets
Portico Gateway

Certification & Testing

The certification process will differ depending on the solutions and equipment in your unique integration with Heartland.

Integration type

Choose your integration type to get started with certification.

To receive production keys for a customized payment solution created using our SDKs, you must begin certification following the steps below. **The use of a Plugin does NOT require this process. If you are using an existing Heartland plugin or extension, or have previously certified your solution in the past, please reach out to your Relationship Manager or our Online Payments Team with questions.**

Creating a custom payment solution using our SDKs

  1. Register for an account on the Heartland Developer Portal (if you haven't already).
  2. Fill out the CRF (Certification Request Form here).
  3. Upon receiving your completed CRF, you will receive a developer ID, version number, and test cases.
    1. The transaction value(s)/dollar amount needs to be run as requested so we can retrieve the correct data for all card brands that are being certified.
    2. If the developer needs to test a different value they must let us know what value/dollar amount is being tested and what card brand the amount is being assigned to.
    3. There shouldn’t be any exceptions aside from the whole dollar amount vs having change on the amount being tested.
  4. Once the tests have been completed, click the link in the body of the certification credentials eMail. This will send an eMail notification to the Online Payments Team that you have completed all your test cases in order and they are ready to be checked. If a transaction needs to be re-processed, the Online Payments team will advise.
  5. Upon successful completion of the test script, you will receive a Certification Announcement Letter via email. **Note: if you have not received your certification announcement, please reach out to onlinepayments@heartland.us to verify your test cases were completed successfully**

Certification is required for any integration wishing to receive production API keys for card-not-present payment processing. If you have any questions about the process, please reach out to our support team at onlinepayments@heartland.us.

Fill out the form below to begin certification. If you do not see the form, you must create an account by clicking the "Get Sandbox Account" button on this site. If you have already created an account click "Sign In".

Once you are ready to certify your card-present integration, fill out the Validation Request Form (VRF) and one of our team members will start the process with you.

  1. Browse our terminal & hardware options.
  2. Fill out the VRF.
  3. Upon receiving your completed VRF, we will determine your need for a test device and provide test cases based on your responses in the Validation Request Form.
  4. Respond to that email for integration questions or reach out to us at integratormanagement@e-hps.com once you have processed the requested transactions.
  5. Our Integration team will check each transaction to make sure all data is correct for compliance purposes. We will alert you of any issues or changes you'll need to make, or finalize a certification announcement letter based on our review.

Certification is required for any integration for card-present payment processing. If you have any questions about the process, please reach out to our support team at integratormanagement@e-hps.com.

This section can pertain to certifications including Portico, Petro, Ecommerce, MOTO, lodging, retail, restaurant, MSR, ACH, EMV, Gift, Recurring Payments and more

  1. Review Portico or Portico Exchange Certification Process.
  2. Work with Heartland Integration Team to discuss integration: integratormanagement@e-hps.com
  3. Send Certification Request Form to Integrator Management (integratormanagement@e-hps.com).
  4. Develop and test your integration. Contact us with any questions.
  5. Once your development is complete, work with your assigned certification analyst to complete required tests.

Support

If you have been assigned a Portico or Exchange integration you may reach out to Portico Integration Support or Exchange Integration Support



References

Explore our SDK documentation and get started with our in-depth guides to each request and response type.

SDK Documentation

Useful Resources

Test Cards
Support
Logos and Assets
Portico Gateway
Choose an option below to continue through the online payment/card not present integration path.


You have selected that you are using a Plugin for you integration, this type of integration does not require any certification effort.
Please reach out to your relationship manager or sales person to assist with account setup. If you do not have one or do not know who your sales person is please email onlinepayments@heartland.us .


You have selected that you are not using a Plugin for your integration, please click the link below:
Online Payments certification process.
Choose an option below to continue through the In Person Payments integration path.


You have selected that you are pursuing a card present/semi integrated approach to your integration, please click the link below:
Out of scope/semi-integrated certification process.


You have selected that you are pursuing an in scope/fully integrated solution approach to your integration, please click the link below:
Heartland Direct certification process.
Choose an option below to continue through the BillPay integration path.


If user selects I am a government or municipality and need convenience fees , the page should display:
Heartland Bill Pay


If user selects I am not a government or municipality but I need surcharge, the page should display:
Online Payments certification process.
You have selected that you are unsure of the process you need to take, please email solutionconsulting@heartland.us for guidance.
Looking for API Sandbox Keys?Register and receive your keys immediately.