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

Azupay Clients API

Would let you manage clients

Azupay Clients API is one of 10 APIs that Azupay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://api-uat.azupay.com.au/v1, https://api.azupay.com.au/v1.

6 operations 4 paths 12 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.azupay.com.au/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Azupay Clients API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (SecretKey). An API key is passed in the header as Authorization (DistributableKey).

  • SecretKey — The secret key is used to access restricted functions and should be stored securely in your system. It is required for operations which may result in additiona…
  • DistributableKey — The distributable key has limited access and may be exposed publicly to your payers.

Paths & Operations 6

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

Clients 6

Would let you manage clients

POST
/clients
Create or replace a client
createClient body → 201400403
DELETE
/clients/{clientId}
Disable a sub-client
deleteClient 1 param → 204400403404
GET
/clients/{clientId}/lowBalanceAlert/emailAddresses
getClientLowBalanceAlertEmailAddresses 1 param → 200403404
PUT
/clients/{clientId}/lowBalanceAlert/emailAddresses
Set email addresses to send the low balance alerts
updateClientLowBalanceAlertEmailAddresses 1 param body → 204400403404
GET
/clients/{clientId}/lowBalanceAlert/threshold
getClientLowBalanceAlertThreshold 1 param → 200403404
PUT
/clients/{clientId}/lowBalanceAlert/threshold
Set low balance threshold to trigger alerts
updateClientLowBalanceAlertThreshold 1 param body → 204400403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ErrorModel (2 properties), LowBalanceThreshold (1 property), SetLowBalanceThreshold (1 property), ClientWebhookResponseObj (1 property). Each schema is shown below with its type and property counts.

PayIDDomainsObj
array
A list of domain names that can be use for payIDs. Optionally use merchantName to control the payID description prefix.
SetLowBalanceThreshold
object
1 property 1 required
LowBalanceThreshold
object
1 property 1 required
AdditionalTradingNamesObj
array
Additional trading names
MerchantCodeEnumObj
string
SetLowBalanceEmailAddresses
object
1 property 1 required
PaymentStatusObj
object
1 property 1 required
ClientObj
object
1 property 1 required
PaymentObj
object
1 property 1 required
ErrorModel
object
2 properties 1 required
LowBalanceEmailAddresses
object
1 property 1 required
ClientWebhookResponseObj
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azupay-clients-api-openapi.yml Raw ↑

Other APIs Azupay publishes across the network.

Azupay API Keys API
Azupay Billing and Transaction Reports API
Azupay Check Accounts API
Azupay Current Balances API
Azupay Payment Agreement API
Azupay Payment Agreement Request API
Azupay Payment API
Azupay Payment Initiation API
Azupay Payment Request API
Where this information came from

This is an independent, third-party profile of Azupay Clients 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.