Zai Asynchronous API
Asynchronous API for submitting long-running operations and retrieving their results without blocking, complementing the synchronous Assembly API. OpenAPI 3.0.0, version 1.0.0, 3 documented paths, supporting OAuth2 client-credentials and basic authentication.
Zai Asynchronous API is one of 4 APIs that Zai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Async, Batch, and Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 3 operations across 3 paths, organized into 2 resource areas, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against 3 base URLs: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-async-api/1.0.0, https://test.tnq.api.assemblypay.com/, https://tnq.api.assemblypay.com/.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Zai Asynchronous API declares
2 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow.
By default, every request must be authenticated.
oAuth2ClientCredentials— Please refer to Authentication section within https://developer.assemblypayments.com/referenceauthentication
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. They span 2 resource areas: Item Actions, Requests. Each is listed below with its method, path, parameters, and response codes.
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are item (46 properties), make_payment_requestBody (5 properties), status (4 properties), callback (3 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 Zai 3
Other APIs Zai publishes across the network.