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 API Keys API

Manage API keys for your clients.

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

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

This API exposes 6 operations across 3 paths, and defines 10 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 3 paths 10 schemas 3 GET1 PATCH2 POST

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 API Keys 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 3 paths, the API surfaces 6 operations — 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

API Keys 6

Manage API keys for your clients.

POST
/client/{clientId}/apiKeys
Create API keys for Sub Merchants
apiKeysProvision 1 param body → 201400401403404
GET
/client/{clientId}/apiKeys
Get API keys for Sub Merchants
getApiKeys 1 param → 200400401403404
GET
/client/{clientId}/apiKeys/{apiKeyId}
Gets an API key based on the API key ID.
getApiKey 2 params → 200400401403404
PATCH
/client/{clientId}/apiKeys/{apiKeyId}
Update API keys for Sub Merchants
updateApiKeys 2 params body → 204400401403404
POST
/client/{clientId}/oauth2
Enable OAuth2 for a client
enableClientOAuth2 1 param body → 201400403
GET
/client/{clientId}/oauth2
Get OAuth2 configuration for a client
getClientOAuth2 1 param → 200403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EnableOAuth2ResponseObj (6 properties), GetOAuth2ResponseObj (5 properties), apiKeysProvisionResponseObj (5 properties), GetApiKeyResponseObj (4 properties). Each schema is shown below with its type and property counts.

GetOAuth2ResponseObj
object
Response returned when retrieving the OAuth2 configuration for a client. Identical to EnableOAuth2ResponseObj except that oauth2ClientSecret is not returned be…
5 properties 5 required
GetApiKeysResponseObj
array
apiKeysProvisionObj
object
2 properties 1 required
EnableOAuth2ResponseObj
object
Response returned when OAuth2 is successfully enabled for a client. Contains the credentials and metadata required to obtain access tokens via the OAuth2 clien…
6 properties 6 required
apiKeysProvisionResponseObj
object
Response object returned upon successful provisioning of a new API key. Contains the newly created API key details including credentials and permissions.
5 properties
ApiKeyIdObj
string
The ID provided when the API Key was generated via the API or from the dashboard.
GetApiKeyResponseObj
object
Response object that provides detailed information about an existing API key, including its current status, capabilities, and permissions.
4 properties
ErrorModel
object
2 properties 1 required
ApiKeyUpdateObj
object
Object used to update API key state (Active / Disabled).
1 property 1 required
SubClientIdObj
string
Your client’s unique identifier that we provide you during the initial onboarding request.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azupay-api-keys-api-openapi.yml Raw ↑

Other APIs Azupay publishes across the network.

Azupay Billing and Transaction Reports API
Azupay Check Accounts API
Azupay Clients 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 API Keys 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.