Zai · Authentication Profile

Zai Authentication

Authentication

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

PaymentsAustraliaPayment GatewayPayment ProcessingMarketplace PaymentsPayments-as-a-ServiceReal-Time PaymentsAccount-to-AccountOpen BankingPayToPayIDNPPDirect DebitDigital WalletsPayouts
Methods: http, oauth2 Schemes: 3 OAuth flows: clientCredentials API key in:

Security Schemes

oAuth2ClientCredentials oauth2
· flows: clientCredentials
basicAuth http
scheme: basic
bearerAuth http
scheme: bearer

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-24'
method: derived
source: openapi/zai-assembly-api.json, openapi/zai-async-api.json, openapi/zai-payto.json
summary:
  types:
  - http
  - oauth2
  oauth2_flows:
  - clientCredentials
schemes:
- name: oAuth2ClientCredentials
  type: oauth2
  flows:
  - flow: clientCredentials
    tokenUrl: https://au-0000.sandbox.auth.assemblypay.com/tokens
    scopes: 0
  description: Please refer to Authentication section within https://developer.assemblypayments.com/reference#authentication
  sources:
  - openapi/zai-assembly-api.json
  - openapi/zai-async-api.json
- name: basicAuth
  type: http
  scheme: basic
  sources:
  - openapi/zai-async-api.json
- name: bearerAuth
  type: http
  scheme: bearer
  bearerFormat: JWT
  sources:
  - openapi/zai-payto.json