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

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

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

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

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

7 operations 7 paths 11 schemas 7 GET

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 Disbursements 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 7

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

Disbursements 7
GET
/disbursements
List Disbursements
listDisbursement 3 params → 200
GET
/disbursements/{id}
Show Disbursement
showDisbursement 1 param → 200
GET
/disbursements/{id}/transactions
Show Disbursement Transactions
showDisbursementTransactions 3 params → 200
GET
/disbursements/{id}/wallet_accounts
Show Disbursement Wallet Accounts
showDisbursementWalletAccounts 1 param → 200
GET
/disbursements/{id}/bank_accounts
Show Disbursement Bank Accounts
showDisbursementBankAccounts 1 param → 200
GET
/disbursements/{id}/users
Show Disbursement Users
showDisbursementUsers 1 param → 200
GET
/disbursements/{id}/items
Show Disbursement Items
showDisbursementItems 1 param → 200

Schemas 11

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

single_user
object
1 property
bank_account_au
object
1 property
transaction
object
22 properties
transactions
object
3 properties
single_disbursement
object
1 property
disbursements
object
2 properties
item
object
46 properties 6 required
disbursement
object
20 properties
user
object
23 properties
items
object
3 properties
wallet_account
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-disbursements-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 Fees API
Zai Item Actions API
Where this information came from

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