Zai

Zai (hellozai.com, formerly Assembly Payments / Assembly) is an Australian payments and Payments-as-a-Service provider headquartered in Melbourne. Zai gives platforms, marketplaces and vertical software companies a programmable way to onboard users, hold funds in managed wallet accounts, collect pay-ins (card, direct debit, BPAY, PayID), and disburse pay-outs across many parties in a single transaction flow. It is API-first: the Assembly API exposes wallet accounts, users, items, transactions, bank accounts, card accounts, fees, callbacks and batch disbursements, layered with Australia's New Payments Platform rails through dedicated Virtual Accounts / PayID and PayTo APIs, plus an Asynchronous API for long-running operations. Authentication is OAuth2 client-credentials (bearer tokens on PayTo), with a Live and Pre-live (sandbox) environment, webhooks with signature verification, and a developer dashboard. Positioned as the embedded-payments and marketplace-money-movement layer for the Australian market and platforms operating there.

Zai publishes 26 API contracts indexed on the APIs.io network, including Addresses API, Authentication API, Bank Accounts API, and 23 more. Tagged areas include Payments, Australia, Payment Gateway, Payment Processing, and Marketplace Payments.

The Zai catalog on APIs.io includes 1 event-driven AsyncAPI specification and 1 Spectral governance ruleset.

Zai’s developer surface includes engineering blog, authentication, documentation, API reference, getting-started guide, pricing, support, and 38 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

64.0/100 strong ▬ flat Agent 47/100 agent ready Front door AI 1/6 silent Heartbeat 38/100 slowing saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessPaid

4 published contracts 3 Agent Skills

Payments Australia Payment Gateway Payment Processing Marketplace PaymentsPayments-as-a-ServiceReal-Time Payments Account-to-Account Open Banking PayTo PayID New Payments Platform Direct Debit Digital Wallet Payouts

What this lets a business do 2

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Payments & Card Management

BC-1340

ChargesItem ActionsItemsPayTo Agreements

PATCH /items/{id}/make_payment PATCH /items/{id}/authorize_payment PATCH /items/{id}/capture_payment PATCH /items/{id}/void_payment

Developer Platform & API Ecosystem Management

BC-4270

Callbacks

GET /callbacks/{id} GET /callbacks/{id}/responses GET /callbacks POST /callbacks

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 64.0/100 · strong

Contract Quality 12.1 / 19

Developer Ergonomics 10.3 / 15

Access Clarity 11.8 / 15

Operational Transparency 2.6 / 10

Contract Governance 2.9 / 9

Discoverability 5.9 / 8

Regulatory Posture 7.0 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 47/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/zai/"><img src="https://apis.io/badge/zai/card.svg" alt="Zai on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
Protected Resource Metadata +5 pts — a served /.well-known/oauth-protected-resource carrying `resource` (documented), and naming its authorization_servers (verified)

4 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Operational Transparency scores 26.3 — up to +9.6 composite points
Contract Quality scores 64.5 — up to +8.9 composite points
Contract Governance scores 31.8 — up to +8.2 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/zai/apis.yml: open an issue on github.com/api-evangelist/zai to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Australia AFS, Credit and ADI Registers (ASIC + APRA licensing)	undeclared	-	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 3

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

NPP and PayTo

tagged — the provider's own APIs.json carries the standard as a tag; implementation not verified

OpenAPI

measured — observed by APIs.io (published)

OAuth 2.0

measured — observed by APIs.io (declared)

APIs 26

Individual APIs this provider publishes, each with its own machine-readable definition.

Zai Addresses API

The Addresses API from Zai — 1 operation(s) for addresses.

Zai Authentication API

The Authentication API from Zai — 1 operation(s) for authentication.

Zai Bank Accounts API

The Bank Accounts API from Zai — 6 operation(s) for bank accounts.

Zai Batch Transactions API

The Batch Transactions API from Zai — 2 operation(s) for batch transactions.

Zai BPay Accounts API

The BPay Accounts API from Zai — 3 operation(s) for bpay accounts.

