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 Sub Wallets API

The Sub-wallets API from Zai — 9 operation(s) for sub-wallets.

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

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

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

11 operations 9 paths 31 schemas 1 DELETE5 GET2 PATCH3 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 Sub Wallets 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 11

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

Sub-wallets 11
GET
/sub_wallets/{account_id}
List Sub-wallets
listSubWallets 3 params → 200422
POST
/sub_wallets
Create Sub-wallet
createSubWallet body → 201422
GET
/sub_wallets/{id}
Show Sub-wallet
showSubWallet 1 param → 200422
DELETE
/sub_wallets/{id}
Redact Sub-wallet
deleteSubWallet 1 param → 200422
PATCH
/sub_wallets/{id}
Update Sub-wallet
updateSubWallet 1 param body → 200422
PATCH
/sub_wallets/transfer
Fund transfers
transferSubWallet body → 201422
GET
/sub_wallets/{id}/transactions
List Sub-wallet transactions
showSubWalletTransactions 1 param → 200422
POST
/sub_wallets/{id}/bill_payment
Pay a Bill
billPaymentSubWallet 1 param body → 201422
POST
/sub_wallets/{id}/withdraw
Withdraw Funds
withdrawFundsSubWallet 1 param body → 201422
GET
/sub_wallets/{id}/users
Show Sub-wallet User
showSubWalletUser 1 param → 200422
GET
/sub_wallets/{id}/wallet_accounts
Show the Wallet Account of a Sub-wallet
showSubWalletWalletAccount 1 param → 200422

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are user (23 properties), disbursement (20 properties), sub_wallet_transactions (19 properties), sub_wallet_sub_wallets (8 properties). Each schema is shown below with its type and property counts.

sub_wallet_related
object
1 property
sub_wallet_related_transactions
array
sub_wallet_create_requestBody
object
2 properties 1 required
sub_wallet_create_responseBody
object
1 property
sub_wallets_id_body
meta
object
3 properties
single_disbursement
object
1 property
sub_wallet_error_responseBody
object
1 property
sub_wallet_transfer_requestBody
object
3 properties 3 required
disbursement
object
20 properties
sub_wallet_update_requestBody1
object
2 properties
sub_wallet_update_requestBody3
object
1 property
sub_wallet_transactions_index
object
3 properties
sub_wallet_transfer_responseBody
object
1 property
sub_wallet_transaction_links
object
1 property
sub_wallet_error_responseBody_errors
object
1 property
sub_wallet_withdraw_requestBody
object
4 properties 2 required
user
object
23 properties
sub_wallet_create_responseBody_sub_wallets
object
8 properties
bill_payment_requestBody
object
3 properties 2 required
sub_wallet
object
1 property
sub_wallet_sub_wallets
object
8 properties
single_user
object
1 property
wallet_account
object
1 property
sub_wallet_transactions_mp
object
4 properties
sub_wallet_update_requestBody2
object
1 property
sub_wallet_create_responseBody_sub_wallets_links
object
3 properties
sub_wallet_tr
object
5 properties
sub_wallet_transactions
object
19 properties
sub_wallets
object
1 property
sub_wallet_sub_wallets_links
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-sub-wallets-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 Sub Wallets 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.