Helcim website screenshot

Helcim

Helcim is a Calgary, Canada based payment processor and merchant services provider serving small and medium-sized businesses across Canada and the United States with interchange-plus pricing and no monthly fees. Beyond its merchant dashboard, Smart Terminal hardware, and online store, Helcim ships a genuine developer surface: the versioned Helcim API (v2) for taking card and ACH payments, managing customers, cards, bank accounts and pre-authorized debits (PADs), issuing invoices, settling card and ACH batches, and driving in-person Card Terminal devices, alongside HelcimPay.js hosted checkout and connected-account webhooks. Authentication is a permissioned API access token passed in an api-token header, and the public developer portal publishes a downloadable OpenAPI 3.0 definition. In Canada's small, concentrated payments market, Helcim is one of the API-native SMB money-movement fintechs building above the incumbent acquiring and Interac rails.

Helcim publishes 6 APIs on the APIs.io network, including Payment API, ACH Payment API, Customer API, and 3 more. Tagged areas include Payments, Canada, Payment Gateway, Payment Processing, and Acquiring.

The Helcim catalog on APIs.io includes 1 event-driven AsyncAPI specification.

Helcim’s developer surface includes authentication, documentation, API reference, getting-started guide, sandbox, changelog, pricing, and 33 more developer resources.

🌐 Visit website 📡 Source on GitHub
57.4/100 strong ▬ flat Agent 58/100 agent native Full breakdown ↓
scored 2026-08-17 · rubric v0.11.0
6 APIs 1 MCP Servers
PaymentsCanadaPayment GatewayPayment ProcessingAcquiringMerchant ServicesACHInvoicingCard TerminalSmall Business

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-17 · rubric v0.11.0
Composite quality — 57.4/100 · strong
Contract Quality 12.1 / 21
Developer Ergonomics 11.0 / 17
Commercial Clarity 8.9 / 17
Operational Transparency 9.3 / 11
Governance 2.1 / 10
Discoverability 6.9 / 9
Regulatory Posture 7.0 / 15
Agent readiness — 58/100 · agent native
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 12 / 12
Machine-Readable Auth 10 / 10
Idempotency 9 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 5 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.
The six quality facets above are damped to 85 points between them, because the conditional facet above carries the other 15. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 85% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/helcim: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 6

Individual APIs this provider publishes, each with its own machine-readable definition.

Helcim Payment API

Card payment processing endpoints covering the full transaction lifecycle — Purchase, Preauthorization, Capture, Verify, Refund, Reverse, and Withdraw — under the Helcim API v2....

Helcim ACH Payment API

Bank-to-bank (ACH / pre-authorized debit) money movement — withdraw, refund, void, cancel, retrieve ACH transactions, and list and settle ACH batches under the Helcim API v2.

Helcim Customer API

Create, retrieve, and update customers and manage their saved payment instruments — stored cards, bank accounts, and pre-authorized debit agreements (PADs) — under the Helcim AP...

Helcim Invoice API

Create, retrieve, and update invoices under the Helcim API v2, supporting billing and payment collection workflows.

Helcim Card Transaction & Batch API

Read access to processed card transactions and card batches, including listing and retrieving transactions and batches and settling a card batch, under the Helcim API v2.

Helcim Card Terminal & Device API

In-person payments through Helcim Smart Terminal hardware — list card terminals and devices, ping a device, and start purchase or refund transactions on a device — under the Hel...

Postman Collections 1

Ready-to-run Postman collections for exercising this provider's APIs.

The Helcim API

POSTMAN

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

The Helcim API

OPEN COLLECTION

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

helcim-mcp.yml

MCP SERVER

Rate Limits 1

Documented rate limits and quota policies.

Helcim Rate Limits

3 limits

RATE LIMITS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Helcim Webhooks

ASYNCAPI

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Helcim Authentication

apiKey · 1 scheme

SECURITY

Helcim Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Helcim Agentic Access

48 operations · 25 acting

48 operations · 25 acting

AGENTIC

Resources

Get Started 6

Portal, sign-up, and the first successful call

DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted
 DeveloperPortal
DeveloperPortal
 Sandbox
Sandbox
 SignUp
SignUp
 Login
Login

Documentation 2

Reference material describing how the API behaves

Documentation
Documentation
 APIReference
APIReference

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess
 MCPServer
MCPServer
 LLMsTxt
LLMsTxt
 AgentSkill
AgentSkill

Design & Contract 9

Pagination, idempotency, versioning, errors, and events

Webhooks
Webhooks
 Idempotency
Idempotency
 Conventions
Conventions
 ErrorCatalog
ErrorCatalog
 Lifecycle
