How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Paystone Client Management API

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

Paystone Client Management API is one of 14 APIs that Paystone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Client Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 26.7.1.0-d9107e6.

Requests are made against a single base URL, /.

5 operations 3 paths 13 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.7.1.0-d9107e6
Base URL
https://api.paystone.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Paystone Client Management 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 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Client Management 5
GET
/v1/clients
Retrieve all clients in the portfolio.
api_v1clients_get_collection 2 params → 200403401
POST
/v1/clients
Create a new client.
api_v1clients_post body → 201400422403401
GET
/v1/clients/{id}
Retrieve a client by ID.
api_v1clients_id_get 1 param → 200403404401
PATCH
/v1/clients/{id}
Update an existing client.
api_v1clients_id_patch 1 param body → 200400422403404401
POST
/v1/clients/{id}/complete
Complete client onboarding.
api_v1clients_idcomplete_post 1 param body → 201400422403200401404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Client-client.write (20 properties), CompanyInfo-client.write (11 properties), Client-client.patch.jsonMergePatch (7 properties), ConstraintViolation (6 properties). Each schema is shown below with its type and property counts.

Error
object
A representation of common errors.
5 properties
ConstraintViolation.jsonld
Unprocessable entity
Client-client.write
object
20 properties 6 required
CompanyInfo-client.write
object
11 properties 11 required
HydraCollectionBaseSchema
HydraCollectionBaseSchemaNoPagination
object
2 properties
Client.jsonld-client.complete.read
ConstraintViolation
object
Unprocessable entity
6 properties
Client.jsonld-client.read
HydraItemBaseSchema
object
3 properties 2 required
Client-client.patch.jsonMergePatch
object
7 properties
Error.jsonld
A representation of common errors.
Client-client.complete
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paystone-client-management-api-openapi.yml Raw ↑

Other APIs Paystone publishes across the network.

Paystone Balance Portal API
Paystone Contact API
Paystone Gift Account Type API
Paystone Item API
Paystone Loyalty Account Type API
Paystone Loyalty Transaction API
Paystone Member Portal API
Paystone Merchant Management API
Paystone Prepaid Transaction API
Paystone Promo Account Type API
Paystone Reward API
Paystone User Management API
Where this information came from

This is an independent, third-party profile of Paystone Client Management 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.