jupys / api

The Up Banking API Specification

⚡️ Up API

Let’s hack on banking together!

Calling all makers, creators, hackers, and hobbyists. Welcome to the first stage of Up’s API: a beta release that gives you programmatic access to your balances and transaction data. You can request past transactions or set up webhooks to receive real time events when new transactions hit your account. It’s new, exciting and just the beginning.

Links

• 🕶 The Up Website
• 📖 API Documentation
• 🕵️ API Issues and Support
• 🚀 API Changelog

Please ensure you keep any personal information out of issues submitted on this repository.

Getting Started

The Up API is currently in beta 🔧. Many features you would expect are notably absent but will be added over time. In this early phase access is limited to personal use only.

If you don’t already have an Up bank account, you can head over to https://up.com.au to download the app and create a free account. Terms and conditions apply.

Once you have an Up account, you can get your Personal Access Token at https://api.up.com.au.

Head on over and read the API documentation at https://developer.up.com.au once you have your access token ❤️.

The OpenAPI Specification

This repository contains the OpenAPI Specification for the Up API. Issues and feature requests relating to the Up API should be filed against this repository.

While the OpenAPI document is itself a valid OpenAPI schema, it includes some additional vendor-specific extensions to support automatic generation of documentation that would otherwise be difficult or impossible to achieve with OpenAPI alone. These vendor-specific extensions are prefixed with x-up:. Tools designed to support OpenAPI specification files should ignore these fields. Currently we only include x-up:example but we anticipate adding new x-up: prefixed fields over time as our documentation capability evolves.

Community Examples

You can find community provided example projects in community/EXAMPLES.md.