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 Item Actions API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Zai Item Actions 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 Actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 8 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 8 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, https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-async-api/1.0.0, https://test.tnq.api.assemblypay.com/, https://tnq.api.assemblypay.com/.

8 operations 8 paths 13 schemas 8 PATCH

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Zai Item Actions API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow. It accepts HTTP basic authentication (basicAuth).

  • oAuth2ClientCredentials — Please refer to Authentication section within https://developer.assemblypayments.com/referenceauthentication

Paths & Operations 8

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

Item Actions 8
PATCH
/items/{id}/make_payment
Make Payment
makePayment 1 param body → 200
PATCH
/items/{id}/make_payment_async
Make an async Payment
makePaymentAsync 1 param body → 200
PATCH
/items/{id}/cancel
Cancel
cancelItem 1 param → 200
PATCH
/items/{id}/refund
Refund
refund 1 param body → 200
PATCH
/items/{id}/authorize_payment
Authorize Payment
authorizePayment 1 param body → 200
PATCH
/items/{id}/capture_payment
Capture Payment
capturePayment 1 param body → 200
PATCH
/items/{id}/void_payment
Void Payment
voidPayment 1 param → 200
PATCH
/items/{id}/release_payment
Release Payment (Deprecated - Do Not Use)
releasePayment 1 param body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are item_2 (46 properties), item (46 properties), make_payment_requestBody (5 properties), account_id_requestBody (5 properties). Each schema is shown below with its type and property counts.

card_account_id_requestBody
object
3 properties 1 required
refund_requestBody
object
3 properties
acknowledge_payment
object
4 properties
release_payment_requestBody
object
2 properties
single_item
object
1 property
account_id_asyncRequestBody
object
2 properties 1 required
partial_payment
object
1 property
item
object
46 properties 6 required
account_id_requestBody
object
5 properties 1 required
links
object
2 properties
status
object
4 properties
make_payment_requestBody
object
5 properties 1 required
item_2
object
46 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-item-actions-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 Actions
← Back to Z APIs
API Details
ID
zai:zai-item-actions-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-item-actions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zai-item-actions-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 Item Actions 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.