Sub-client lookup by client ID
To give you a quick way to check on the sub-clients you manage, we've introduced a new endpoint to the Clients API. Call GET /clients/{clientId} with a sub-client's client ID and you'll get back its latest details and enabled state. You can also use your own client ID to check your own account.
The response includes the sub-client's legal name, ABN, PayID domains, default payment expiry duration and settlement account name. Optional details come back too when they're set up, such as trading names, settlement account details, a top-up PayID, payout limits and KYC information. If something isn't configured, it's left out.
You can see at a glance whether a sub-client is enabled. If it has ever been enabled, enabledDateTime shows when, even if it's been disabled since. Sweep and client management notification URLs are returned so you can confirm where notifications go. Authorisation headers are never included.
If the client ID doesn't match a sub-client you own, the API returns 404 Not Found.
This endpoint is available to clients with access to the Clients API. To request access, contact the Azupay Service Desk.