Child client lookup by client ID

To give you a quick way to confirm a child client's current setup, we've introduced the GET /clients/{clientId} endpoint.

This endpoint is for parent accounts. Use it if your Azupay account is set up as a parent and you create submerchants under it, or if you create sub-accounts for sub-brands that you manage. In the API, each submerchant or sub-account is a child client.

Call the endpoint with the child client's ID to get its latest accepted details. The response includes enabled, legalName, abn, payIDDomains, defaultPaymentExpiryDuration, settlementAccountFullLegalName and clientTransactionId. Optional fields such as tradingName, settlement details, topUpPayId, payout limits and kyc are returned when they are configured, and left out when they are not. If the child client was enabled at any time, the response also includes enabledDateTime.

For security, notification settings return the configured URL only, never the authorisation header. You can also use the endpoint to retrieve your own client record.

If the client ID does not match a child client that you own, the API returns 404 Not Found with failure code ERR0.01.

📘 API reference
✅ Available to clients with access to create new clients via Clients API. To request access, contact the Azupay Service Desk.