Lifecycle
 Components
Components
 DataModel
DataModel
 Conformance
Conformance
 Webhooks
Webhooks

Scroll for all 9

Build 5

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace
PostmanWorkspace
 GitHubOrganization
GitHubOrganization
 DeclineCodes
DeclineCodes
 Packages
Packages
 ToolCrosswalk
ToolCrosswalk

Access & Security 4

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication
 Authentication
Authentication
 Compliance
Compliance

Operate 5

Status, limits, changes, and where to get help

StatusPage
StatusPage
 RateLimits
RateLimits
 Deprecation
Deprecation
 ChangeLog
ChangeLog
 Support
Support

Commercial 3

Pricing, plans, and the legal terms of use

Pricing
Pricing
 TermsOfService
TermsOfService
 PrivacyPolicy
PrivacyPolicy

Company 1

The organization behind the API

Website
Website

Other 1

Properties that don't map to a standard resource type

Overlay
Overlay

Source (apis.yml)

apis.yml Raw ↑ 
aid: helcim
url: https://raw.githubusercontent.com/api-evangelist/helcim/refs/heads/main/apis.yml
name: Helcim
kind: company
description: 'Helcim is a Calgary, Canada based payment processor and merchant services provider serving small and medium-sized
  businesses across Canada and the United States with interchange-plus pricing and no monthly fees. Beyond its merchant dashboard,
  Smart Terminal hardware, and online store, Helcim ships a genuine developer surface: the versioned Helcim API (v2) for taking
  card and ACH payments, managing customers, cards, bank accounts and pre-authorized debits (PADs), issuing invoices, settling
  card and ACH batches, and driving in-person Card Terminal devices, alongside HelcimPay.js hosted checkout and connected-account
  webhooks. Authentication is a permissioned API access token passed in an api-token header, and the public developer portal
  publishes a downloadable OpenAPI 3.0 definition. In Canada''s small, concentrated payments market, Helcim is one of the
  API-native SMB money-movement fintechs building above the incumbent acquiring and Interac rails.'
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- Payments
- Canada
- Payment Gateway
- Payment Processing
- Acquiring
- Merchant Services
- ACH
- Invoicing
- Card Terminal
- Small Business
created: '2026-07-24'
modified: '2026-07-24'
specificationVersion: '0.19'
apis:
- aid: helcim:helcim-payment-api
  name: Helcim Payment API
  description: Card payment processing endpoints covering the full transaction lifecycle — Purchase, Preauthorization, Capture,
    Verify, Refund, Reverse, and Withdraw — under the Helcim API v2. Includes the General connection-test endpoint for validating
    an API access token.
  humanURL: https://devdocs.helcim.com/reference
  baseURL: https://api.helcim.com/v2
  tags:
  - Payment
  - Payments
  - Cards
  properties:
  - type: OpenAPI
    url: openapi/helcim-api.json
  - type: Documentation
    url: https://devdocs.helcim.com/docs/overview-of-helcim-api
  - type: APIReference
    url: https://devdocs.helcim.com/reference
- aid: helcim:helcim-ach-payment-api
  name: Helcim ACH Payment API
  description: Bank-to-bank (ACH / pre-authorized debit) money movement — withdraw, refund, void, cancel, retrieve ACH transactions,
    and list and settle ACH batches under the Helcim API v2.
  humanURL: https://devdocs.helcim.com/reference
  baseURL: https://api.helcim.com/v2
  tags:
  - ACH Payment
  - ACH
  - Bank Payments
  properties:
  - type: OpenAPI
    url: openapi/helcim-api.json
  - type: Documentation
    url: https://devdocs.helcim.com/docs/overview-of-helcim-api
  - type: APIReference
    url: https://devdocs.helcim.com/reference
- aid: helcim:helcim-customer-api
  name: Helcim Customer API
  description: Create, retrieve, and update customers and manage their saved payment instruments — stored cards, bank accounts,
    and pre-authorized debit agreements (PADs) — under the Helcim API v2.
  humanURL: https://devdocs.helcim.com/reference
  baseURL: https://api.helcim.com/v2
  tags:
  - Customer
  - Vault
  - Cards
  properties:
  - type: OpenAPI
    url: openapi/helcim-api.json
  - type: Documentation
    url: https://devdocs.helcim.com/docs/overview-of-helcim-api
  - type: APIReference
    url: https://devdocs.helcim.com/reference
