Azupay Payment Agreement 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 Agreement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 5 paths,
and defines 43 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 operations5 paths43 schemas1 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
Azupay Payment Agreement 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 5 paths, the API surfaces 6 operations — 1 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Payment Agreement 6
This API allows you to request Payments using mandates.
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are AdditionalDetailsObj (9 properties), PaymentScheduler (8 properties), PayerDetailsObj (4 properties), PaymentSchedulerStatus (4 properties). Each schema is shown below with its type and property counts.
endDate
string
A date in the calendar year expressed in this format YYYY-MM-DD. This date would be in Australia/Sydney timezone
paymentAgreementIdForSearch
string
ID of the payment agreement being searched.
PaymentSchedulerResponse
object
Standard scheduler response: the resource plus its server-managed state.
2 properties2 required
PaymentAgreementAmendmentObj
object
1 property1 required
PaymentSchedulerRequest
object
Create/amend request envelope.
1 property1 required
agreementDescription
string
Description of the Payment Agreement visible to the payer.
PayerDetailsObj
object
Provide either payIDDetails or bankAccountDetails
4 properties
recordCount
number
The number of records that were retrieved.
authorizationHeader
string
The string that Azupay will put into the Authorization request header when calling the Callback url. Will be obfuscated (shown as ) in API responses.
PayToErrorModel
object
2 properties1 required
PaymentAgreementSearchObj
object
1 property
countPerPeriod
string
Number of payments within a specified period based on the frequency
ContractIdObj
string
Unique Id for the merchant side contract. This field is used to prevent the creation of duplicated payment agreements in CREATED, SUSPENDED, ACTIVE status. Pay…
amount
string
Amount in AUD
lastPaymentDate
string
A date in the calendar year expressed in this format YYYY-MM-DD. This date would be in Australia/Sydney timezone
BsbObj
string
The BSB of the account number
PayIDObj
string
The payer's PayID. Valid examples are +61-432123321 (mobile), +61-312344321 (landline), 0432123321 (mobile), 0312344321 (landline), jane.smith@example.com
maximumAmount
string
Amount in AUD
lastPaymentAmount
string
Amount in AUD
AccountNumberObj
string
The Account Number (without the BSB)
azupayId
string
An identifier generated by Azupay. Used to reference the object in subsequent operations
PaymentAgreementStatusObj
object
1 property1 required
endpointURL
string
An internet accessible url which Azupay will invoke when the status of the transaction has changed. The call will be done using the HTTP POST method. The endpo…
NotificationObj
object
Merchant Callback Details
2 properties2 required
frequency
string
Payment Frequency
agreementPayeeName
string
Lets you control the Payee description (visible to they payer) on the payment agreement: If not populated, then your business name will appear i.e. "My busines…
PaymentSchedulerStatus
object
Server-managed state returned on every GET/POST response.
4 properties2 required
PaymentAgreementSearchResponseObj
object
PayToAmountObj
string
Amount in AUD to be requested from the Payee
AdditionalDetailsObj
object
Additional details for auditing purposes
9 properties4 required
AgreementExpiryMinutesObj
integer
An integer value representing the total number of minutes before a payment agreement expires. This field has a minimum value of 5 and a max of 7199
toDateUTC
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…
fromDateUTC
string
The report date in ISO date/time string format in UTC
ClientIdObj
string
Id of the client initiating the transaction. This is supplied by Azupay and only changes between environments. For example, you might be allocated CLIENT1TEST…
firstPaymentAmount
string
Amount in AUD
PayeeDetailsObj
object
Payee Details
2 properties
PaymentAgreementObj
object
1 property1 required
PaymentScheduler
object
Scheduler attached to an active PayTo payment agreement. On create/amend, status accepts ACTIVE or INACTIVE only; other lifecycle states (PAUSED, CANCELLED, CO…
8 properties5 required
StartDateObj
string
A date in the calendar year expressed in this format YYYY-MM-DD. This date would be in Australia/Sydney timezone
PaymentAgreementAmendmentStatusObj
object
1 property1 required
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.
ErrorModel
object
2 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Agreement 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.
