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

The Virtual Accounts API from Zai — 5 operation(s) for virtual accounts.

Zai Virtual 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 Virtual 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 5 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 0.12-external.

Requests are made against 2 base URLs: https://sandbox.au-0000.api.assemblypay.com, https://au-0000.api.assemblypay.com.

6 operations 5 paths 21 schemas 2 GET3 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.12-external
Base URL
https://secure.api.promisepay.com
Resource Areas
1

Paths & Operations 6

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

Virtual Accounts 6
POST
/wallet_accounts/{id}/virtual_accounts
Create Virtual Account
createVirtualAccount 1 param body → 202400401403404409500
GET
/wallet_accounts/{id}/virtual_accounts
List Virtual Accounts
listVirtualAccountByWalletAccount 1 param → 200400401403404500
GET
/virtual_accounts/{id}
Show Virtual Account
showVirtualAccount 1 param → 200400401403404500
PATCH
/virtual_accounts/{id}/aka_names
Update AKA Names
updateVirtualAccountAKAName 1 param body → 202400401403404500409
PATCH
/virtual_accounts/{id}/account_name
Update Account Name
updateVirtualAccountAccountName 1 param body → 202400401403404500409
PATCH
/virtual_accounts/{id}/status
Update Virtual Account Status
updateVirtualAccount 1 param body → 202400401403404409500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are virtual_account (14 properties), update_va_status_resp (3 properties), virtual_accounts_list (2 properties), create_virtual_account_request (2 properties). Each schema is shown below with its type and property counts.

update_va_status_resp
object
3 properties
update_virtual_account_account_name_request
object
1 property 1 required
inline_response_409
object
1 property
virtual_account_not_found
object
1 property
aka_names
array
A list of AKA Names.
inline_response_403_inactive
object
1 property
virtual_accounts_list
object
2 properties
update_virtual_account_aka_names_request
object
1 property 1 required
inline_response_500
object
1 property
virtual_account
object
14 properties
create_virtual_account_request
object
2 properties
inline_response_409_object
object
1 property
inline_response_400_deprecated
object
1 property
merchant_id
string
An identifier that links a Virtual Account to a merchant. This is used in CoP lookups.
virtual_account_account_name
string
A name given for a Virtual Account. This is used in CoP lookups.
inline_response_401
object
1 property
aka_name
string
An alias for a Virtual Account. This is used in CoP lookups.
inline_response_409_patch
object
1 property
wallet_account_not_found
object
1 property
inline_response_400_1
object
1 property
inline_response_403_va
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-virtual-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 Virtual 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.