- aid: helcim:helcim-invoice-api
  name: Helcim Invoice API
  description: Create, retrieve, and update invoices under the Helcim API v2, supporting billing and payment collection workflows.
  humanURL: https://devdocs.helcim.com/reference
  baseURL: https://api.helcim.com/v2
  tags:
  - Invoice
  - Billing
  properties:
  - type: OpenAPI
    url: openapi/helcim-api.json
  - type: Documentation
    url: https://devdocs.helcim.com/docs/overview-of-helcim-api
  - type: APIReference
    url: https://devdocs.helcim.com/reference
- aid: helcim:helcim-card-transaction-batch-api
  name: Helcim Card Transaction & Batch API
  description: Read access to processed card transactions and card batches, including listing and retrieving transactions
    and batches and settling a card batch, under the Helcim API v2.
  humanURL: https://devdocs.helcim.com/reference
  baseURL: https://api.helcim.com/v2
  tags:
  - Card Transaction
  - Card Batch
  - Settlement
  properties:
  - type: OpenAPI
    url: openapi/helcim-api.json
  - type: Documentation
    url: https://devdocs.helcim.com/docs/overview-of-helcim-api
  - type: APIReference
    url: https://devdocs.helcim.com/reference
- aid: helcim:helcim-terminal-device-api
  name: Helcim Card Terminal & Device API
  description: In-person payments through Helcim Smart Terminal hardware — list card terminals and devices, ping a device,
    and start purchase or refund transactions on a device — under the Helcim API v2.
  humanURL: https://devdocs.helcim.com/reference
  baseURL: https://api.helcim.com/v2
  tags:
  - Card Terminal
  - Device
  - In Person
  properties:
  - type: OpenAPI
    url: openapi/helcim-api.json
  - type: Documentation
    url: https://devdocs.helcim.com/docs/overview-of-helcim-api
  - type: APIReference
    url: https://devdocs.helcim.com/reference
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/helcim/overview
- type: AgenticAccess
  url: agentic-access/helcim-agentic-access.yml
- type: DomainSecurity
  url: security/helcim-domain-security.yml
- type: Authentication
  url: authentication/helcim-authentication.yml
- type: Website
  url: https://www.helcim.com/
- type: DeveloperPortal
  url: https://devdocs.helcim.com/
- type: Documentation
  url: https://devdocs.helcim.com/docs
- type: APIReference
  url: https://devdocs.helcim.com/reference
- type: GettingStarted
  url: https://devdocs.helcim.com/docs/overview-of-helcim-api
- type: Authentication
  url: https://devdocs.helcim.com/docs/authentication-with-the-helcim-api-and-helcimpayjs
- type: Webhooks
  url: https://devdocs.helcim.com/docs/connected-account-webhooks
- type: GitHubOrganization
  url: https://github.com/helcim
- type: StatusPage
  url: https://status.helcim.com
- type: DeveloperPortal
  url: https://learn.helcim.com/api-developer-documentation
- type: Idempotency
  url: conventions/helcim-conventions.yml
- type: Conventions
  url: conventions/helcim-conventions.yml
- type: RateLimits
  url: rate-limits/helcim-rate-limits.yml
- type: ErrorCatalog
  url: errors/helcim-problem-types.yml
- type: DeclineCodes
  url: errors/helcim-decline-codes.yml
- type: Lifecycle
  url: lifecycle/helcim-lifecycle.yml
- type: Deprecation
  url: https://devdocs.helcim.com/docs/api-versions-and-deprecation
- type: Sandbox
  url: sandbox/helcim-sandbox.yml
- type: ChangeLog
  url: changelog/helcim-changelog.yml
- type: Components
  url: components/helcim-components.yml
- type: DataModel
  url: data-model/helcim-data-model.yml
- type: Conformance
  url: conformance/helcim-conformance.yml
- type: Compliance
  url: https://devdocs.helcim.com/docs/pci-compliance-scope
- type: Packages
  url: packages/helcim-packages.yml
- type: MCPServer
  url: mcp/helcim-mcp.yml
- type: ToolCrosswalk
  url: mcp/helcim-tool-crosswalk.yml
- type: LLMsTxt
  url: llms/helcim-llms.txt
- type: Overlay
  url: overlays/helcim-api-overlay.yaml
- type: AgentSkill
  url: skills/_index.yml
- type: Webhooks
  url: asyncapi/helcim-webhooks.yml
- type: Pricing
  url: https://www.helcim.com/pricing/
- type: SignUp
  url: https://hub.helcim.com/signup/register/
- type: Login
  url: https://hsso.helcim.com/login/
- type: TermsOfService
  url: https://legal.helcim.com/ca/terms-of-service/
- type: PrivacyPolicy
  url: https://legal.helcim.com/ca/privacy-policy/
- type: Support
  url: https://devdocs.helcim.com/docs/get-help
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com