Paystone Balance Portal API
The Balance Portal API from Paystone — 1 operation(s) for balance portal.
Work with this as data
Every API 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 apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/paystone-balance-portal-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: DataCandy Balance Portal API
description: 'REST API for the DataCandy platform. Provides endpoints for managing merchants,
clients, contacts, account types, transactions, webhooks, and portal configuration.
All endpoints require a JWT bearer token unless stated otherwise.'
version: 26.7.1.0-d9107e6
servers:
- url: /
description: ''
security:
- JWT: {}
tags:
- name: Balance Portal
paths:
/v1/clients/{accessKey}/portals/balance:
get:
operationId: api_v1clients_accessKeyportalsbalance_get_collection
tags:
- Balance Portal
responses:
200:
description: List of balance portal configurations.
content:
application/ld+json:
schema:
type: object
description: BalancePortal.jsonld-balance_portal.read collection.
allOf:
- $ref: '#/components/schemas/HydraCollectionBaseSchema'
- type: object
required:
- hydra:member
properties:
hydra:member:
type: array
items:
$ref: '#/components/schemas/BalancePortal.jsonld-balance_portal.read'
403:
description: Forbidden — token does not have the required role.
content:
application/json:
schema:
type: object
properties:
code:
type: integer
example: 403
message:
type: string
example: Access Denied.
401:
description: Unauthorized — missing or invalid JWT token.
content:
application/json:
schema:
type: object
properties:
code:
type: integer
example: 401
message:
type: string
example: JWT Token not found
summary: Retrieve balance portal configurations for a client.
description: Retrieves the collection of BalancePortal resources.
parameters:
- name: accessKey
in: path
description: Unique access key identifying the client.
required: true
deprecated: false
schema:
type: string
style: simple
explode: false
example: abc123def456
security:
- JWT: {}
components:
schemas:
HydraCollectionBaseSchemaNoPagination:
type: object
properties:
hydra:totalItems:
type: integer
minimum: 0
hydra:search:
type: object
properties:
'@type':
type: string
hydra:template:
type: string
hydra:variableRepresentation:
type: string
hydra:mapping:
type: array
items:
type: object
properties:
'@type':
type: string
variable:
type: string
property:
type:
- string
- 'null'
required:
type: boolean
HydraCollectionBaseSchema:
allOf:
- $ref: '#/components/schemas/HydraCollectionBaseSchemaNoPagination'
- type: object
properties:
hydra:view:
type: object
properties:
'@id':
type: string
format: iri-reference
'@type':
type: string
hydra:first:
type: string
format: iri-reference
hydra:last:
type: string
format: iri-reference
hydra:previous:
type: string
format: iri-reference
hydra:next:
type: string
format: iri-reference
example:
'@id': string
'@type': string
hydra:first: string
hydra:last: string
hydra:previous: string
hydra:next: string
LocalizedString.jsonld-balance_portal.read:
type: object
properties:
en:
description: English value
type:
- string
- 'null'
fr:
description: French value
type:
- string
- 'null'
BalancePortal.jsonld-balance_portal.read:
allOf:
- $ref: '#/components/schemas/HydraItemBaseSchema'
- type: object
properties:
isActive:
description: Whether the balance portal is active
type:
- boolean
- 'null'
hasSecurityCode:
description: Whether security code (PIN) is required
type:
- boolean
- 'null'
isGiftcardOrderEnabled:
description: Whether gift card ordering is enabled
type:
- boolean
- 'null'
isOnlineGiftcardEnabled:
description: Whether online gifting portal is enabled
type:
- boolean
- 'null'
isOnlineGiftcardHomepageEnabled:
description: Whether online gift card is shown on homepage (only when online gifting portal is enabled)
type:
- boolean
- 'null'
isRegiftEnabled:
description: Whether regift functionality is enabled (only when online gifting portal is enabled)
type:
- boolean
- 'null'
balancePortalUrls:
anyOf:
- $ref: '#/components/schemas/LocalizedString.jsonld-balance_portal.read'
- type: 'null'
onlineGiftcardPortalUrls:
anyOf:
- $ref: '#/components/schemas/LocalizedString.jsonld-balance_portal.read'
- type: 'null'
displayName:
anyOf:
- $ref: '#/components/schemas/LocalizedString.jsonld-balance_portal.read'
- type: 'null'
termsConditionsUrl:
anyOf:
- $ref: '#/components/schemas/LocalizedString.jsonld-balance_portal.read'
- type: 'null'
privacyPolicyUrl:
anyOf:
- $ref: '#/components/schemas/LocalizedString.jsonld-balance_portal.read'
- type: 'null'
HydraItemBaseSchema:
type: object
properties:
'@context':
oneOf:
- type: string
- type: object
properties:
'@vocab':
type: string
hydra:
type: string
enum:
- http://www.w3.org/ns/hydra/core#
required:
- '@vocab'
- hydra
additionalProperties: true
'@id':
type: string
'@type':
type: string
required:
- '@id'
- '@type'
securitySchemes:
JWT:
type: http
description: Enter your JWT token (without the "Bearer" prefix).
scheme: bearer
bearerFormat: JWT