Zai Callbacks API

The Callbacks API from Zai — 4 operation(s) for callbacks.

Zai Card Accounts API

The Card Accounts API from Zai — 4 operation(s) for card accounts.

Zai Charges API

The Charges API from Zai — 4 operation(s) for charges.

Zai Companies API

The Companies API from Zai — 2 operation(s) for companies.

Zai Direct Debit Authorities API

The Direct Debit Authorities API from Zai — 2 operation(s) for direct debit authorities.

Zai Disbursements API

The Disbursements API from Zai — 7 operation(s) for disbursements.

Zai Fees API

The Fees API from Zai — 2 operation(s) for fees.

Zai Item Actions API

The Item Actions API from Zai — 8 operation(s) for item actions.

Zai Items API

The Items API from Zai — 9 operation(s) for items.

Zai Marketplaces API

The Marketplaces API from Zai — 1 operation(s) for marketplaces.

Zai PayIDs API

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

Zai PayTo Agreements API

Agreement Management APIs

Zai PayTo Payments API

Payment Initiation APIs

Zai Requests API

The Requests API from Zai — 2 operation(s) for requests.

Zai Sub Wallets API

The Sub-wallets API from Zai — 9 operation(s) for sub-wallets.

Zai Token Auth API

The Token Auth API from Zai — 1 operation(s) for token auth.

Zai Tools API

The Tools API from Zai — 1 operation(s) for tools.

Zai Transactions API

The Transactions API from Zai — 7 operation(s) for transactions.

Zai Users API

The Users API from Zai — 9 operation(s) for users.

Zai Virtual Accounts API

The Virtual Accounts API from Zai — 5 operation(s) for virtual accounts.

Zai Wallet Accounts API

Zai API pricing

Prices published by Zai, read 2026-09-20 from www.hellozai.com/pricing.

Plan	Price
Standard	1.5% + A$0.30 for domestic cards
Standard (international cards)	2.8% + A$0.16 for international cards
Customised	Contact Sales Includes: Volume discounts, Multi-product discounts, Country-specific rates, Interchange pricing

Plan details, limits and sources →

Billed by: card transaction · FinOps profile →

Pricing Plans 2

Published pricing tiers and plan structures.

Zai Plans Pricing

3 plans

PLANS

Zai Price Estimates

0 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Zai Rate Limits

0 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

Zai

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Zai Finops

FINOPS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Zai Webhooks

ASYNCAPI

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Zai API Rules

67 rules · 43 errors 16 warnings 8 info

SPECTRAL

OpenAPI Overlays 4

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Zai Assembly Api Overlay

1 action · update · zai-assembly-api.json

DERIVED

Zai Async Api Overlay

1 action · update · zai-async-api.json

DERIVED

Zai Payto Overlay

1 action · update · zai-payto.json

DERIVED

Zai Virtual Accounts Payid Overlay

1 action · update · zai-virtual-accounts-payid.json

DERIVED

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Zai Authentication

http/oauth2 · 3 schemes

SECURITY

Zai Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Zai Scopes

OAuth 2.0 · no documented scopes

0 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Zai Agentic Access

128 operations · 54 acting

AGENTIC

Resources

Get Started 4

Portal, sign-up, and the first successful call

DeveloperPortal

GettingStarted

SignUp

Sandbox

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

WellKnown

WellKnown

X-MCPServerCandidate

X-MCPServerCandidate

LLMsTxt

LLMsTxt

AgentSkill

AgentSkill

Design & Contract 7

Pagination, idempotency, versioning, errors, and events

Webhooks

Conformance

ErrorCatalog

Lifecycle

Conventions

Webhooks

DataModel

Scroll for all 7

Build 5

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace

Packages

SDKs

ToolCrosswalk

GitHubOrganization

GitHubOrganization

Access & Security 5

Authentication, authorization, and security posture

DomainSecurity

OAuthScopes

Authentication

Authentication

Compliance

Operate 3

Status, limits, changes, and where to get help

RateLimits

RateLimits

StatusPage

StatusPage

Support

Support

