Paystone

Paystone is a Canadian payment processing and customer-engagement company headquartered in London, Ontario, positioning itself as one of the country's largest bank-independent payment processors. It sells card-present terminals, online checkout and hosted payment pages, virtual terminals, invoicing, and recurring billing to Canadian small and mid-sized businesses, and layers loyalty, gift-card, and reputation-marketing products on top of the payment rails. Paystone owns DataCandy, a long-standing Canadian gift-card and loyalty platform, and it is DataCandy that carries Paystone's public, self-serve, documented API surface: a live API Platform (Hydra/JSON-LD) REST API at api.paystone.com covering merchants, clients, contacts, gift/loyalty/ prepaid/promo account types, transactions, member and balance portals, and webhooks, authenticated with JWT bearer tokens and documented through an interactive Swagger UI. Paystone's core card-acquiring and payment-gateway processing is delivered as a merchant product rather than a publicly self-serve developer API, so the honest developer story here is the DataCandy gift-and-loyalty platform API, not a public payments/acquiring API.

Paystone publishes 14 APIs on the APIs.io network, including Balance Portal API, Client Management API, Contact API, and 11 more. Tagged areas include Payments, Canada, Payment Processing, Acquiring, and Gift Cards.

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

Paystone’s developer surface includes authentication, documentation, API reference, pricing, engineering blog, signup flow, and 20 more developer resources.

🌐 Visit website 📡 Source on GitHub

45.2/100 developing ▬ flat Agent 30/100 agent ready saas Full breakdown ↓
scored 2026-09-08 · rubric v0.20.0

1 APIs

Payments Canada Payment Processing Acquiring Gift Cards Loyalty Subscription Billing Merchant Services

Kin Score

Kin Score How this is scored →
scored 2026-09-08 · rubric v0.20.0

Composite quality — 45.2/100 · developing

Contract Quality 12.1 / 19

Developer Ergonomics 7.1 / 15

Access Clarity 6.7 / 15

Operational Transparency 1.8 / 10

Contract Governance 0.4 / 9

Discoverability 5.7 / 8

Regulatory Posture 5.9 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 30/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 0 / 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

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

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.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% 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/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/paystone: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

APIs 14

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

Paystone Balance Portal API

The Balance Portal API from Paystone — 1 operation(s) for balance portal.

Paystone Client Management API

The Client Management API from Paystone — 3 operation(s) for client management.

Paystone Contact API

Resource 'Contact' operations.

Paystone Gift Account Type API

The Gift Account Type API from Paystone — 2 operation(s) for gift account type.

Paystone Item API

Resource 'Item' operations.

Paystone Loyalty Account Type API

The Loyalty Account Type API from Paystone — 2 operation(s) for loyalty account type.

Paystone Loyalty Transaction API

The Loyalty Transaction API from Paystone — 2 operation(s) for loyalty transaction.

Paystone Member Portal API

The Member Portal API from Paystone — 1 operation(s) for member portal.

Paystone Merchant Management API

The Merchant Management API from Paystone — 5 operation(s) for merchant management.

Paystone Prepaid Transaction API

The Prepaid Transaction API from Paystone — 2 operation(s) for prepaid transaction.

Paystone Promo Account Type API

The Promo Account Type API from Paystone — 2 operation(s) for promo account type.

Paystone Reward API

Resource 'Reward' operations.

Paystone User Management API

The User Management API from Paystone — 2 operation(s) for user management.

Paystone Webhook Management API

The Webhook Management API from Paystone — 2 operation(s) for webhook management.

Scroll for all 14

Event Specifications 1

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

Paystone Datacandy Webhooks

ASYNCAPI

Security Posture 2

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

Paystone Authentication

http · 1 scheme

SECURITY

Paystone Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

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

Paystone Agentic Access

38 operations · 11 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

DeveloperPortal

DeveloperPortal

Login

SignUp

SignUp

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

X-MCPServerCandidate

X-MCPServerCandidate

AgentSkill

AgentSkill

LLMsTxt

LLMsTxt

Design & Contract 6

