Up

Up API

The Up API gives you programmatic access to your balances and transaction data. You can request past transactions or set up webhooks to receive real-time…

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Up API 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, it’s exciting and it’s just the beginning.

Endpoints 18

Accounts

  • GETList accounts/accounts?page[size]=30&filter[accountType]=SAVER&filter[ownershipType]=INDIVIDUALRetrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the prev and…
  • GETRetrieve account/accounts/:idRetrieve a specific account by providing its unique identifier.

Categories

  • GETList categories/categories?filter[parent]=good-lifeRetrieve a list of all categories and their ancestry. The returned list is not paginated.
  • GETRetrieve category/categories/:idRetrieve a specific category by providing its unique identifier.
  • PATCHCategorize transaction/transactions/:transactionId/relationships/categoryUpdates the category associated with a transaction. Only transactions for which isCategorizable is set to true support this operation. The id is taken from…

Tags

  • GETList tags/tags?page[size]=50Retrieve a list of all tags currently in use. The returned list is paginated and can be scrolled by following the next and prev links where present. Results…
  • POSTAdd tags to transaction/transactions/:transactionId/relationships/tagsAssociates one or more tags with a specific transaction. No more than 6 tags may be present on any single transaction. Duplicate tags are silently ignored. An…
  • DELETERemove tags from transaction/transactions/:transactionId/relationships/tagsDisassociates one or more tags from a specific transaction. Tags that are not associated are silently ignored. An HTTP 204 is returned on success. The…

Transactions

  • GETList transactions by account/accounts/:accountId/transactions?page[size]=30&filter[status]=HELD&filter[since]=2020-01-01T01:02:03+10:00&filter[until]=2020-02-01T01:02:03+10:00&filter[category]=good-life&filter[tag]=HolidayRetrieve a list of all transactions for a specific account. The returned list is paginated and can be scrolled by following the next and prev links where…
  • GETList transactions/transactions?page[size]=30&filter[status]=HELD&filter[since]=2020-01-01T01:02:03+10:00&filter[until]=2020-02-01T01:02:03+10:00&filter[category]=good-life&filter[tag]=HolidayRetrieve a list of all transactions across all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following…
  • GETRetrieve transaction/transactions/:idRetrieve a specific transaction by providing its unique identifier.

Utility endpoints

  • GETPing/util/pingMake a basic ping request to the API. This is useful to verify that authentication is functioning correctly. On authentication success an HTTP 200 status is…

Webhooks

  • GETList webhooks/webhooks?page[size]=30Retrieve a list of configured webhooks. The returned list is paginated and can be scrolled by following the next and prev links where present. Results are…
  • POSTCreate webhook/webhooksCreate a new webhook with a given URL. The URL will receive webhook events as JSON-encoded POST requests. The URL must respond with a HTTP 200 status on…
  • GETRetrieve webhook/webhooks/:idRetrieve a specific webhook by providing its unique identifier.
  • DELETEDelete webhook/webhooks/:idDelete a specific webhook by providing its unique identifier. Once deleted, webhook events will no longer be sent to the configured URL.
  • GETList webhook logs/webhooks/:webhookId/logs?page[size]=30Retrieve a list of delivery logs for a webhook by providing its unique identifier. This is useful for analysis and debugging purposes. The returned list is…
  • POSTPing webhook/webhooks/:webhookId/pingSend a PING event to a webhook by providing its unique identifier. This is useful for testing and debugging purposes. The event is delivered asynchronously…

API details

Base URL
https://api.up.com.au/api/v1
Authentication
A bearer token in the Authorization header
Operations
18 operations on 15 pathsGET 12POST 3DELETE 2PATCH 1
Main resources
Webhooks 6Categories 3Tags 3Transactions 3Accounts 2Utility endpoints 1
Response formats
application/json
Description format
OpenAPI 3.0.3, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Up API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Up API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List accounts” (GET /accounts?page[size]=30&filter[accountType]=SAVER&filter[ownershipType]=INDIVIDUAL), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Up API?

The Up API gives you programmatic access to your balances and transaction data. You can request past transactions or set up webhooks to receive real-time… It is listed under Finance & banking and has 18 endpoints.

Who publishes the Up API?

It is listed from Up's public API description (an OpenAPI document), not published by Up on Swastik Codes. Anyone who controls up.com.au can claim the profile by adding a DNS TXT record.

What is the base URL of the Up API?

Requests go to https://api.up.com.au/api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Up API?

With A bearer token in the Authorization header.

How many endpoints does the Up API have?

18 operations on 15 paths (12 GET, 3 POST, 2 DELETE, 1 PATCH). The largest groups are Webhooks, Categories, Tags, Transactions.

Is forking the Up API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.