Pay Advantage provides an API for simpler integration into existing systems and applications; perfect for clients who need to automate the process of direct debiting or automate their customer and BPAY facilities.

The API has been written as a RESTful API and classes can be accessed using standard Post, Get, Put, and Delete actions. Responses are returned using JSON and examples of responses are included for easy reference.

A fully functioning Sandbox environment is available for testing which consists of a test web panel, test API and pre-filled test data.

Before access to the Live API can be switched you will need to contact Customer Service to discuss your implementation.


Configuration & Authentication

Restrictions, Performance & Best Practice

Sandbox Environment & Transaction Simulation



Have more questions? Submit a request