Pagination, idempotency, versioning, errors, and events

Conventions

ErrorCatalog

Lifecycle

Conformance

DataModel

Webhooks

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

Access & Security 2

Authentication, authorization, and security posture

Authentication

Authentication

DomainSecurity

DomainSecurity

Operate 2

Status, limits, changes, and where to get help

HelpCenter

HelpCenter

StatusPage

StatusPage

Commercial 3

Pricing, plans, and the legal terms of use

Pricing

Pricing

TermsOfService

TermsOfService

PrivacyPolicy

PrivacyPolicy

Company 2

The organization behind the API

Website

Website

Blog

Blog

Other 1

Properties that don't map to a standard resource type

Overlay

Overlay

Source (apis.yml)

aid: paystone
url: https://raw.githubusercontent.com/api-evangelist/paystone/refs/heads/main/apis.yml
name: Paystone
kind: company
description: 'Paystone is a Canadian payment processing and customer-engagement company headquartered in London, Ontario,
  positioning itself as one of the country''s largest bank-independent payment processors. It sells card-present terminals,
  online checkout and hosted payment pages, virtual terminals, invoicing, and recurring billing to Canadian small and mid-sized
  businesses, and layers loyalty, gift-card, and reputation-marketing products on top of the payment rails. Paystone owns
  DataCandy, a long-standing Canadian gift-card and loyalty platform, and it is DataCandy that carries Paystone''s public,
  self-serve, documented API surface: a live API Platform (Hydra/JSON-LD) REST API at api.paystone.com covering merchants,
  clients, contacts, gift/loyalty/ prepaid/promo account types, transactions, member and balance portals, and webhooks, authenticated
  with JWT bearer tokens and documented through an interactive Swagger UI. Paystone''s core card-acquiring and payment-gateway
  processing is delivered as a merchant product rather than a publicly self-serve developer API, so the honest developer story
  here is the DataCandy gift-and-loyalty platform API, not a public payments/acquiring API.'
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - authentication
  - security
  generated: '2026-09-03'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- Payments
- Canada
- Payment Processing
- Acquiring
- Gift Cards
- Loyalty
- Subscription
- Billing
- Merchant Services
tags_raw:
- Payments
- Canada
- Payment Processing
- Acquiring
- Gift Cards
- Loyalty
- Subscriptions
- Billing
- Merchant Services
tags_original:
- Payments
- Canada
- Payment Processing
- Gift Cards
- Loyalty
created: '2026-07-24'
modified: '2026-07-24'
specificationVersion: '0.23'
apis:
- aid: paystone:paystone-balance-portal-api
  name: Paystone Balance Portal API
  description: The Balance Portal API from Paystone — 1 operation(s) for balance portal.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Balance Portal
  properties:
  - type: OpenAPI
    url: openapi/paystone-balance-portal-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-client-management-api
  name: Paystone Client Management API
  description: The Client Management API from Paystone — 3 operation(s) for client management.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Client Management
  properties:
  - type: OpenAPI
    url: openapi/paystone-client-management-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-contact-api
  name: Paystone Contact API
  description: Resource 'Contact' operations.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Contact
  properties:
  - type: OpenAPI
    url: openapi/paystone-contact-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-gift-account-type-api
  name: Paystone Gift Account Type API
  description: The Gift Account Type API from Paystone — 2 operation(s) for gift account type.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Gift Account Type
  properties:
  - type: OpenAPI
    url: openapi/paystone-gift-account-type-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-item-api
  name: Paystone Item API
  description: Resource 'Item' operations.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Item
  properties:
  - type: OpenAPI
    url: openapi/paystone-item-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-loyalty-account-type-api
  name: Paystone Loyalty Account Type API
  description: The Loyalty Account Type API from Paystone — 2 operation(s) for loyalty account type.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Loyalty Account Type
  properties:
  - type: OpenAPI
    url: openapi/paystone-loyalty-account-type-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-loyalty-transaction-api
  name: Paystone Loyalty Transaction API
  description: The Loyalty Transaction API from Paystone — 2 operation(s) for loyalty transaction.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Loyalty Transaction
  properties:
  - type: OpenAPI
    url: openapi/paystone-loyalty-transaction-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-member-portal-api
  name: Paystone Member Portal API
  description: The Member Portal API from Paystone — 1 operation(s) for member portal.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Member Portal
  properties:
  - type: OpenAPI
    url: openapi/paystone-member-portal-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-merchant-management-api
  name: Paystone Merchant Management API
  description: The Merchant Management API from Paystone — 5 operation(s) for merchant management.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Merchant Management
  properties:
  - type: OpenAPI
    url: openapi/paystone-merchant-management-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-prepaid-transaction-api
  name: Paystone Prepaid Transaction API
  description: The Prepaid Transaction API from Paystone — 2 operation(s) for prepaid transaction.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Prepaid Transaction
  properties:
  - type: OpenAPI
    url: openapi/paystone-prepaid-transaction-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-promo-account-type-api
  name: Paystone Promo Account Type API
  description: The Promo Account Type API from Paystone — 2 operation(s) for promo account type.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Promo Account Type
  properties:
  - type: OpenAPI
    url: openapi/paystone-promo-account-type-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-reward-api
  name: Paystone Reward API
  description: Resource 'Reward' operations.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Reward
  properties:
  - type: OpenAPI
    url: openapi/paystone-reward-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-user-management-api
  name: Paystone User Management API
  description: The User Management API from Paystone — 2 operation(s) for user management.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - User Management
  properties:
  - type: OpenAPI
    url: openapi/paystone-user-management-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
