Connect Heartland Retail

A step-by-step guide with pictures, from the Speakvora agent's own Connect tab.

Short answer: This connects your own Heartland (Global Payments) account to your Speakvora agent. Then a customer can text where is order 1234 and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Heartland (Global Payments). Only.

Every key, number and name in the pictures is a made-up example. Nothing here asks you to share a real key with anyone but the app on your own computer.

This connects your own Heartland (Global Payments) account to your Speakvora agent. Then a customer can text *where is order 1234* and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Heartland (Global Payments). Only the status word and the order number are ever texted back, never names, prices, items or addresses.

TIP: You need about 15 minutes, a computer, and the sign-in for your Heartland (Global Payments) account (the owner or a manager). You can't break anything: if a step does not work, nothing has changed and you can just try again. The keys and screens below are made-up examples.

NOTE: This guide was written from Heartland (Global Payments)'s public developer documentation (the addresses and sign-in style were read there) and has not been tried yet on a live Heartland (Global Payments) account. If a screen looks different from what is described, press Connect, then Download report, and send it to support. We fix it for everyone.

Who this is for: fashion gifts hobby stores. How Heartland (Global Payments) gives access: You create the key yourself in your own account; no approval is needed. What it costs you: Cost of API access is not stated in the developer docs; tokens are generated in your own account.

Part 1. Get your key from Heartland (Global Payments)

Do this on your computer, in a new browser tab, signed in to Heartland (Global Payments).

  1. Sign in to Heartland Retail as the owner or an administrator.
  2. Click your name in the top-right corner and choose My Account.
  3. Open the API Tokens tab (shown as API).
  4. Click Generate New Token.
  5. Type Speakvora in the Description box and click Generate Token.
  6. Copy the token straight away, it is shown only once, then click Done.
  7. Paste the token and your shop address (the part before .retail.heartland.us) into Speakvora.

WARNING: If Heartland (Global Payments) asks which permissions to give, tick only the read-only ones: Sales tickets: view (sales.ticket.read), Use a user whose role can only view tickets. Never give write or admin access.

TIP: To copy the key, click inside the box that shows it, press Command + C on a Mac or Ctrl + C on Windows (or right-click and choose Copy). Nothing will look different. It is now in your clipboard, ready to paste. Keep it private: anyone who has it can read your orders.

Part 2. Open the Connect tab in your agent

  1. Open your agent's dashboard (the page you open from the Start Speakvora Agent file).
  2. Press Connect in the menu. On a phone the menu is the bar along the top; slide it sideways if you do not see Connect.
  3. Step 1: press Connect (1)

  4. Under Your apps type Heartland (Global Payments) in the box that says Find an app (1), or scroll down the list.
  5. Step 2: the Find an app box (1)

  6. Press Heartland Retail. A card slides up. (If you only see apps for your own kind of business, that is on purpose: your agent only shows the systems that make sense for it.)
  7. Step 3: an app's card. The Full Guide button (1) opens this page.

Part 3. Paste it in

2 boxes to fill in. Click inside a box, press Command + V on a Mac or Ctrl + V on Windows, then move to the next:

  1. Your Heartland Retail address. The first part of the web address you sign in to, for example your-shop in your-shop.retail.heartland.us.
  2. API token (secret: it stays on this computer and is never shown again, only the last few characters). My Account > API Tokens > Generate New Token. It is shown only once, so copy it right away.
  3. Part 3: each numbered box is one thing to paste. These are made-up examples.

TIP: Pasted by mistake into the wrong box? Click the box, press Command + A (Ctrl + A on Windows) to select all, then paste again.

Part 4. Test it

  1. Press the orange Save and test button.
  2. Heartland (Global Payments) is asked for one harmless record, just to prove the key works. Nothing is changed in Heartland (Global Payments).
  3. Part 4: the green message under the buttons means it worked (1)

YOU SHOULD SEE: green words starting with Connected.

WARNING: Red words mean it did not work yet. Read them, then see If something is wrong below. Nothing bad happened.

What happens next

  • A customer texts something like where is order 1234. The agent answers *Your order 1234 is preparing.* (the status word from Heartland (Global Payments)), or *I could not find that order. A team member will check and reply.*
  • Each person can ask five times an hour. If Heartland (Global Payments) is down, the conversation carries on and the problem is written to Activity.
  • Mode: the agent asks Heartland (Global Payments) when a customer asks.

If something is wrong

  • It says the key was refused (401 or 403): copy the key again from Heartland (Global Payments). Make sure there is no space before or after it, and that it is a live key for the right shop or location.
  • It cannot find an order (404): the number is not in Heartland (Global Payments), or Heartland (Global Payments) uses a longer number than the one on the receipt.
  • It says too many requests (429): wait a minute and press Save and test again.
  • Heartland (Global Payments) says you need a plan or approval: The token acts with the permissions of the user who created it, so create it under a user with a view-only role. Tickets are looked up by Heartland's internal ticket id; the ticket status values are incomplete, complete and void.
  • Still stuck? Press Connect, then Download report, and email it to support. It never contains keys or customer messages.

Heartland (Global Payments)'s own instructions: https://dev.retail.heartland.us/

All help guides · Every agent feature · AI receptionist by industry

Questions

What if this happens: It says the key was refused (401 or 403)?

copy the key again from Heartland (Global Payments). Make sure there is no space before or after it, and that it is a live key for the right shop or location.

What if this happens: It cannot find an order (404)?

the number is not in Heartland (Global Payments), or Heartland (Global Payments) uses a longer number than the one on the receipt.

What if this happens: It says too many requests (429)?

wait a minute and press Save and test again.

What if this happens: Heartland (Global Payments) says you need a plan or approval?

The token acts with the permissions of the user who created it, so create it under a user with a view-only role. Tickets are looked up by Heartland's internal ticket id; the ticket status values are incomplete, complete and void.

What if this happens: Still stuck??

Press Connect, then Download report, and email it to support. It never contains keys or customer messages.