Azupay · Authentication Profile

Azupay Authentication

Authentication

Azupay secures its APIs with apiKey and oauth2 across 3 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the clientCredentials flow(s).

PaymentsAustraliaReal-Time PaymentsAccount-to-AccountNew Payments PlatformPayIDPayToMoney TransferConfirmation of PayeeOpen Banking
Methods: apiKey, oauth2 Schemes: 3 OAuth flows: clientCredentials API key in: header

Security Schemes

SecretKey apiKey
· in: header (Authorization)
DistributableKey apiKey
· in: header (Authorization)
OAuth2ClientCredentials oauth2

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-24'
method: searched
source: openapi/azupay-check-accounts.yml, openapi/azupay-configuration.yml, openapi/azupay-payment-agreement.yml,
  openapi/azupay-payment-request.yml, openapi/azupay-payment.yml, openapi/azupay-reports.yml
docs: https://developer.azupay.com.au/docs/getting-started-1, https://developer.azupay.com.au/docs/oauth-20-api
summary:
  types:
  - apiKey
  - oauth2
  api_key_in:
  - header
  oauth2_flows:
  - clientCredentials
schemes:
- name: SecretKey
  type: apiKey
  in: header
  parameter: Authorization
  description: Secret (SECR) key for restricted/charging operations (including outbound payments); store
    encrypted, restrict to authorised systems.
  sources: &id001
  - openapi/azupay-check-accounts.yml
  - openapi/azupay-configuration.yml
  - openapi/azupay-payment-agreement.yml
  - openapi/azupay-payment-request.yml
  - openapi/azupay-payment.yml
  - openapi/azupay-reports.yml
- name: DistributableKey
  type: apiKey
  in: header
  parameter: Authorization
  description: Distributable (DIST) key with limited access; may be exposed publicly to payers.
  sources: *id001
- name: OAuth2ClientCredentials
  type: oauth2
  flow: clientCredentials
  description: 'Additional server-to-server option (enabled per client). Short-lived JWT bearer token;
    oauth2TokenUrl and allowed scopes are returned by enableClientOAuth2/getClientOAuth2. Send as Authorization:
    Bearer <token>.'
  tokenUrl: dynamic (oauth2TokenUrl)
  sources:
  - 'docs: https://developer.azupay.com.au/docs/oauth-20-api'