canonical: https://jentic.com/apis/up.com.au/up-com-au

# 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 events when new transactions hit your account. It’s new, it’s exciting and it’s just the beginning. The API exposes 20 endpoints secured with bearer authentication.

## For AI agents

Programmatically list accounts, retrieve account. Covers 20 operations with bearer authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- List accounts
- Retrieve account
- Categorize transaction
- Query and filter Up API records by parameters
- Monitor Up API operational status and events

## Use cases

### Payments Operations

Use the Up API to perform payments operations programmatically. The API provides 20 endpoints covering core functionality including list accounts, retrieve account, list attachments.

Example prompt: Call GET /accounts to list accounts

### Automated Accounts Management

Automate accounts operations by combining multiple Up API endpoints. Agents can retrieve account and then list attachments in a single workflow.

Example prompt: Call GET `/accounts/{id}` to retrieve account, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Up API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'list accounts', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/accounts` | List accounts |
| GET | `/accounts/{id}` | Retrieve account |
| GET | `/attachments` | List attachments |
| GET | `/attachments/{id}` | Retrieve attachment |
| GET | `/categories` | List categories |
| GET | `/categories/{id}` | Retrieve category |
| PATCH | `/transactions/{transactionId}/relationships/category` | Categorize transaction |
| GET | `/util/ping` | Ping |

## Key resources

- **Accounts** — Accounts represent the underlying store used to track balances
and the transactions that have occurr
- **Categories** — Categories enable understanding where your money goes by driving
 powerful insights in Up. All categ
- **Tags** — Tags are custom labels that can be associated with transactions
 on Up. Within the Up application, t
- **Transactions** — Transactions represent the movement of money into and out of an
 account. They have many characteris
- **Attachments** — Attachments represent uploaded files that are attached to transactions, these are commonly receipts.

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 54 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 74 / 100
  - Developer Experience & Jentic Compatibility: 59 / 100
  - AI-Readiness & Agent Experience: 31 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 79 / 100
- **View full report:** https://jentic.com/apis/up.com.au/up-com-au/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Up API by hand means attaching a bearer token on every call, matching each account, transaction, and category operation to its request shape, and handling pagination yourself. Through Jentic you install once, import the Up API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Up puts the account and transaction ids in the URL path (`/accounts/{id}` and `/transactions/{transactionId}/...`), so a rule can pin your agent to one account: it can read that account and nothing else. You choose the operations it may call, so a write like changing a transaction's category is not included unless you add it.
- **Credential handling:** Your Up token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list accounts' or 'read a transaction', and Jentic returns the matching Up operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Up API use?

The Up API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list accounts with the Up API?

Yes. Use the GET /accounts endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Up API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list accounts through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list accounts'. Jentic returns the matching Up API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Up API have?

The Up API exposes 20 endpoints covering accounts, categories, tags operations.

### Can I limit what my agent is allowed to do with the Up API?

Yes. Because Up puts the account and transaction ids in the URL path, such as `/accounts/{id}` and `/transactions/{transactionId}/relationships/category`, a rule in your self-hosted Jentic One instance can pin your agent to a single account so it reads that account and nothing else. You decide which operations the agent may call, so read-only calls like GET /accounts and GET /transactions can be allowed while a write such as categorizing a transaction stays out of reach unless you add it. Since Jentic One runs on your own infrastructure, those rules and the stored token are governed entirely by you.