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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Azupay

Azupay Payment Request API

This API allows your customers to make payments using PayID on your website, mobile app or over the counter.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 5 operations across 3 paths, and defines 17 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.

5 operations 3 paths 17 schemas 1 DELETE1 GET3 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
Contact
contactus@azupay.com.au
Resource Areas
1

Authentication & Security 2

Azupay Payment Request 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 5

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

Payment Request 5

This API allows your customers to make payments using PayID on your website, mobile app or over the counter.

POST
/paymentRequest
Create a Payment Request.
createPayIdPaymentRequest body → 200400403
DELETE
/paymentRequest
Delete a Payment Request.
deletePaymentRequest 1 param → 204400401
GET
/paymentRequest
Get a Payment Request.
getPaymentRequest 1 param → 200400401404
POST
/paymentRequest/refund
Refund a PaymentRequest.
refundPaymentRequest 3 params → 200400401404
POST
/paymentRequest/search
Search for Payment Requests.
searchPaymentRequest 2 params body → 200400401403

Schemas 17

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

AccountNumberObj
string
The Account Number (without the BSB)
PaymentRequestSearchObj
object
1 property
fromDateUTC
string
The report date in ISO date/time string format in UTC
ClientTransactionIdObj
string
Unique Id for the transaction created by the merchant system This field is used to prevent the creation of duplicated clients in case of a message retry. It is…
PaymentRequestObj
object
1 property 1 required
SuggestedPayerPayIDObj
string
Note SuggestedPayerPayID has been deprecated and replaced by SuggestedPayerDetails. The payer's PayID. Valid examples are 0432123321 (mobile) and jane.smith@ex…
PaymentRequestSearchResponseObj
object
PaymentRequestStatusObj
object
1 property
AccountNameObj
string
The Account Name
BsbObj
string
The BSB of the account number
nextPageIdResponse
string
If there are more results you can invoke this search again by providing the nextPageId in the query parameters to retrieve the next set of results.
PayerPayIDObj
string
The payer's PayID. Valid examples are 0432123321 (mobile) and jane.smith@example.com (email).
ErrorModel
object
2 properties 1 required
toDateUTC
string
The report date in ISO date/time string format in UTC
clientBranch
string
Optional branch identifier within the client
recordCount
number
The number of records that were retrieved.
suggestedPayerDetailsObj
object
Payer details to pre-populate the UI. Only one of payIDDetails or bankAccountDetails allowed.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azupay-payment-request-api-openapi.yml Raw ↑

Other APIs Azupay publishes across the network.

Azupay API Keys API
AE Profile APIs.io
Azupay Billing and Transaction Reports API
AE Profile APIs.io
Azupay Check Accounts API
AE Profile APIs.io
Azupay Clients API
AE Profile APIs.io
Azupay Current Balances API
AE Profile APIs.io
Azupay Payment Agreement API
AE Profile APIs.io
Azupay Payment Agreement Request API
AE Profile APIs.io
Azupay Payment API
AE Profile APIs.io
Azupay Payment Initiation API
AE Profile APIs.io
#Payment Request
← Back to A APIs
API Details
ID
azupay:azupay-payment-request-api
Base URL
https://api.azupay.com.au/v1
Docs
https://developer.azupay.com.au/docs/receiving-payments
Provider
Azupay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=azupay-payment-request-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/azupay-payment-request-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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