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 Charges API

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

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

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

This API exposes 5 operations across 4 paths, and defines 8 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.

5 operations 4 paths 8 schemas 4 GET1 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
Resource Areas
1

Authentication & Security 1

Zai Charges 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 5

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

Charges 5
GET
/charges
List Charges
listCharges 2 params → 200
POST
/charges
Create Charge
createCharge body → 201
GET
/charges/{id}
Show Charge
showCharge 1 param → 200
GET
/charges/{id}/status
Show Charge Status
showChargeStatus 1 param → 200
GET
/charges/{id}/buyers
Show Charge Buyer
showChargeBuyer 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are charge (28 properties), user (23 properties), charge_requestBody (14 properties), charge_status (3 properties). Each schema is shown below with its type and property counts.

charge
object
28 properties
single_charge_status
object
1 property
charge_status
object
3 properties
single_charge
object
1 property
user
object
23 properties
single_user
object
1 property
charges
object
1 property
charge_requestBody
object
14 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-charges-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 Companies API
Zai Direct Debit Authorities API
Zai Disbursements API
Zai Fees API
Zai Item Actions API
Where this information came from

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