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

Zai Pay I Ds API

The PayIDs API from Zai — 3 operation(s) for payids.

Zai Pay I Ds API is one of 26 APIs that Zai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.2.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.

3 operations 3 paths 12 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.12-external
Base URL
https://secure.api.promisepay.com
Resource Areas
1

Paths & Operations 3

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

PayIDs 3
POST
/virtual_accounts/{id}/pay_ids
Register PayID
registerPayID 1 param body → 202400401403404409500
PATCH
/pay_ids/{id}/status
Update PayID Status
updatePayIdStatus 1 param body → 202400401403404409500
GET
/pay_ids/{id}
Retrieve a PayID
getPayID 1 param → 200400401403404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are pay_id (8 properties), pay_id_request (3 properties), deregister_pay_id (3 properties), inline_response_403_va (1 property). Each schema is shown below with its type and property counts.

inline_response_404_pay_id
object
1 property
inline_response_500
object
1 property
deregister_pay_id
object
3 properties
virtual_account_not_found
object
1 property
inline_response_403_pay_id
object
1 property
pay_id_request
object
3 properties 3 required
inline_response_400_1
object
1 property
inline_response_403_va
object
1 property
inline_response_409_1
object
1 property
inline_response_401
object
1 property
pay_id
object
8 properties
inline_response_400
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-payids-api-openapi.yml Raw ↑

Other APIs Zai publishes across the network.

Zai Addresses API
Zai Authentication API
Zai Bank Accounts API
Zai Batch Transactions API
Zai BPay Accounts API
Zai Callbacks API
Zai Card Accounts API
Zai Charges API
Zai Companies API
Zai Direct Debit Authorities API
Zai Disbursements API
Zai Fees API
Where this information came from

This is an independent, third-party profile of Zai Pay I Ds 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.