Zai Virtual Accounts and PayIDs API
Create and manage Virtual Accounts and PayIDs on the New Payments Platform (NPP), letting platforms receive real-time account-to-account pay-ins to uniquely addressable virtual accounts. OpenAPI 3.0.0, version 0.12-external, 8 documented paths on the assemblypay.com host.
Zai Virtual Accounts and PayIDs API is one of 4 APIs that Zai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PayID, Virtual Accounts, NPP, and Real-Time Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 9 operations across 8 paths, organized into 2 resource areas, and defines 28 schemas. It is described by OpenAPI 3.0.0, at version 0.12-external.
Requests are made against 2 base URLs: https://sandbox.au-0000.api.assemblypay.com, https://au-0000.api.assemblypay.com.
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 9
Across 8 paths, the API surfaces 9 operations — 3 GET, 4 PATCH, 2 POST. They span 2 resource areas: Virtual Accounts, PayIDs. Each is listed below with its method, path, parameters, and response codes.
Schemas 28
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are virtual_account (14 properties), pay_id (8 properties), deregister_pay_id (3 properties), pay_id_request (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.