Heartland

How to enable Heartland Token on a merchant.

Heartland provides secure electronic payment solutions with a focus on technology-driven services that simplify payment processing, payroll services, and enterprise solutions.

Features

Refund A token payment processed with Heartland can be / according to its status. ✅ Payment Authorization Payments can be authorized by customers using Token. ✅ Payment Capture Payment authorizations made using Token payment methods can be captured. This step happens automatically with CHARGE transactions.

Resources

Configuration

To use Heartland for credit card payments, you need a secret API key which you can obtain by setting up an account on their portal. Visit their website for more details on getting started and integrating their services into your system.

This table describes the required or possible attributes needed to configure a merchant product for this type.

NameTypeDescriptionRules
secretAPIKey(required) Secret API key for authenticating requests to the Heartland service. Examples: your-secret-api-key.

Enabling this Product

Using create-merchant-product API you can add a new product to your merchant record. Below is an example configuration for the payload of that request.

{
  "line": "payments",
  "product": "token",
  "provider": "heartland",
  "config": {
    "secretAPIKey": "your-secret-api-key"
  }
}

Data Mapping

The following bullet points outline the mapping of data fields between the Authvia platform and the Heartland system, detailing the correspondence of specific attributes for seamless data integration.

  • Authvia transaction.reference.external maps to Heartland CardHolderPONbr
  • Authvia transaction.description maps to Heartland UNMAPPED
  • Authvia transaction.id maps to Heartland UNMAPPED
  • Authvia transaction.metadata.CardBrandTxnId maps to Heartland CardBrandTxnId
  • Authvia merchant.id maps to Heartland UNMAPPED