Adopets payment-request API
Create and manage adoption payment requests
Adopets payment-request API is one of 3 APIs that Adopets publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include payment-request. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against 2 base URLs: https://service.api.dev.adopets.app, https://service.api.adopets.app.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Adopets payment-request API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (apiKeyAuth).
It accepts HTTP bearer tokens (JWT) (sessionBearer).
By default, every request must be authenticated.
apiKeyAuth— Organization API key issued by Adopets, sent on every request.sessionBearer— Per-session token (data.authorization) returned by system-auth/connect.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.
Create and manage adoption payment requests
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PaymentRequest (23 properties), PaymentRequestItem (11 properties), Envelope (5 properties), PaymentRequestCreate (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Adopets 2
Other APIs Adopets publishes across the network.