Commercial 4

Pricing, plans, and the legal terms of use

Plans

Pricing

TermsOfService

PrivacyPolicy

Company 5

The organization behind the API

Blog

BlogRSS

Website

Blog

LinkedIn

Other 5

Properties that don't map to a standard resource type

CapabilityMap

Overlay

Overlay

Overlay

Overlay

Source (apis.yml)

aid: zai
url: https://raw.githubusercontent.com/api-evangelist/zai/refs/heads/main/apis.yml
name: Zai
kind: company
description: 'Zai (hellozai.com, formerly Assembly Payments / Assembly) is an Australian payments and Payments-as-a-Service
  provider headquartered in Melbourne. Zai gives platforms, marketplaces and vertical software companies a programmable way
  to onboard users, hold funds in managed wallet accounts, collect pay-ins (card, direct debit, BPAY, PayID), and disburse
  pay-outs across many parties in a single transaction flow. It is API-first: the Assembly API exposes wallet accounts, users,
  items, transactions, bank accounts, card accounts, fees, callbacks and batch disbursements, layered with Australia''s New
  Payments Platform rails through dedicated Virtual Accounts / PayID and PayTo APIs, plus an Asynchronous API for long-running
  operations. Authentication is OAuth2 client-credentials (bearer tokens on PayTo), with a Live and Pre-live (sandbox) environment,
  webhooks with signature verification, and a developer dashboard. Positioned as the embedded-payments and marketplace-money-movement
  layer for the Australian market and platforms operating there.'
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: paid
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Paid
  confidence: high
  source:
  - plans
  - authentication
  - rate-limits
  - security
  - sandbox
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
x-docs-platform: readme
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-17
tags:
- Payments
- Australia
- Payment Gateway
- Payment Processing
- Marketplace Payments
- Payments-as-a-Service
- Real-Time Payments
- Account-to-Account
- Open Banking
- PayTo
- PayID
- New Payments Platform
- Direct Debit
- Digital Wallet
- Payouts
tags_raw:
- Payments
- Australia
- Payment Gateway
- Payment Processing
- Marketplace Payments
- Payments-as-a-Service
- Real-Time Payments
- Account-to-Account
- Open Banking
- PayTo
- PayID
- NPP
- Direct Debit
- Digital Wallets
- Payouts
created: '2026-07-24'
modified: '2026-10-06'
specificationVersion: '0.23'
apis:
- aid: zai:zai-addresses-api
  name: Zai Addresses API
  description: The Addresses API from Zai — 1 operation(s) for addresses.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Addresses
  properties:
  - type: OpenAPI
    url: openapi/zai-addresses-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-authentication-api
  name: Zai Authentication API
  description: The Authentication API from Zai — 1 operation(s) for authentication.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/zai-authentication-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-bank-accounts-api
  name: Zai Bank Accounts API
  description: The Bank Accounts API from Zai — 6 operation(s) for bank accounts.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Bank Accounts
  properties:
  - type: OpenAPI
    url: openapi/zai-bank-accounts-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-batch-transactions-api
  name: Zai Batch Transactions API
  description: The Batch Transactions API from Zai — 2 operation(s) for batch transactions.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Batch Transactions
  properties:
  - type: OpenAPI
    url: openapi/zai-batch-transactions-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-bpay-accounts-api
  name: Zai BPay Accounts API
  description: The BPay Accounts API from Zai — 3 operation(s) for bpay accounts.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - BPay Accounts
  properties:
  - type: OpenAPI
    url: openapi/zai-bpay-accounts-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-callbacks-api
  name: Zai Callbacks API
  description: The Callbacks API from Zai — 4 operation(s) for callbacks.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Callbacks
  properties:
  - type: OpenAPI
    url: openapi/zai-callbacks-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-card-accounts-api
  name: Zai Card Accounts API
  description: The Card Accounts API from Zai — 4 operation(s) for card accounts.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Card Accounts
  properties:
  - type: OpenAPI
    url: openapi/zai-card-accounts-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-charges-api
  name: Zai Charges API
  description: The Charges API from Zai — 4 operation(s) for charges.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Charges
  properties:
  - type: OpenAPI
    url: openapi/zai-charges-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-companies-api
  name: Zai Companies API
  description: The Companies API from Zai — 2 operation(s) for companies.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Companies
  properties:
  - type: OpenAPI
    url: openapi/zai-companies-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-direct-debit-authorities-api
  name: Zai Direct Debit Authorities API
  description: The Direct Debit Authorities API from Zai — 2 operation(s) for direct debit authorities.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Direct Debit Authorities
  properties:
  - type: OpenAPI
    url: openapi/zai-direct-debit-authorities-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-disbursements-api
  name: Zai Disbursements API
  description: The Disbursements API from Zai — 7 operation(s) for disbursements.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Disbursements
  properties:
  - type: OpenAPI
    url: openapi/zai-disbursements-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-fees-api
  name: Zai Fees API
  description: The Fees API from Zai — 2 operation(s) for fees.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Fees
  properties:
  - type: OpenAPI
    url: openapi/zai-fees-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-item-actions-api
  name: Zai Item Actions API
  description: The Item Actions API from Zai — 8 operation(s) for item actions.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Item Actions
  properties:
  - type: OpenAPI
    url: openapi/zai-item-actions-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-items-api
  name: Zai Items API
  description: The Items API from Zai — 9 operation(s) for items.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Item
  tags_raw:
  - Items
  properties:
  - type: OpenAPI
    url: openapi/zai-items-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-marketplaces-api
  name: Zai Marketplaces API
  description: The Marketplaces API from Zai — 1 operation(s) for marketplaces.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Marketplace
  tags_raw:
  - Marketplaces
  properties:
  - type: OpenAPI
    url: openapi/zai-marketplaces-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-payids-api
  name: Zai PayIDs API
  description: The PayIDs API from Zai — 3 operation(s) for payids.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - PayIDs
  properties:
  - type: OpenAPI
    url: openapi/zai-payids-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-payto-agreements-api
  name: Zai PayTo Agreements API
  description: Agreement Management APIs
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - PayTo Agreements
  properties:
  - type: OpenAPI
    url: openapi/zai-payto-agreements-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-payto-payments-api
  name: Zai PayTo Payments API
  description: Payment Initiation APIs
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - PayTo Payments
  properties:
  - type: OpenAPI
    url: openapi/zai-payto-payments-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-requests-api
  name: Zai Requests API
  description: The Requests API from Zai — 2 operation(s) for requests.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Requests
  properties:
  - type: OpenAPI
    url: openapi/zai-requests-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-sub-wallets-api
  name: Zai Sub Wallets API
  description: The Sub-wallets API from Zai — 9 operation(s) for sub-wallets.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Sub-wallets
  properties:
  - type: OpenAPI
    url: openapi/zai-sub-wallets-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-token-auth-api
  name: Zai Token Auth API
  description: The Token Auth API from Zai — 1 operation(s) for token auth.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Token Auth
  properties:
  - type: OpenAPI
    url: openapi/zai-token-auth-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-tools-api
  name: Zai Tools API
  description: The Tools API from Zai — 1 operation(s) for tools.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Tools
  properties:
  - type: OpenAPI
    url: openapi/zai-tools-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-transactions-api
  name: Zai Transactions API
  description: The Transactions API from Zai — 7 operation(s) for transactions.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Transaction
  tags_raw:
  - Transactions
  properties:
  - type: OpenAPI
    url: openapi/zai-transactions-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-users-api
  name: Zai Users API
  description: The Users API from Zai — 9 operation(s) for users.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - User
  tags_raw:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/zai-users-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-virtual-accounts-api
  name: Zai Virtual Accounts API
  description: The Virtual Accounts API from Zai — 5 operation(s) for virtual accounts.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Virtual Accounts
  properties:
  - type: OpenAPI
    url: openapi/zai-virtual-accounts-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
