How to Connect
Prerequisites
Before setting up the Heartland integration in iPaaS.com, ensure you have the following information:
API URL: The URL prefix of your Heartland installation.
Example:https://ipaasdev.retail.heartland.us/
Authentication: Permissions required for this integration, including:
Manage Webhooks
Manage Roles
Reporting: Read Metric Gift Cards Expired
Configure Subscription Settings
Navigate to the Heartland subscription settings in iPaaS.com and provide the following information:
Configure Subscription Settings
Field | Description | Required | Example |
Name | A unique name for the Heartland subscription. | Yes | Heartland Integration |
Versions | API version for the integration. | Yes | v1.0 |
Adjust Empty Gift Card for Payment | Configure gift card payments for transactions. | No | 1 |
Add On Item Limit | Limits for add-on items. | No | 100 |
Transaction Poll Search Days | Number of days to poll for transaction data. | No | 30 |
Inventory Poll Search Days | Number of days to poll for inventory data. | No | 15 |
API Key | API key for accessing Heartland. | Yes | Your API Key |
API URL | Base URL of the Heartland installation. | Yes |
Authentication Methods
Follow these steps to authenticate the Heartland integration:
Add the name and API URL into the subscription.
Save it and reopen it.
Re-open your Heartland subscription in iPaaS.com and click the Authenticate icon.
You will be redirected to a Heartland permissions page.
Review and allow the following permissions:
Manage WebhooksManage RolesReporting: Read Metric Gift Cards ExpiredClick Allow at the bottom of the screen.
Once completed, the browser will confirm that Authorization is complete.
Refresh the subscription in iPaaS.com. You should now see a valid Access Token displayed.
Initialization Support
The following types of data support initialization and can be transferred in bulk:
Location TO iPaaS.com
Payment Method TO iPaaS.com
Shipping Method TO iPaaS.com
Throttling
Throttling ensures that Heartland's API isn’t overwhelmed by excessive API calls, preserving system performance during heavy data transfers.
While the throttling fields are required, the values are pre-populated by the integration settings. For more details, refer to Subscription Configuration – Edit.