# Azupay Developer Docs Documentation

> Work with us and embed our highly optimised and continuously improving UX Apps to provide seamless PayOuts, Payment Requests and Automatic Payments for your customers, suppliers and partners. Alternatively, work with our suite of APIs and create your own customised user experiences.

## Guides: Getting Started
- [Build your first integration](https://developer.azupay.com.au/docs/getting-started-1.md): Save yourself some later headaches: read this page before starting your first integration
- [Choosing the right UX payment solution](https://developer.azupay.com.au/docs/selecting-the-right-ux-app.md)
- [Best practice](https://developer.azupay.com.au/docs/best-practice.md): Advice on how to get the best outcomes from your integration with Azupay apps or APIs

## Guides: ux payment solutions
- [Overview](https://developer.azupay.com.au/docs/managing-your-apps.md)
- [Receive Payments](https://developer.azupay.com.au/docs/receive-payments.md)
  - [Pay by Bank App](https://developer.azupay.com.au/docs/pay-by-bank-app.md): The Pay by Bank App lets you receive real-time account-to-account payments through a custom-branded checkout experience. Within the app, you can offer PayID payments, enable PayTo where suitable.
    - [Receive PayID Payments](https://developer.azupay.com.au/docs/receive-payid-payments.md)
    - [Receive PayTo Payments](https://developer.azupay.com.au/docs/receive-payto-payments.md)
    - [Configurations](https://developer.azupay.com.au/docs/configurations.md)
- [Send Payments](https://developer.azupay.com.au/docs/send-payments.md)
  - [Disbursement App ](https://developer.azupay.com.au/docs/disbursements-app.md): The Disbursements App enables Azupay clients to make outbound payments directly from the Azupay client dashboard.
    - [Send to PayID or BSB & AccNo](https://developer.azupay.com.au/docs/send-payments-to-bsb-account-number.md)
- [Pull Payments](https://developer.azupay.com.au/docs/pull-payments.md)
  - [Subscriptions App](https://developer.azupay.com.au/docs/subscriptions-app.md)
    - [Pull via Subscriptions App](https://developer.azupay.com.au/docs/pull-via-subscriptions-app.md)
- [Integration Guide](https://developer.azupay.com.au/docs/integration-guide.md): A series of guides on how to integrate specific Apps and solutions
  - [Integrate Pay by Bank](https://developer.azupay.com.au/docs/integrate-pay-by-bank.md)
    - [AdobeCommerce (Magento) Integration](https://developer.azupay.com.au/docs/integrating-with-adobecommerce-magento.md)
    - [Shopify Integration](https://developer.azupay.com.au/docs/integrating-with-shopify.md)
    - [Clover Integration](https://developer.azupay.com.au/docs/onboarding-to-azupay-on-clover.md): This guide explains how to onboard your business to **Azupay Pay by Bank** using a **Clover terminal**.  The onboarding process is completed directly on the terminal and allows Azupay to verify your…
  - [Integrate Subscriptions App](https://developer.azupay.com.au/docs/integrate-subscriptions-app.md)
- [Testing the Pay by Bank App](https://developer.azupay.com.au/docs/test-accounts-1-click-checkout.md): In the UAT environment, we provide you with fictitious accounts and PayIDs in order to test possible payment request outcomes in the PayID and PayTo payment flows
- [Testing the Subscriptions App](https://developer.azupay.com.au/docs/testing-the-subscriptions-app.md)
  - [Test accounts - Subscriptions app](https://developer.azupay.com.au/docs/test-accounts-for-subscriptions-app.md)
  - [Test accounts - PaymentInitiation API](https://developer.azupay.com.au/docs/test-accounts-paymentinitiation-api-1.md)
- [Whitelisting of App URLs](https://developer.azupay.com.au/docs/whitelisting-of-app-urls.md): This guide outlines what URLs you should whitelist for our hosted UX apps

## Guides: API guides
- [PayTo Integration Guide](https://developer.azupay.com.au/docs/payto-integration-guide.md): Step-by-step instructions for integrating PayTo recurring payments with Azupay
- [PaymentRequest API](https://developer.azupay.com.au/docs/receiving-payments.md): The PaymentRequest API is used to receive payments from your customers.
- [Payment API](https://developer.azupay.com.au/docs/making-payments.md): Overview of how to send outbound payments
- [PaymentAgreement API](https://developer.azupay.com.au/docs/guide-to-the-createagreement-api.md): The Payment Agreement API is used to establish agreements with your customers for reoccuring payments.
- [PaymentInitiation API](https://developer.azupay.com.au/docs/guide-to-the-paymentinitiation-api.md): Once you have an active Payment Agreement in place you can automatically collect eligible payments aligned to the terms of the Payment Agreement.
- [PaymentAgreementRequest API](https://developer.azupay.com.au/docs/paymentagreementrequest-api.md)
- [PaymentSchedule API](https://developer.azupay.com.au/docs/paymentschedule-api.md): Schedule payments against existing payment agreements
- [Report API](https://developer.azupay.com.au/docs/report-api.md): The report API is used to retrieve daily transaction reports by month and retrieve reports available for download by date ranges.
- [Balance API](https://developer.azupay.com.au/docs/get-current-balance-api.md): This API is used to check your account balance for an Azupay client.
- [File transfer guide - Batch](https://developer.azupay.com.au/docs/batch-user-guide.md)
  - [Payment request - Batch](https://developer.azupay.com.au/docs/payment-request-batch.md)
  - [Payment initiation - Batch](https://developer.azupay.com.au/docs/payment-initiation-batch.md)
  - [Payment initiation refund - Batch](https://developer.azupay.com.au/docs/payment-initiation-refund-batch-files.md)
  - [Payment - Batch (ABA file format)](https://developer.azupay.com.au/docs/payment-payout-batch-files.md): An .ABA file is an electronic file format commonly used by Australian banks for processing bulk transactions, such as payroll, accounts payable, and direct debits. It's structured in a format…
- [API Key Management API](https://developer.azupay.com.au/docs/api-key-management.md)
- [Clients API](https://developer.azupay.com.au/docs/clients-api.md)
- [Account Check API (CoP)](https://developer.azupay.com.au/docs/account-check-cop.md): Real-time account checks that safeguard payments from fraud, mistakes, and misdirected payments, giving your business confidence every time
- [PayID Enquiry API](https://developer.azupay.com.au/docs/payid-enquiry.md)
- [OAuth 2.0](https://developer.azupay.com.au/docs/oauth-20-api.md): OAuth 2.0 client credentials lets your backend system call enabled Azupay REST APIs with short-lived bearer tokens instead of sending an API key on each request. It is designed for server-to-server…

## Guides: using the azupay dashboard
- [Reports](https://developer.azupay.com.au/docs/reports.md)
- [Search for transaction data](https://developer.azupay.com.au/docs/search-for-transaction-data.md)
- [Viewing PayTo agreements](https://developer.azupay.com.au/docs/viewing-payto-agreements.md): PayTo agreement data includes the Payment Agreements that have been arranged with your customers. A Payment Agreement is the agreement between your business and your customer that allows eligible…
- [Balance management](https://developer.azupay.com.au/docs/managing-your-account-balance.md): This page offers a way to manage your Azupay account balance
- [Create payment request from dashboard](https://developer.azupay.com.au/docs/create-payment-request-from-dashboard.md)
- [Refunding Transactions from the Dashboard](https://developer.azupay.com.au/docs/refunding-transactions-from-the-dashboard.md): A guide to making refunds on a transaction.
- [Settings](https://developer.azupay.com.au/docs/managing-your-azupay-account-settings.md)
- [Switching clients](https://developer.azupay.com.au/docs/switching-clients.md)
- [User management](https://developer.azupay.com.au/docs/user-management.md)
  - [User Roles](https://developer.azupay.com.au/docs/user-roles-reference.md)
- [Multi-factor authentication](https://developer.azupay.com.au/docs/multi-factor-authentication.md)

## Guides: Testing your API integration
- [Data Security in the Integration & UAT Environment](https://developer.azupay.com.au/docs/data-security-in-the-integration-uat-environment.md)
- [Testing & integration -  PaymentRequest API](https://developer.azupay.com.au/docs/test-cases-for-payid-api-integration.md)
- [Testing & integration - PaymentInitiation API](https://developer.azupay.com.au/docs/testing-integration-paymentinitiation-api.md)
  - [Test accounts PaymentInitiation API](https://developer.azupay.com.au/docs/test-accounts-paymentinitiation-api.md)
- [Test accounts - PaymentAgreement APIs](https://developer.azupay.com.au/docs/testing.md): In the UAT environment, we provide you with fictitious accounts, PayIDs and Payment Agreements in order to test all possible payment outcomes for our products
- [Test accounts - Payment APIs](https://developer.azupay.com.au/docs/test-accounts-payment-apis.md): In the UAT environment, we provide you with fictitious accounts and PayID's in order to test all possible outbound payment outcomes
- [Test accounts - Check accounts API](https://developer.azupay.com.au/docs/account-references.md)

## Guides: account configuration & setup
- [Checking account balance](https://developer.azupay.com.au/docs/checking-account-balance.md)
- [Signing Up](https://developer.azupay.com.au/docs/signing-up.md)
- [Creating Sub-accounts](https://developer.azupay.com.au/docs/creating-sub-accounts.md)
- [Account Types and Client Management](https://developer.azupay.com.au/docs/client-management.md)
- [Settlement of Funds](https://developer.azupay.com.au/docs/settlements-of-funds-reference.md)

## Guides: Webhooks
- [Webhooks - Implementation and Security](https://developer.azupay.com.au/docs/webhooks.md)
- [Configuring webhook preferences](https://developer.azupay.com.au/docs/configuring-webhook-preferences.md)
- [OAuth2 for webhook notifications](https://developer.azupay.com.au/docs/oauth2-for-webhook-notifications.md)
  - [Technical details for OAuth2 Webhook notifications](https://developer.azupay.com.au/docs/technical-details-for-oauth2-webhook-notifications.md)

## Guides: Platform Operations & Service Desk
- [Maintenance and incident alerting](https://developer.azupay.com.au/docs/maintenance-and-incident-alerting.md)
- [Raising disputes for Azupay investigation](https://developer.azupay.com.au/docs/raising-disputes.md)
- [Updating a customer dispute upon request by Azupay](https://developer.azupay.com.au/docs/updating-a-customer-dispute.md)

## Guides: OTHER CORE PLATFORM FEATURES
- [Account blacklisting - payment requests](https://developer.azupay.com.au/docs/account-blacklisting-payment-requests.md)
- [Single Sign-On (SSO) Support for Azupay Dashboard](https://developer.azupay.com.au/docs/single-sign-on.md)

## Guides: Batch Integration
- [Connectivity Guide](https://developer.azupay.com.au/docs/connectivity-guide.md): Configure SFTP connectivity for Azupay Batch using Azupay Hosted or Customer Hosted SFTP Server models. Includes setup, authentication, testing, and network requirements.
- [SFTP Connectivity Troubleshooting](https://developer.azupay.com.au/docs/sftp-troubleshooting.md): Diagnose and resolve common SFTP connectivity issues with exact error messages, initial diagnostics, and step-by-step resolutions for both connectivity models.

## Guides: Batch File Formats
- [File Processing Overview](https://developer.azupay.com.au/docs/readme.md): Overview of file types supported by Azupay Batch for bulk payment and collection operations, with links to detailed format specifications.
- [ABA File Format and Processing Guide](https://developer.azupay.com.au/docs/aba-outbound.md): Complete specification for ABA format outbound payment files, including record structure, validation rules, processing lifecycle, response files, and error handling.

## API Reference: API Reference
- [Create a Payment Request.](https://developer.azupay.com.au/reference/createpayidpaymentrequest.md): Creates a payment request. Once created, your customer can make a payment to the specified PayID. You can poll for PaymentStatus using getPaymentRequest to determine whether or not the required…
- [Delete a Payment Request.](https://developer.azupay.com.au/reference/deletepaymentrequest.md): Delete an existing payment request, de-registering the associated PayID in the process.
- [Search for Payment Requests.](https://developer.azupay.com.au/reference/searchpaymentrequest.md): Search for Payment Requests
- [Get a Payment Request.](https://developer.azupay.com.au/reference/getpaymentrequest.md): Retrieves an existing PayID PaymentRequest.  Use the contents of the response body to determine whether the customer has made their payment.
- [Refund a PaymentRequest.](https://developer.azupay.com.au/reference/refundpaymentrequest.md): Refund a previously settled PaymentRequest back to the customer's source of funding. Optionally supply the amount to refund. Refunds requests can be rejected for the following failure reasons:  |…
- [Make a Payment.](https://developer.azupay.com.au/reference/makepayment.md): Make an outbound payment to the provided PayID or BSB/Account Number. Once made, you can poll for PaymentStatus using getPayment to determine whether or not the payment was settled to the payee.
- [Search for Payments.](https://developer.azupay.com.au/reference/searchpayment.md): Search for Payments
- [Get a Payment.](https://developer.azupay.com.au/reference/getpayment.md): Retrieves the status of a previous Make a Payment call. Use the contents of the response body to determine whether the payment has completed.
- [Create a Payment Agreement](https://developer.azupay.com.au/reference/createpaymentagreement.md): Create a Payment Agreement
- [Search for Payment Agreements.](https://developer.azupay.com.au/reference/searchpaymentagreement.md): Search for Payment Agreements
- [Amend a Payment Agreement](https://developer.azupay.com.au/reference/createpaymentagreementamendment.md): Amend a Payment Agreement
- [Change Status of a Payment Agreement](https://developer.azupay.com.au/reference/changestatusofpaymentagreement.md): Change the status of a Payment Agreement
- [Create or amend a Payment Scheduler](https://developer.azupay.com.au/reference/createorupdatepaymentscheduler.md): Creates a scheduler against an active payment agreement, or amends the existing one. Upsert keyed on paymentAgreementId. Amendments require the current version. Maps to POST…
- [Retrieve a Payment Scheduler](https://developer.azupay.com.au/reference/getpaymentscheduler.md): Returns the scheduler for the given payment agreement, with its current state. Maps to GET /paymentScheduler/{paymentAgreementId} on the internal Apps API.
- [Create a Payment Agreement Request](https://developer.azupay.com.au/reference/createpaymentagreementrequest.md): Create a Payment Agreement Request
- [Initiate a Payment](https://developer.azupay.com.au/reference/makepaymentinitiation.md): Initiate a Payment
- [Refund for Payment Initiation](https://developer.azupay.com.au/reference/refundpaymentinitation.md): Refund for Payment Initiation (PayTo Transactions)
- [Search for Payment Initiation](https://developer.azupay.com.au/reference/searchpaymentinitiation.md): Search for Payment Initiation (PayTo Transactions)
- [Get a Payment Initiation](https://developer.azupay.com.au/reference/getpaymentinitiation.md): Retrieves an existing Payment Initiation (PayTo Transaction).
- [Check account BSB for NPP and PayTo reachability.](https://developer.azupay.com.au/reference/enquireaccount.md): Check if NPP or AzupayTo payments can be sent to the account issuer identified by the given BSB.
- [Confirm the BSB/account number and name of a payee.](https://developer.azupay.com.au/reference/checkaccountdetails.md): The purpose of this operation is to validate the BSB/account number and name via Confirmation of Payee (CoP).
- [Check the status of the PayID.](https://developer.azupay.com.au/reference/checkpayid.md): Check if the PayID is registered and able to accept NPP and PayTo payments.  Also support validation of bsb and account number attached to the PayID.
- [Get Reports](https://developer.azupay.com.au/reference/getreport.md): Provides a list of reports that can be passed onto GET /report/download API endpoint. You can supply  `month + timezone` query parameters OR you can supply `fromDate + toDate`. The former provides…
- [Get Report download Url](https://developer.azupay.com.au/reference/downloadreport.md): Gets a time limited link to download the specified report
- [Get current balance](https://developer.azupay.com.au/reference/getbalance.md): Returns balance of your Azupay account.
- [Create or replace a client](https://developer.azupay.com.au/reference/createclient.md): Create new sub-clients. Sub-clients are children of your own client (master-client).  Duplicates can be prevented by using the same value in `clientTransactionId` in the request. It would also…
- [Disable a sub-client](https://developer.azupay.com.au/reference/deleteclient.md): Disable a sub-client. Sub-client is a child of your own client (master-client).  This API is only available to some Azupay customers. Please contact us for more information.
- [/clients/{clientId}/lowBalanceAlert/threshold](https://developer.azupay.com.au/reference/getclientlowbalancealertthreshold.md)
- [Set low balance threshold to trigger alerts](https://developer.azupay.com.au/reference/updateclientlowbalancealertthreshold.md): Set low balance threshold to trigger alerts when the balance goes lower than the specified limit. When this happens, an email is sent to the specified recipients.
- [/clients/{clientId}/lowBalanceAlert/emailAddresses](https://developer.azupay.com.au/reference/getclientlowbalancealertemailaddresses.md)
- [Set email addresses to send the low balance alerts](https://developer.azupay.com.au/reference/updateclientlowbalancealertemailaddresses.md): Set the email addresses to send the alerts when the balance goes lower than the specified limit.
- [Create API keys for Sub Merchants](https://developer.azupay.com.au/reference/apikeysprovision.md): Create API keys
- [Get API keys for Sub Merchants](https://developer.azupay.com.au/reference/getapikeys.md): Get API keys
- [Update API keys for Sub Merchants](https://developer.azupay.com.au/reference/updateapikeys.md): Update API keys
- [Gets an API key based on the API key ID.](https://developer.azupay.com.au/reference/getapikey.md): Get API key
- [Enable OAuth2 for a client](https://developer.azupay.com.au/reference/enableclientoauth2.md): Enable OAuth2 for a client
- [Get OAuth2 configuration for a client](https://developer.azupay.com.au/reference/getclientoauth2.md): Get OAuth2 configuration for a client
- [Get JSON Web Key Set](https://developer.azupay.com.au/reference/get_well-known-jwks-json.md): Returns the public key set in JWKS format for verifying JWT tokens issued by Azupay. This is a public endpoint served directly from S3 and automatically updated when keys are rotated.
- [Create cybersource card integration for client](https://developer.azupay.com.au/reference/createclientcard.md): Create card
- [Get client card information](https://developer.azupay.com.au/reference/getclientcard.md): Get client card
- [Update enabled status of Card](https://developer.azupay.com.au/reference/updateclientcard.md): Disable/Re-enable card
- [Create or amend a Payment Campaign](https://developer.azupay.com.au/reference/createorupdatepaymentcampaign.md): Creates the campaign for the calling client, or amends it. A client holds a single campaign and it is identified by the calling credentials, so no campaign identifier appears in the request. Omit…
- [List Payment Campaigns](https://developer.azupay.com.au/reference/listpaymentcampaigns.md): Returns the campaign held by the calling client. Takes no parameters - the client is identified by its credentials. Returns at most one record in this version, or an empty list. Maps to GET…

## Changelog
- [Latest transactions shown by default](https://developer.azupay.com.au/changelog/latest-transactions-shown-by-default.md)
- [View payment initiation details from payment agreement history](https://developer.azupay.com.au/changelog/view-payment-initiation-details-from-payment-agreement-history.md)
- [Count per period enforcement on Payment agreements for PayTo payment initiations](https://developer.azupay.com.au/changelog/count-per-period-enforcement-on-payment-agreements-for-payto-payment-initiations.md)
- [Clearer PayID payment instructions in Pay by Bank checkout](https://developer.azupay.com.au/changelog/clearer-payid-payment-instructions-in-pay-by-bank-checkout.md)
- [Refund error messaging for low float balances](https://developer.azupay.com.au/changelog/refund-error-messaging-for-low-float-balances.md)
- [Schedule visibility on the Payment Agreements - Azupay client dashboard](https://developer.azupay.com.au/changelog/schedule-visibility-on-the-payment-agreements-azupay-client-dashboard.md)
- [Daily reconciliation report for scheduled PayTo payments](https://developer.azupay.com.au/changelog/daily-reconciliation-report-for-scheduled-payto-payments.md)
- [Payment Scheduler for recurring PayTo payments](https://developer.azupay.com.au/changelog/payment-scheduler-for-recurring-payto-payments.md)
- [Improved handling of failed DE refunds](https://developer.azupay.com.au/changelog/improved-handling-of-failed-de-refunds.md)
- [Ad-hoc frequency for once-off PayTo agreements created via Pay by Bank](https://developer.azupay.com.au/changelog/ad-hoc-frequency-for-once-off-payto-agreements-created-via-pay-by-bank.md)