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 Wallet Accounts API

The Wallet Accounts API from Zai — 6 operation(s) for wallet accounts.

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

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

This API exposes 6 operations across 6 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.

6 operations 6 paths 18 schemas 4 GET2 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 Wallet Accounts 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 6

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

Wallet Accounts 6
POST
/wallet_accounts/{id}/bill_payment
Pay a Bill
billPayment 1 param body → 201
GET
/wallet_accounts/{id}/users
Show Wallet Account User
showWalletAccountUser 1 param → 200
POST
/wallet_accounts/{id}/withdraw
Withdraw Funds
withdrawFunds 1 param body → 201
GET
/wallet_accounts/{id}
Show Wallet Account
showWalletAccount 1 param → 200
GET
/wallet_accounts/{id}/npp_details
Show Wallet Account NPP Details
showWalletAccountNPPDetails 1 param → 200
GET
/wallet_accounts/{id}/bpay_details
Show Wallet Account BPAY Details
showWalletAccountNBPAYDetails 1 param → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are user (23 properties), disbursement (20 properties), ifti_information_response (14 properties), ifti_address (10 properties). Each schema is shown below with its type and property counts.

ifti_information_response
object
14 properties
contact_details
object
7 properties
generic_identification
object
4 properties 1 required
withdraw_requestBody
object
6 properties 2 required
single_disbursement
object
1 property
ifti_address
object
This represents address of an individual or non-individual customer of a NPP participant. This object could be populated in one of formats below:
10 properties
wallet_account_bpay_details
object
2 properties
party_identification
object
8 properties
date_and_place_of_birth
object
4 properties 3 required
party_identification_sample
object
4 properties
disbursement
object
20 properties
address_type
string
Address Type ADDR - Postal Address is the complete postal address BIZZ - Business Address is the business address DLVY - Delivery To Address is the address to…
user
object
23 properties
wallet_account_npp_details
object
2 properties
bill_payment_requestBody
object
3 properties 2 required
wallet_account
object
1 property
single_user
object
1 property
withdraw_disbursement
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-wallet-accounts-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 Disbursements API
Zai Fees API
Where this information came from

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