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.
Paystone DataCandy API is published by Paystone on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Gift Cards, Loyalty, Prepaid, Merchant Management, and Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
38 operations
across 28 paths,
organized into 14 resource areas,
and defines 81 schemas.
It is described by OpenAPI 3.1.0, at version 26.7.1.0-d9107e6.
Requests are made against a single base URL, /.
38 operations28 paths81 schemas27 GET5 PATCH5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
26.7.1.0-d9107e6
Base URL
https://api.paystone.com
Authentication
HTTP Bearer
Resource Areas
14
Authentication & Security 1
Paystone DataCandy API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (JWT).
By default, every request must be authenticated.
JWT — Enter your JWT token (without the "Bearer" prefix).
Paths & Operations 38
Across 28 paths, the API surfaces 38 operations — 27 GET, 5 PATCH, 5 POST, 1 PUT. They span 14 resource areas, including Balance Portal, Client Management, Contact, Gift Account Type, Item, Loyalty Account Type, Loyalty Transaction, Member Portal, and 6 more. Each is listed below with its method, path, parameters, and response codes.
Balance Portal 1
GET
/v1/clients/{accessKey}/portals/balance
Retrieve balance portal configurations for a client.
The contract defines 81 schemas that model the data the API accepts and returns. The most detailed are Client.Merchant.jsonld (53 properties), Banner.jsonld (26 properties), Transaction.jsonld (21 properties), Client-client.write (20 properties). Each schema is shown below with its type and property counts.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Paystone DataCandy API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