- aid: zai:zai-wallet-accounts-api
  name: Zai Wallet Accounts API
  description: The Wallet Accounts API from Zai — 6 operation(s) for wallet accounts.
  humanURL: https://developer.hellozai.com/reference/overview
  baseURL: https://secure.api.promisepay.com
  tags:
  - Wallet Accounts
  properties:
  - type: OpenAPI
    url: openapi/zai-wallet-accounts-api-openapi.yml
  - type: Documentation
    url: https://developer.hellozai.com/docs
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview
  - type: Authentication
    url: https://developer.hellozai.com/reference/token
  - type: Documentation
    url: https://developer.hellozai.com/reference/overview-va
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-va
  - type: Documentation
    url: https://developer.hellozai.com/docs/payto
  - type: APIReference
    url: https://developer.hellozai.com/reference/overview-1
  - type: Documentation
    url: https://developer.hellozai.com/reference/async-overview
  - type: APIReference
    url: https://developer.hellozai.com/reference/async-overview
common:
- url: https://www.hellozai.com/blog/tag/company-news
  type: Blog
- url: https://www.hellozai.com/blog/rss.xml
  type: BlogRSS
- type: RateLimits
  url: rate-limits/zai-rate-limits.yml
- type: Plans
  url: plans/zai-plans-pricing.yml