- aid: paystone:paystone-webhook-management-api
  name: Paystone Webhook Management API
  description: The Webhook Management API from Paystone — 2 operation(s) for webhook management.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Webhook Management
  properties:
  - type: OpenAPI
    url: openapi/paystone-webhook-management-api-openapi.yml
  - type: Documentation
    url: https://api.paystone.com/docs
  - type: APIReference
    url: https://api.paystone.com/docs
common:
- type: Authentication
  url: authentication/paystone-authentication.yml
- type: AgenticAccess
  url: agentic-access/paystone-agentic-access.yml
- type: DomainSecurity
  url: security/paystone-domain-security.yml
- type: Conventions
  url: conventions/paystone-conventions.yml
- type: ErrorCatalog
  url: errors/paystone-problem-types.yml
- type: Lifecycle
  url: lifecycle/paystone-lifecycle.yml
- type: Conformance
  url: conformance/paystone-conformance.yml
- type: DataModel
  url: data-model/paystone-data-model.yml
- type: X-MCPServerCandidate
  url: mcp/paystone-mcp.yml
  note: 'Renamed from MCPServer 2026-09-03 (roadmap#247): the manifest self-describes as status: candidate — a tool list derived
    from the published API contracts, not an existing server. The scorer already read the manifest and reported mcp_server
    correctly; the MCPServer type was crediting the artifact-type surfaces with a server that does not exist.'
- type: Webhooks
  url: asyncapi/paystone-datacandy-webhooks.yml
- type: AgentSkill
  url: skills/_index.yml
- type: LLMsTxt
  url: llms/paystone-llms.txt
- type: Overlay
  url: overlays/paystone-datacandy-overlay.yaml
- type: Website
  url: https://www.paystone.com/
- type: DeveloperPortal
  url: https://api.paystone.com/docs
- type: Documentation
  url: https://api.paystone.com/docs
- type: APIReference
  url: https://api.paystone.com/docs
- type: Pricing
  url: https://www.paystone.com/pricing
- type: Blog
  url: https://www.paystone.com/resources
- type: HelpCenter
  url: https://help.paystone.com/
- type: StatusPage
  url: https://status.paystone.com
- type: Login
  url: https://hub.paystone.com/login
- type: SignUp
  url: https://start.paystone.com/sign-up
- type: TermsOfService
  url: https://www.paystone.com/legal
- type: PrivacyPolicy
  url: https://www.paystone.com/legal
- type: GitHubOrganization
  url: https://github.com/Paystone
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/paystone"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/paystone/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/paystone/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.