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.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- 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.19'
apis:
- aid: paystone:paystone-datacandy-api
  name: Paystone DataCandy API
  description: >-
    The public, documented REST API for Paystone's DataCandy gift-card and
    loyalty platform, built on API Platform (Hydra/JSON-LD) and served from
    api.paystone.com. It exposes 28 documented paths across 14 resource groups
    — client and merchant management, contacts, gift/loyalty/prepaid/promo
    account types, loyalty and prepaid transactions, rewards and items, member
    and balance portals, user management, and webhook management. All endpoints
    require a JWT bearer token. An interactive Swagger UI is published at
    api.paystone.com/docs and a machine-readable OpenAPI 3.1 export is
    downloadable from the same host.
  humanURL: https://api.paystone.com/docs
  baseURL: https://api.paystone.com
  tags:
  - Gift Cards
  - Loyalty
  - Prepaid
  - Merchant Management
  - Webhooks
  properties:
  - type: OpenAPI
    url: openapi/paystone-datacandy-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: MCPServer
  url: mcp/paystone-mcp.yml
- 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