Loading...
Existing customers: Get your sandbox and production credentials for Heartland/Portico integration.
By integrating with our WooCommerce plugin, you'll gain access to the full range of our solutions, credit and debit processing, card management, and order management.
Click the button below to download this plugin and view any related documentation available.
Get the pluginOur WooCommerce plugin requires credentials to our Payments gateway. You can get your Test credentials when you register with our developer portal. Once registration is complete, you can find the required Public and Secret Keys in your account.
To configure this plugin, follow these steps.
The Payments gateway offers payment through credit and debit cards.
The Payments Settings tab allows you to enter your overall account credentials. These global settings apply to all integration types. You can enter specific credentials for different websites by changing the website scope in WooCommerce.
The following table describes the fields that appear on the Payments Settings tab for WooCommerce.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g.,"Credit Card." The title will also be recorded in WooCommerce to indicate how the transaction was processed. |
| Description | Description of the checkout experience the user sees during checkout |
| Public Key | The Public Key and Secret Key are used to obtain a bearer access token to execute API actions. For more information, see the Sandbox credentials section. |
| Secret Key | See description for Public Key. |
| Custom Error | Determines the error message that is displayed if an error occurs during the checkout process. |
| Allow Card Saving | Determines whether a customer's card can be saved to our Card Storage solution following a successful transaction. If set to Yes, a checkbox displays on the Hosted Fields form that gives the customer the choice to store their card. If set to No, no checkbox displays, and the card is not stored. |
| Do not fail suspicious orders | Determines if an order is suspicious. When enabled the client will have 72 hours from the original authorization date to manually review suspicious orders in the virtual terminal and make a final decision (either to accept the gateway fraud decision or to manually override). |
| Email Store Owner on Suspicious Orders | Determines if the store owner will be notified if a suspicious order occurs. |
| Notification Email Address | Allows the client to identify who will be notified when a suspicious order occurs. |
| Fraud Text | The text that will display to the customer when fraud is detected and the transaction fails. |
| Max Velocity Attempts | Controls the maximum number of attempts allowed per unique IP address before additional attempts from a user are blocked. |
| Velocity Timespan | Controls the amount of time (in minutes) before recent failures are ignored. |
| Payment Action | The sale transaction can be flagged for automatic capture (Authorize + Capture) or flagged as requiring a separate capture action later (Authorize only). |
| Order Status | Controls the ability to override WooCommerce’s default order status handling by automatically updating to a status of the clients choosing. |
| Order Transaction Descriptor |
Use the test card numbers below to verify that your integration was set up properly. For testing, you can use any cardholder name, any expiry date in the future, and any CVN security code.
For a full list of test cards, see our Test Cards article.
Now that you’ve successfully installed the plugin and tested to see if it was installed properly, you’re all set to go live in the Production environment.
To do this, you’ll need to connect your integration with the gateway.
This section contains information on payment solutions such card management, and order management.
All card data is tokenized using our tokenization service.
Registered customers can save their card information by selecting the Save to account checkbox in the checkout form. The WooCommerce plugin securely stores card data with us and receives a token representation of the card, which is stored in the WooCommerce vault, with no increased PCI compliance requirements.
Detailed information relating to the transaction outcome is available in the Orders section for WooCommerce.
Merchants who use “Authorize only” at checkout will authorize the funds on the customer's card, but the transaction won't be placed in the settlement file until We capture it.
The amount of time the funds can remain ring-fenced on the customer's card may vary between different Issuers and Acquirers. Card brands like Visa and Mastercard have their own rules around how long transactions can wait to be captured.
Once an order is successfully settled with your Acquirer, you can refund the customer for 0% to 115% of the original order value. To do this, you must do a Refund in WooCommerce.
| During a Capture or Authorize payment action, this value will be passed along as the transaction-specific descriptor listed on the customer's bank account. |
| Enable Gift Cards | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Gift Card Title | Description of the payment method displayed to the customer at checkout, e.g.,"Gift Card." The title will also be recorded in WooCommerce to indicate how the transaction was processed. |
| Gift Card Description | Description of the checkout experience the user sees during checkout |
| App ID | The App ID and App Key are used to control interchange optimization (Level II and III). |
| App Key | See description for App ID. |