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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zai

Zai Items API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 12 operations across 9 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 2.3.

Requests are made against 5 base URLs: https://test.api.promisepay.com, https://secure.api.promisepay.com, https://au-0000.sandbox.auth.assemblypay.com, https://au-0000.auth.assemblypay.com, https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3.

12 operations 9 paths 18 schemas 1 DELETE9 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.3
Base URL
https://secure.api.promisepay.com
Authentication
OAuth 2.0
Contact
http://docs.assemblypayments.com/
Resource Areas
1

Authentication & Security 1

Zai Items API declares 1 security scheme for authenticating requests. 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 12

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

Items 12
GET
/items
List Items
listItems 5 params → 200
POST
/items
Create Item
createItem body → 201
GET
/items/{id}
Show Item
showItem 1 param → 200
DELETE
/items/{id}
Delete Item
deleteItem 1 param → 200
PATCH
/items/{id}
Update Item
updateItem 1 param body → 200
GET
/items/{id}/sellers
Show Item Seller
showItemSeller 1 param → 200
GET
/items/{id}/buyers
Show Item Buyer
showItemBuyer 1 param → 200
GET
/items/{id}/fees
Show Item Fees
showItemFees 1 param → 200
GET
/items/{id}/wire_details
Show Item Wire Details
showItemWireDetails 1 param → 200
GET
/items/{id}/transactions
List Item Transactions
listItemTransactions 1 param → 200
GET
/items/{id}/batch_transactions
List Item Batch Transactions
listItemBatchTransactions 1 param → 200
GET
/items/{id}/status
Show Item Status
showItemStatus 1 param → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are batch_transaction (51 properties), item (46 properties), user (23 properties), transaction (22 properties). Each schema is shown below with its type and property counts.

wire_details_with_id
object
2 properties
transactions
object
3 properties
fees
object
3 properties
items
object
3 properties
single_status
object
1 property
item
object
46 properties 6 required
fee
object
12 properties
item_requestBody
object
13 properties 6 required
status
object
3 properties
wire_details
object
13 properties
user
object
23 properties
single_user
object
1 property
update_item_requestBody
object
6 properties
batch_transaction
object
51 properties 4 required
transaction
object
22 properties
list_batch_transactions
object
3 properties
single_item
object
1 property
single_wire_details_with_id
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-items-api-openapi.yml Raw ↑

Other APIs Zai publishes across the network.

Zai Addresses API
AE Profile APIs.io
Zai Authentication API
AE Profile APIs.io
Zai Bank Accounts API
AE Profile APIs.io
Zai Batch Transactions API
AE Profile APIs.io
Zai BPay Accounts API
AE Profile APIs.io
Zai Callbacks API
AE Profile APIs.io
Zai Card Accounts API
AE Profile APIs.io
Zai Charges API
AE Profile APIs.io
Zai Companies API
AE Profile APIs.io
Zai Direct Debit Authorities API
AE Profile APIs.io
Zai Disbursements API
AE Profile APIs.io
Zai Fees API
AE Profile APIs.io
#Item
← Back to Z APIs
API Details
ID
zai:zai-items-api
Base URL
https://secure.api.promisepay.com
Docs
https://developer.hellozai.com/reference/overview
Provider
Zai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zai-items-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zai-items-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

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