- type: CapabilityMap
  url: capabilities/zai-capability-edges.yml
  name: Zai Business Capability Map
- type: Overlay
  url: overlays/zai-assembly-api-overlay.yaml
- type: Overlay
  url: overlays/zai-virtual-accounts-payid-overlay.yaml
- type: Overlay
  url: overlays/zai-payto-overlay.yaml
- type: Overlay
  url: overlays/zai-async-api-overlay.yaml
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/zai/overview
- type: AgenticAccess
  url: agentic-access/zai-agentic-access.yml
- type: DomainSecurity
  url: security/zai-domain-security.yml
- type: OAuthScopes
  url: scopes/zai-scopes.yml
- type: Authentication
  url: authentication/zai-authentication.yml
- type: Website
  url: https://www.hellozai.com/
- type: DeveloperPortal
  url: https://developer.hellozai.com/
- type: Documentation
  url: https://developer.hellozai.com/docs
- type: APIReference
  url: https://developer.hellozai.com/reference/overview
- type: GettingStarted
  url: https://developer.hellozai.com/docs/developer-checklist
- type: Authentication
  url: https://developer.hellozai.com/reference/token
- type: Webhooks
  url: https://developer.hellozai.com/docs/webhooks
- type: StatusPage
  url: https://status.hellozai.com/
- type: Pricing
  url: https://www.hellozai.com/pricing
- type: Blog
  url: https://blog.hellozai.com/
- type: Support
  url: https://support.hellozai.com/
- type: SignUp
  url: https://dashboard.hellozai.com/
- type: TermsOfService
  url: https://www.hellozai.com/company/policies/terms-conditions
- type: PrivacyPolicy
  url: https://www.hellozai.com/company/policies/privacy-policy
- type: Compliance
  url: https://www.hellozai.com/company/compliance


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://artifacts.apis.io/zai/apis.yml

Zai API — frequently asked questions

Does Zai have an API?

Yes. APIs.io lists 26 APIs from Zai, including Zai Addresses API, Zai Authentication API and Zai Bank Accounts API, and 23 more.

Is there an OpenAPI specification for the Zai API?

Yes. APIs.io indexes 26 OpenAPI specifications for Zai, each linked for download from this page.

How do I authenticate with the Zai API?

Zai documents its authentication (http/oauth2 · 3 schemes). The details are profiled on APIs.io as Zai Authentication.

How much does the Zai API cost?

Zai publishes its prices; its Standard plan is 1.5% + A$0.30 for domestic cards as of 2026-09-20. APIs.io lists 3 pricing plans for Zai, with each plan's price, limits and inclusions under Pricing on this page.

Is the Zai API ready for AI agents?

Zai has a Kin Score of 64.0 out of 100 (strong) and an Agent Readiness score of 47.1 (agent-ready), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/zai"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/zai/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/zai/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.