It takes just a couple of steps to get up and running. If you’re not yet an Upsider the first thing you’ll need to do is sign up here: https://up.com.au/download/. Great! Let’s go to the next step.
Your personal access token is the key to your financial kingdom. Guard it fiercely and never share it online or give it out. If you are worried it may have fallen into the wrong hands it’s easy to generate a new one (and expire the old one) - see below.
1. Open the Up app on your phone, swipe right and select "Data sharing".
2. Tap on ‘Personal Access Token’.
3. Select ‘Generate a token’.
4. Select how long you would like the token to last.
5. Follow the prompts to generate your token
6. Presto! You now have a Personal Access Token. Copy this and store it safely.
Head over to https://api.up.com.au for an alternative way to claim your access token.
1. Open the Up app, swipe right and select "Data sharing".
2. Tap on ‘Personal Access Token’.
3. Tap ‘Generate a token’ and follow the prompts.
1. Open the Up app, swipe right and select "Data sharing"
2. Tap on ‘Personal Access Token’.
3. Tap ‘Revoke existing token’ and select confirm
Ok let's get our hands dirty! The simplest request in the book is to first verify that your token works.
To test your access token, make a request to the /util/ping
endpoint. You'll need to put your access token in the Authorization
header like so:
Authorization: Bearer $your_access_token
Replace $your_access_token
with your personal access token.
You should get a JSON response with a HTTP 200
status.
Sample Request
curl https://api.up.com.au/api/v1/util/ping \-H "Authorization: Bearer $your_access_token"
Sample Response
{"meta": {"id": "3b5d17a4-6778-48dc-ae7d-9f8aace2e2fc","statusEmoji": "⚡️"}}
If the Authorization
header is missing, is malformed, or contains an invalid access token, an error response will be returned with a HTTP 401
status.
v1
(beta). New endpoints will be added over time and existing endpoints will be extended. Some endpoints or fields within an endpoint may be deprecated, but nothing will be removed within any given version, in order to maintain backwards compatibility with existing clients.The endpoints documented in this reference must all be appended to the base URL before they can be called.
https://api.up.com.au/api/v1
For example, the GET /accounts
endpoint is callable at
https://api.up.com.au/api/v1/accounts
Authorization
header. The bearer scheme is used to construct the Authorization
header.Sample Header
Authorization: Bearer $your_access_token
Replace $your_access_token
with your personal access token.
Currently the Up Banking API is only available for use with a personal access token, which can be obtained in-app or by visiting api.up.com.au and following the prompts.
Only one personal access token can be used at a time. You can generate a new personal access token or revoke an existing one by opening the Up app, swiping right and selecting Data Sharing from the list of settings.
links
field at the top-level of the response JSON and its data
field contains an array of resources specific to the endpoint.Sample Response
{"data": [...],"links": {"prev": "https://api.up.com.au/api/v1/accounts?page[before]=x","next": "https://api.up.com.au/api/v1/accounts?page[after]=y"}}
prev
and next
links to move between pages.On each page of results, the client consumes each of the resources contained in the data
array. Forwards pagination is achieved by following the next
link repeatedly until the next
link is set to null
. When the next
link is null
, there are no more pages available and pagination terminates. Backwards pagination is achieved by following the prev
link repeatedly until the prev
link is set to null
. When the prev
link is null
, there are no more pages available and pagination terminates.
Endpoints that support pagination accept a page[size]
query parameter. This value must be a positive integer and is generally constrained to an upper limit of 100
, however individual endpoints may impose different constraints.
Sample URL
https://api.up.com.au/api/v1/accounts?page[size]=10
When the page[size]
is specified, no more than page[size]
resources will be included in the response's data
field. This parameter is set to a sensible default, which varies depending on the endpoint.
2xx
range. Error responses will usually be in the 4xx
range, or more rarely, in the 5xx
range.200
Successful response: Everything worked as intended
201
Successful response: A new resource was created successfully—Typically used with POST requests.
204
Successful response: No content—typically used with DELETE requests.
400
Bad request: Typically a problem with the query string or an encoding error.
401
Not authorized: The request was not authenticated.
404
Not found: Either the endpoint does not exist, or the requested resource does not exist.
422
Invalid request: The request contains invalid data and was not processed.
429
Too many requests: You have been rate limited—try later, ideally with exponential backoff. The X-RateLimit-Remaining response header shows the number remaining.
500 502 503 504
Server-side errors: Try again later.
When a response is received in the 4xx
or 5xx
range, it includes errors that should be referred for more detail.
Generic error response that returns one or more errors.
errors
Array [ErrorObject]
The list of errors returned in this response.
status
string
The HTTP status code associated with this error. This can also be obtained from the response headers. The status indicates the broad type of error according to HTTP semantics.
title
string
A short description of this error. This should be stable across multiple occurrences of this type of error and typically expands on the reason for the status code.
detail
string
A detailed description of this error. This should be considered unique to individual occurrences of an error and subject to change. It is useful for debugging purposes.
source
object
If applicable, location in the request that this error relates to. This may be a parameter in the query string, or a an attribute in the request body.
parameter
string
If this error relates to a query parameter, the name of the parameter.
pointer
string
If this error relates to an attribute in the request body, a rfc-6901 JSON pointer to the attribute.
Sample Response
{"errors": [{"status": "422","title": "Invalid Request Payload","detail": "fixed value \"tags\" required","source": {"pointer": "/data/0/type"}}]}
Clients should typically convert these error responses to exceptions and handle them as necessary.
Accounts represent the underlying store used to track balances
and the transactions that have occurred to modify those balances
over time. Up currently has three types of account: SAVER
—used to
earn interest and to hit savings goals, TRANSACTIONAL
—used
for everyday spending, and HOME_LOAN
-for those with an Up Home loan.
GET /accounts
Retrieve 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 next
links where present.
page[size]
integer
The number of records to return in each page.
?page[size]=30
filter[accountType]
The type of account for which to return records. This can be used to filter Savers from spending accounts.
?filter[accountType]=SAVER
filter[ownershipType]
The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts.
?filter[ownershipType]=INDIVIDUAL
"+"
must be encoded as "%2B"
in order to be received as a plus-sign and not as a space character.data
Array [AccountResource]
The list of accounts returned in this response.
type
string
The type of this resource: accounts
id
string
The unique identifier for this account.
attributes
object
displayName
string
The name associated with the account in the Up application.
accountType
AccountTypeEnum
The bank account type of this account.
ownershipType
OwnershipTypeEnum
The ownership structure for this account.
balance
MoneyObject
The available balance of the account, taking into account any amounts that are currently on hold.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
createdAt
string (date-time)
The date-time at which this account was first opened.
relationships
object
transactions
object
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
links
object
prev
string
The link to the previous page in the results. If this value is null
there is no previous page.
next
string
The link to the next page in the results. If this value is null
there is no next page.
Sample Request
curl https://api.up.com.au/api/v1/accounts \-G \-H 'Authorization: Bearer up:demo:R7Z1R13VmnKxBYwr' \-d 'page[size]=1'
Sample Response
{"data": [{"type": "accounts","id": "55682b09-e622-487f-8e19-4a82e0042d18","attributes": {"displayName": "Spending","accountType": "TRANSACTIONAL","ownershipType": "INDIVIDUAL","balance": {"currencyCode": "AUD","value": "1.00","valueInBaseUnits": 100},"createdAt": "2024-11-06T10:15:17+11:00"},"relationships": {"transactions": {"links": {"related": "https://api.up.com.au/api/v1/accounts/55682b09-e622-487f-8e19-4a82e0042d18/transactions"}}},"links": {"self": "https://api.up.com.au/api/v1/accounts/55682b09-e622-487f-8e19-4a82e0042d18"}}],"links": {"prev": null,"next": "https://api.up.com.au/api/v1/accounts?page%5Bafter%5D=WyIyMDI0LTExLTA1VDIzOjE1OjE3LjQ2ODI1NDAwMFoiLCI1NTY4MmIwOS1lNjIyLTQ4N2YtOGUxOS00YTgyZTAwNDJkMTgiXQ%3D%3D&page%5Bsize%5D=1"}}
GET /accounts/{id}
Retrieve a specific account by providing its unique identifier.
id
string
The unique identifier for the account.
0c328d90-fc76-4de6-9735-f63cae3d8eb6
data
AccountResource
The account returned in this response.
type
string
The type of this resource: accounts
id
string
The unique identifier for this account.
attributes
object
displayName
string
The name associated with the account in the Up application.
accountType
AccountTypeEnum
The bank account type of this account.
ownershipType
OwnershipTypeEnum
The ownership structure for this account.
balance
MoneyObject
The available balance of the account, taking into account any amounts that are currently on hold.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
createdAt
string (date-time)
The date-time at which this account was first opened.
relationships
object
transactions
object
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
Sample Request
curl https://api.up.com.au/api/v1/accounts/03495eed-ceb2-473b-858f-8e7215daf8d7 \-H 'Authorization: Bearer up:demo:8FdifmO77q08MR9I'
Sample Response
{"data": {"type": "accounts","id": "03495eed-ceb2-473b-858f-8e7215daf8d7","attributes": {"displayName": "🐷 Savings","accountType": "SAVER","ownershipType": "INDIVIDUAL","balance": {"currencyCode": "AUD","value": "125.36","valueInBaseUnits": 12536},"createdAt": "2024-11-06T10:15:19+11:00"},"relationships": {"transactions": {"links": {"related": "https://api.up.com.au/api/v1/accounts/03495eed-ceb2-473b-858f-8e7215daf8d7/transactions"}}},"links": {"self": "https://api.up.com.au/api/v1/accounts/03495eed-ceb2-473b-858f-8e7215daf8d7"}}}
Attachments represent uploaded files that are attached to transactions, these are commonly receipts.
GET /attachments
Retrieve a list of all attachments. The returned list is paginated and can
be scrolled by following the next
and prev
links where present.
data
Array [AttachmentResource]
The list of attachments returned in this response.
type
string
The type of this resource: attachments
id
string
The unique identifier for this attachment.
attributes
object
createdAt
string (date-time)
The date-time when the file was created.
fileURL
string
A temporary link to download the file.
fileURLExpiresAt
string (date-time)
The date-time at which the fileURL
link expires.
fileExtension
string
File extension for the uploaded attachment.
fileContentType
string
Content type for the uploaded attachment.
relationships
object
transaction
object
data
object
type
string
The type of this resource: transactions
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
links
object
prev
string
The link to the previous page in the results. If this value is null
there is no previous page.
next
string
The link to the next page in the results. If this value is null
there is no next page.
Sample Request
curl https://api.up.com.au/api/v1/attachments \-H 'Authorization: Bearer up:demo:G5hXKtL2dK4jN1SV'
Sample Response
{"data": [{"type": "attachments","id": "e42be4a1-c85d-43e0-a99d-4ad0213d172c","attributes": {"createdAt": "2024-11-06T10:15:20+11:00","fileURL": "http://localhost:8080/asset/customer_transaction_attachment.jpg?filename=uploads%2Fcustomer_transaction_attachments%2Fmodels%2Fattachment%2Ffile%2F1%2Fattachment.jpg×tamp=1730848520&token=70c1895adf7889db4d65645380aa204dc231b4a0657bc3dbf1ccd40833177683","fileURLExpiresAt": "2024-11-06T10:30:20+11:00","fileExtension": "jpg","fileContentType": "image/jpeg"},"relationships": {"transaction": {"data": {"type": "transactions","id": "c048de3a-bb61-4620-9223-6930b0141693"},"links": {"related": "https://api.up.com.au/api/v1/transactions/c048de3a-bb61-4620-9223-6930b0141693"}}},"links": {"self": "https://api.up.com.au/api/v1/attachments/e42be4a1-c85d-43e0-a99d-4ad0213d172c"}},{"type": "attachments","id": "5608cf34-8c13-459b-b2ed-f54107a03c95","attributes": {"createdAt": "2024-11-06T10:15:20+11:00","fileURL": "http://localhost:8080/asset/customer_transaction_attachment.jpg?filename=uploads%2Fcustomer_transaction_attachments%2Fmodels%2Fattachment%2Ffile%2F2%2Fattachment.jpg×tamp=1730848520&token=751afc6a249b12c783319d9d52ea1646f139523c3108890737d58457f5ef3777","fileURLExpiresAt": "2024-11-06T10:30:20+11:00","fileExtension": "jpg","fileContentType": "image/jpeg"},"relationships": {"transaction": {"data": {"type": "transactions","id": "6fd75ce6-a943-4ffe-87c9-011bf82214d0"},"links": {"related": "https://api.up.com.au/api/v1/transactions/6fd75ce6-a943-4ffe-87c9-011bf82214d0"}}},"links": {"self": "https://api.up.com.au/api/v1/attachments/5608cf34-8c13-459b-b2ed-f54107a03c95"}}],"links": {"prev": null,"next": null}}
GET /attachments/{id}
Retrieve a specific attachment by providing its unique identifier.
id
string
The unique identifier for the attachment.
b3576382-ad94-4f56-bb7d-43dd94ae0556
data
AttachmentResource
The attachment returned in this response.
type
string
The type of this resource: attachments
id
string
The unique identifier for this attachment.
attributes
object
createdAt
string (date-time)
The date-time when the file was created.
fileURL
string
A temporary link to download the file.
fileURLExpiresAt
string (date-time)
The date-time at which the fileURL
link expires.
fileExtension
string
File extension for the uploaded attachment.
fileContentType
string
Content type for the uploaded attachment.
relationships
object
transaction
object
data
object
type
string
The type of this resource: transactions
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
Sample Request
curl https://api.up.com.au/api/v1/attachments/5ee1625b-9c77-474a-a3bc-abf5e754b655 \-H 'Authorization: Bearer up:demo:3ey0d13ByjWrl9ux'
Sample Response
{"data": {"type": "attachments","id": "5ee1625b-9c77-474a-a3bc-abf5e754b655","attributes": {"createdAt": "2024-11-06T10:15:22+11:00","fileURL": "http://localhost:8080/asset/customer_transaction_attachment.jpg?filename=uploads%2Fcustomer_transaction_attachments%2Fmodels%2Fattachment%2Ffile%2F5%2Fattachment.jpg×tamp=1730848522&token=b457bc45da8c7f3b7f51db5a98f2815cbd488c6e4ef17d2785bb7449c4960e1e","fileURLExpiresAt": "2024-11-06T10:30:22+11:00","fileExtension": "jpg","fileContentType": "image/jpeg"},"relationships": {"transaction": {"data": {"type": "transactions","id": "f473420a-e3c3-4b3d-aa70-42f594af1263"},"links": {"related": "https://api.up.com.au/api/v1/transactions/f473420a-e3c3-4b3d-aa70-42f594af1263"}}},"links": {"self": "https://api.up.com.au/api/v1/attachments/5ee1625b-9c77-474a-a3bc-abf5e754b655"}}}
Categories enable understanding where your money goes by driving powerful insights in Up. All categories in Up are pre-defined and are automatically assigned to new purchases in most cases. A parent-child relationship is used to represent categories, however parent categories cannot be directly assigned to transactions.
GET /categories
Retrieve a list of all categories and their ancestry. The returned list is not paginated.
filter[parent]
string
The unique identifier of a parent category for which to
return only its children. Providing an invalid category
identifier results in a 404
response.
?filter[parent]=good-life
"+"
must be encoded as "%2B"
in order to be received as a plus-sign and not as a space character.data
Array [CategoryResource]
The list of categories returned in this response.
type
string
The type of this resource: categories
id
string
The unique identifier for this category. This is a human-readable but URL-safe value.
attributes
object
name
string
The name of this category as seen in the Up application.
relationships
object
parent
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
children
object
data
Array [object]
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
Sample Request
curl https://api.up.com.au/api/v1/categories \-G \-H 'Authorization: Bearer up:demo:zEqSeGMJLPkySo3x' \-d 'filter[parent]=good-life'
Sample Response
{"data": [{"type": "categories","id": "hobbies","attributes": {"name": "Hobbies"},"relationships": {"parent": {"data": {"type": "categories","id": "good-life"},"links": {"related": "https://api.up.com.au/api/v1/categories/good-life"}},"children": {"data": [],"links": {"related": "https://api.up.com.au/api/v1/categories?filter%5Bparent%5D=hobbies"}}},"links": {"self": "https://api.up.com.au/api/v1/categories/hobbies"}},{"type": "categories","id": "restaurants-and-cafes","attributes": {"name": "Restaurants & Cafes"},"relationships": {"parent": {"data": {"type": "categories","id": "good-life"},"links": {"related": "https://api.up.com.au/api/v1/categories/good-life"}},"children": {"data": [],"links": {"related": "https://api.up.com.au/api/v1/categories?filter%5Bparent%5D=restaurants-and-cafes"}}},"links": {"self": "https://api.up.com.au/api/v1/categories/restaurants-and-cafes"}}]}
GET /categories/{id}
Retrieve a specific category by providing its unique identifier.
id
string
The unique identifier for the category.
restaurants-and-cafes
data
CategoryResource
The category returned in this response.
type
string
The type of this resource: categories
id
string
The unique identifier for this category. This is a human-readable but URL-safe value.
attributes
object
name
string
The name of this category as seen in the Up application.
relationships
object
parent
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
children
object
data
Array [object]
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
Sample Request
curl https://api.up.com.au/api/v1/categories/home \-H 'Authorization: Bearer up:demo:St17LTYvbnF6roAQ'
Sample Response
{"data": {"type": "categories","id": "home","attributes": {"name": "Home"},"relationships": {"parent": {"data": null},"children": {"data": [{"type": "categories","id": "groceries"}],"links": {"related": "https://api.up.com.au/api/v1/categories?filter%5Bparent%5D=home"}}},"links": {"self": "https://api.up.com.au/api/v1/categories/home"}}}
PATCH /transactions/{transactionId}/relationships/category
Updates the category associated with a transaction. Only transactions
for which isCategorizable
is set to true support this operation. The
id
is taken from the list exposed on /categories
and cannot be one of
the top-level (parent) categories. To de-categorize a transaction, set
the entire data
key to null
. An HTTP 204
is returned on success.
The associated category, along with its request URL is also exposed via
the category
relationship on the transaction resource returned from
/transactions/{id}
.
transactionId
string
The unique identifier for the transaction.
5f279c23-49a5-4855-90ac-fd5cf1575b65
data
CategoryInputResourceIdentifier
The category to set on the transaction. Set this entire key to null
de-categorize a transaction.
type
string
The type of this resource: categories
id
string
The unique identifier of the category, as returned by the /categories
endpoint.
Sample Request
curl https://api.up.com.au/api/v1/transactions/5fed9694-ade3-4dd9-b321-16e7e6a6d828/relationships/category \-XPATCH \-H 'Authorization: Bearer up:demo:cuCc9kABCFyaZHSN' \-H 'Content-Type: application/json' \--data-binary '{"data": {"type": "categories","id": "restaurants-and-cafes"}}'
Transactions represent the movement of money into and out of an
account. They have many characteristics that vary depending on
the kind of transaction. Transactions may be temporarily HELD
(pending) or SETTLED
, typically depending on which payment
method was used at the point of sale.
GET /transactions
Retrieve a list of all transactions across all accounts for the currently
authenticated user. The returned list is paginated and can
be scrolled by following the next
and prev
links where present. To
narrow the results to a specific date range pass one or both of
filter[since]
and filter[until]
in the query string. These filter
parameters should not be used for pagination. Results are ordered
newest first to oldest last.
page[size]
integer
The number of records to return in each page.
?page[size]=30
filter[status]
The transaction status for which to return records. This
can be used to filter HELD
transactions from those
that are SETTLED
.
?filter[status]=HELD
filter[since]
string
The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
?filter[since]=2020-01-01T01:02:03+10:00
filter[until]
string
The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
?filter[until]=2020-02-01T01:02:03+10:00
filter[category]
string
The category identifier for which to filter transactions.
Both parent and child categories can be filtered through
this parameter. Providing an invalid category identifier
results in a 404
response.
?filter[category]=good-life
filter[tag]
string
A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is given.
?filter[tag]=Holiday
"+"
must be encoded as "%2B"
in order to be received as a plus-sign and not as a space character.data
Array [TransactionResource]
The list of transactions returned in this response.
type
string
The type of this resource: transactions
id
string
The unique identifier for this transaction.
attributes
object
status
TransactionStatusEnum
The current processing status of this transaction, according to whether or not this transaction has settled or is still held.
rawText
string
The original, unprocessed text of the transaction. This is often not a perfect indicator of the actual merchant, but it is useful for reconciliation purposes in some cases.
description
string
A short description for this transaction. Usually the merchant name for purchases.
message
string
Attached message for this transaction, such as a payment message, or a transfer note.
isCategorizable
boolean
Boolean flag set to true on transactions that support the use of categories.
holdInfo
HoldInfoObject
If this transaction is currently in the HELD
status, or was ever in
the HELD
status, the amount
and foreignAmount
of the
transaction while HELD
.
amount
MoneyObject
The amount of this transaction while in the HELD
status, in
Australian dollars.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
foreignAmount
MoneyObject
The foreign currency amount of this transaction while in the HELD
status. This field will be null
for domestic transactions. The amount
was converted to the AUD amount reflected in the amount
field.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
roundUp
RoundUpObject
Details of how this transaction was rounded-up. If no Round Up was
applied this field will be null
.
amount
MoneyObject
The total amount of this Round Up, including any boosts, represented as a negative value.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
boostPortion
MoneyObject
The portion of the Round Up amount
owing to boosted Round Ups,
represented as a negative value. If no boost was added to the Round Up
this field will be null
.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
cashback
CashbackObject
If all or part of this transaction was instantly reimbursed in the form of cashback, details of the reimbursement.
description
string
A brief description of why this cashback was paid.
amount
MoneyObject
The total amount of cashback paid, represented as a positive value.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
amount
MoneyObject
The amount of this transaction in Australian dollars. For
transactions that were once HELD
but are now SETTLED
, refer to
the holdInfo
field for the original amount
the transaction was
HELD
at.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
foreignAmount
MoneyObject
The foreign currency amount of this transaction. This field will be
null
for domestic transactions. The amount was converted to the AUD
amount reflected in the amount
of this transaction. Refer to the
holdInfo
field for the original foreignAmount
the transaction was
HELD
at.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
cardPurchaseMethod
CardPurchaseMethodObject
Information about the card used for this transaction, if applicable.
method
CardPurchaseMethodEnum
The type of card purchase.
cardNumberSuffix
string
The last four digits of the card used for the purchase, if applicable.
settledAt
string (date-time)
The date-time at which this transaction settled. This field will be
null
for transactions that are currently in the HELD
status.
createdAt
string (date-time)
The date-time at which this transaction was first encountered.
transactionType
string
A description of the transaction method used e.g. Purchase, BPAY Payment.
note
NoteObject
A customer provided note about the transaction. Can only be provided by Up High subscribers.
text
string
A text note about the transaction.
performingCustomer
CustomerObject
The customer who initated the transaction. For 2Up accounts this could be the customer who's card was used.
displayName
string
The Upname or preferred name of the customer
deepLinkURL
string
A deep link to the transaction receipt screen in-app.
relationships
object
account
object
data
object
type
string
The type of this resource: accounts
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
transferAccount
object
If this transaction is a transfer between accounts, this relationship
will contain the account the transaction went to/came from. The
amount
field can be used to determine the direction of the transfer.
data
object
type
string
The type of this resource: accounts
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
category
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
self
string
The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
related
string
The link to retrieve the related resource(s) in this relationship.
parentCategory
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
tags
object
data
Array [object]
type
string
The type of this resource: tags
id
string
The label of the tag, which also acts as the tag’s unique identifier.
links
object
self
string
The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
attachment
object
data
object
type
string
The type of this resource: attachments
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
links
object
prev
string
The link to the previous page in the results. If this value is null
there is no previous page.
next
string
The link to the next page in the results. If this value is null
there is no next page.
Sample Request
curl https://api.up.com.au/api/v1/transactions \-G \-H 'Authorization: Bearer up:demo:h792Bjy0P47iTVFE' \-d 'page[size]=1' \-d 'filter[tag]=Pizza Night' \-d 'filter[status]=SETTLED'
Sample Response
{"data": [{"type": "transactions","id": "030b6725-172d-4dce-88ad-1b15e2d0a5d6","attributes": {"status": "SETTLED","rawText": null,"description": "David Taylor","message": "Money for the pizzas last night.","isCategorizable": true,"holdInfo": null,"roundUp": null,"cashback": null,"amount": {"currencyCode": "AUD","value": "-59.98","valueInBaseUnits": -5998},"foreignAmount": null,"cardPurchaseMethod": null,"settledAt": "2024-11-05T03:13:40+11:00","createdAt": "2024-11-05T03:13:40+11:00","transactionType": null,"note": null,"performingCustomer": {"displayName": "Bobby"},"deepLinkURL": "up://transaction/VHJhbnNhY3Rpb24tMzg="},"relationships": {"account": {"data": {"type": "accounts","id": "b91c9df5-c491-4aa6-b417-fc1e2186a7f2"},"links": {"related": "https://api.up.com.au/api/v1/accounts/b91c9df5-c491-4aa6-b417-fc1e2186a7f2"}},"transferAccount": {"data": null},"category": {"data": null,"links": {"self": "https://api.up.com.au/api/v1/transactions/030b6725-172d-4dce-88ad-1b15e2d0a5d6/relationships/category"}},"parentCategory": {"data": null},"tags": {"data": [{"type": "tags","id": "Pizza Night"}],"links": {"self": "https://api.up.com.au/api/v1/transactions/030b6725-172d-4dce-88ad-1b15e2d0a5d6/relationships/tags"}},"attachment": {"data": null}},"links": {"self": "https://api.up.com.au/api/v1/transactions/030b6725-172d-4dce-88ad-1b15e2d0a5d6"}}],"links": {"prev": null,"next": null}}
GET /transactions/{id}
Retrieve a specific transaction by providing its unique identifier.
id
string
The unique identifier for the transaction.
d1caa614-fd5c-4e26-9f65-7e1ac8caefd3
data
TransactionResource
The transaction returned in this response.
type
string
The type of this resource: transactions
id
string
The unique identifier for this transaction.
attributes
object
status
TransactionStatusEnum
The current processing status of this transaction, according to whether or not this transaction has settled or is still held.
rawText
string
The original, unprocessed text of the transaction. This is often not a perfect indicator of the actual merchant, but it is useful for reconciliation purposes in some cases.
description
string
A short description for this transaction. Usually the merchant name for purchases.
message
string
Attached message for this transaction, such as a payment message, or a transfer note.
isCategorizable
boolean
Boolean flag set to true on transactions that support the use of categories.
holdInfo
HoldInfoObject
If this transaction is currently in the HELD
status, or was ever in
the HELD
status, the amount
and foreignAmount
of the
transaction while HELD
.
amount
MoneyObject
The amount of this transaction while in the HELD
status, in
Australian dollars.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
foreignAmount
MoneyObject
The foreign currency amount of this transaction while in the HELD
status. This field will be null
for domestic transactions. The amount
was converted to the AUD amount reflected in the amount
field.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
roundUp
RoundUpObject
Details of how this transaction was rounded-up. If no Round Up was
applied this field will be null
.
amount
MoneyObject
The total amount of this Round Up, including any boosts, represented as a negative value.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
boostPortion
MoneyObject
The portion of the Round Up amount
owing to boosted Round Ups,
represented as a negative value. If no boost was added to the Round Up
this field will be null
.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
cashback
CashbackObject
If all or part of this transaction was instantly reimbursed in the form of cashback, details of the reimbursement.
description
string
A brief description of why this cashback was paid.
amount
MoneyObject
The total amount of cashback paid, represented as a positive value.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
amount
MoneyObject
The amount of this transaction in Australian dollars. For
transactions that were once HELD
but are now SETTLED
, refer to
the holdInfo
field for the original amount
the transaction was
HELD
at.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
foreignAmount
MoneyObject
The foreign currency amount of this transaction. This field will be
null
for domestic transactions. The amount was converted to the AUD
amount reflected in the amount
of this transaction. Refer to the
holdInfo
field for the original foreignAmount
the transaction was
HELD
at.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
cardPurchaseMethod
CardPurchaseMethodObject
Information about the card used for this transaction, if applicable.
method
CardPurchaseMethodEnum
The type of card purchase.
cardNumberSuffix
string
The last four digits of the card used for the purchase, if applicable.
settledAt
string (date-time)
The date-time at which this transaction settled. This field will be
null
for transactions that are currently in the HELD
status.
createdAt
string (date-time)
The date-time at which this transaction was first encountered.
transactionType
string
A description of the transaction method used e.g. Purchase, BPAY Payment.
note
NoteObject
A customer provided note about the transaction. Can only be provided by Up High subscribers.
text
string
A text note about the transaction.
performingCustomer
CustomerObject
The customer who initated the transaction. For 2Up accounts this could be the customer who's card was used.
displayName
string
The Upname or preferred name of the customer
deepLinkURL
string
A deep link to the transaction receipt screen in-app.
relationships
object
account
object
data
object
type
string
The type of this resource: accounts
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
transferAccount
object
If this transaction is a transfer between accounts, this relationship
will contain the account the transaction went to/came from. The
amount
field can be used to determine the direction of the transfer.
data
object
type
string
The type of this resource: accounts
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
category
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
self
string
The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
related
string
The link to retrieve the related resource(s) in this relationship.
parentCategory
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
tags
object
data
Array [object]
type
string
The type of this resource: tags
id
string
The label of the tag, which also acts as the tag’s unique identifier.
links
object
self
string
The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
attachment
object
data
object
type
string
The type of this resource: attachments
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
Sample Request
curl https://api.up.com.au/api/v1/transactions/faa904e7-f1b1-4655-a82f-c56a13e3016e \-H 'Authorization: Bearer up:demo:wj79hE0tLhbdkI5o'
Sample Response
{"data": {"type": "transactions","id": "faa904e7-f1b1-4655-a82f-c56a13e3016e","attributes": {"status": "SETTLED","rawText": "WARUNG BEBEK, UBUD INDONES","description": "Warung Bebek Bengil","message": null,"isCategorizable": true,"holdInfo": {"amount": {"currencyCode": "AUD","value": "-107.92","valueInBaseUnits": -10792},"foreignAmount": null},"roundUp": {"amount": {"currencyCode": "AUD","value": "-0.08","valueInBaseUnits": -8},"boostPortion": null},"cashback": null,"amount": {"currencyCode": "AUD","value": "-107.92","valueInBaseUnits": -10792},"foreignAmount": {"currencyCode": "IDR","value": "-1053698.77","valueInBaseUnits": -105369877},"cardPurchaseMethod": {"method": "CARD_ON_FILE","cardNumberSuffix": "0001"},"settledAt": "2024-11-03T04:00:00+11:00","createdAt": "2024-11-03T04:00:00+11:00","transactionType": null,"note": null,"performingCustomer": {"displayName": "Bobby"},"deepLinkURL": "up://transaction/VHJhbnNhY3Rpb24tNDY="},"relationships": {"account": {"data": {"type": "accounts","id": "b8ed0786-1a6a-4b53-85e7-e7ee12d96e95"},"links": {"related": "https://api.up.com.au/api/v1/accounts/b8ed0786-1a6a-4b53-85e7-e7ee12d96e95"}},"transferAccount": {"data": null},"category": {"data": null,"links": {"self": "https://api.up.com.au/api/v1/transactions/faa904e7-f1b1-4655-a82f-c56a13e3016e/relationships/category"}},"parentCategory": {"data": null},"tags": {"data": [],"links": {"self": "https://api.up.com.au/api/v1/transactions/faa904e7-f1b1-4655-a82f-c56a13e3016e/relationships/tags"}},"attachment": {"data": null}},"links": {"self": "https://api.up.com.au/api/v1/transactions/faa904e7-f1b1-4655-a82f-c56a13e3016e"}}}
GET /accounts/{accountId}/transactions
Retrieve 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 present. To narrow the results to a
specific date range pass one or both of filter[since]
and
filter[until]
in the query string. These filter parameters
should not be used for pagination. Results are ordered newest first
to oldest last.
accountId
string
The unique identifier for the account.
81e22b3f-8e3c-4539-a3f9-a3a47d84f357
page[size]
integer
The number of records to return in each page.
?page[size]=30
filter[status]
The transaction status for which to return records. This
can be used to filter HELD
transactions from those
that are SETTLED
.
?filter[status]=HELD
filter[since]
string
The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
?filter[since]=2020-01-01T01:02:03+10:00
filter[until]
string
The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
?filter[until]=2020-02-01T01:02:03+10:00
filter[category]
string
The category identifier for which to filter transactions.
Both parent and child categories can be filtered through
this parameter. Providing an invalid category identifier
results in a 404
response.
?filter[category]=good-life
filter[tag]
string
A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is given.
?filter[tag]=Holiday
"+"
must be encoded as "%2B"
in order to be received as a plus-sign and not as a space character.data
Array [TransactionResource]
The list of transactions returned in this response.
type
string
The type of this resource: transactions
id
string
The unique identifier for this transaction.
attributes
object
status
TransactionStatusEnum
The current processing status of this transaction, according to whether or not this transaction has settled or is still held.
rawText
string
The original, unprocessed text of the transaction. This is often not a perfect indicator of the actual merchant, but it is useful for reconciliation purposes in some cases.
description
string
A short description for this transaction. Usually the merchant name for purchases.
message
string
Attached message for this transaction, such as a payment message, or a transfer note.
isCategorizable
boolean
Boolean flag set to true on transactions that support the use of categories.
holdInfo
HoldInfoObject
If this transaction is currently in the HELD
status, or was ever in
the HELD
status, the amount
and foreignAmount
of the
transaction while HELD
.
amount
MoneyObject
The amount of this transaction while in the HELD
status, in
Australian dollars.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
foreignAmount
MoneyObject
The foreign currency amount of this transaction while in the HELD
status. This field will be null
for domestic transactions. The amount
was converted to the AUD amount reflected in the amount
field.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
roundUp
RoundUpObject
Details of how this transaction was rounded-up. If no Round Up was
applied this field will be null
.
amount
MoneyObject
The total amount of this Round Up, including any boosts, represented as a negative value.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
boostPortion
MoneyObject
The portion of the Round Up amount
owing to boosted Round Ups,
represented as a negative value. If no boost was added to the Round Up
this field will be null
.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
cashback
CashbackObject
If all or part of this transaction was instantly reimbursed in the form of cashback, details of the reimbursement.
description
string
A brief description of why this cashback was paid.
amount
MoneyObject
The total amount of cashback paid, represented as a positive value.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
amount
MoneyObject
The amount of this transaction in Australian dollars. For
transactions that were once HELD
but are now SETTLED
, refer to
the holdInfo
field for the original amount
the transaction was
HELD
at.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
foreignAmount
MoneyObject
The foreign currency amount of this transaction. This field will be
null
for domestic transactions. The amount was converted to the AUD
amount reflected in the amount
of this transaction. Refer to the
holdInfo
field for the original foreignAmount
the transaction was
HELD
at.
currencyCode
string
The ISO 4217 currency code.
value
string
The amount of money, formatted as a string in the relevant currency.
For example, for an Australian dollar value of $10.56, this field will
be "10.56"
. The currency symbol is not included in the string.
valueInBaseUnits
integer
The amount of money in the smallest denomination for the currency, as a
64-bit integer. For example, for an Australian dollar value of $10.56,
this field will be 1056
.
cardPurchaseMethod
CardPurchaseMethodObject
Information about the card used for this transaction, if applicable.
method
CardPurchaseMethodEnum
The type of card purchase.
cardNumberSuffix
string
The last four digits of the card used for the purchase, if applicable.
settledAt
string (date-time)
The date-time at which this transaction settled. This field will be
null
for transactions that are currently in the HELD
status.
createdAt
string (date-time)
The date-time at which this transaction was first encountered.
transactionType
string
A description of the transaction method used e.g. Purchase, BPAY Payment.
note
NoteObject
A customer provided note about the transaction. Can only be provided by Up High subscribers.
text
string
A text note about the transaction.
performingCustomer
CustomerObject
The customer who initated the transaction. For 2Up accounts this could be the customer who's card was used.
displayName
string
The Upname or preferred name of the customer
deepLinkURL
string
A deep link to the transaction receipt screen in-app.
relationships
object
account
object
data
object
type
string
The type of this resource: accounts
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
transferAccount
object
If this transaction is a transfer between accounts, this relationship
will contain the account the transaction went to/came from. The
amount
field can be used to determine the direction of the transfer.
data
object
type
string
The type of this resource: accounts
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
category
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
self
string
The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
related
string
The link to retrieve the related resource(s) in this relationship.
parentCategory
object
data
object
type
string
The type of this resource: categories
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
tags
object
data
Array [object]
type
string
The type of this resource: tags
id
string
The label of the tag, which also acts as the tag’s unique identifier.
links
object
self
string
The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
attachment
object
data
object
type
string
The type of this resource: attachments
id
string
The unique identifier of the resource within its type.
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
links
object
prev
string
The link to the previous page in the results. If this value is null
there is no previous page.
next
string
The link to the next page in the results. If this value is null
there is no next page.
Sample Request
curl https://api.up.com.au/api/v1/accounts/075aa2eb-2850-4f80-ae0a-316edd602d7a/transactions \-G \-H 'Authorization: Bearer up:demo:TVhd4K4OfrRcvt8n' \-d 'page[size]=1' \-d 'filter[status]=HELD' \-d 'filter[category]=good-life'
Sample Response
{"data": [{"type": "transactions","id": "152d9e35-a435-4aec-bab7-9575efaa2eb1","attributes": {"status": "HELD","rawText": "Spotify 0123456789","description": "Spotify","message": null,"isCategorizable": true,"holdInfo": {"amount": {"currencyCode": "AUD","value": "-11.95","valueInBaseUnits": -1195},"foreignAmount": null},"roundUp": null,"cashback": null,"amount": {"currencyCode": "AUD","value": "-11.95","valueInBaseUnits": -1195},"foreignAmount": null,"cardPurchaseMethod": null,"settledAt": null,"createdAt": "2024-11-03T06:06:49+11:00","transactionType": null,"note": null,"performingCustomer": {"displayName": "Bobby"},"deepLinkURL": "up://transaction/VHJhbnNhY3Rpb24tNjk="},"relationships": {"account": {"data": {"type": "accounts","id": "075aa2eb-2850-4f80-ae0a-316edd602d7a"},"links": {"related": "https://api.up.com.au/api/v1/accounts/075aa2eb-2850-4f80-ae0a-316edd602d7a"}},"transferAccount": {"data": null},"category": {"data": {"type": "categories","id": "tv-and-music"},"links": {"self": "https://api.up.com.au/api/v1/transactions/152d9e35-a435-4aec-bab7-9575efaa2eb1/relationships/category","related": "https://api.up.com.au/api/v1/categories/tv-and-music"}},"parentCategory": {"data": {"type": "categories","id": "good-life"},"links": {"related": "https://api.up.com.au/api/v1/categories/good-life"}},"tags": {"data": [],"links": {"self": "https://api.up.com.au/api/v1/transactions/152d9e35-a435-4aec-bab7-9575efaa2eb1/relationships/tags"}},"attachment": {"data": null}},"links": {"self": "https://api.up.com.au/api/v1/transactions/152d9e35-a435-4aec-bab7-9575efaa2eb1"}}],"links": {"prev": null,"next": null}}
Some endpoints exist not to expose data, but to test the API itself. Currently there is only one endpoint in this group: ping!
GET /util/ping
Make 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 returned. On failure an HTTP 401
error response
is returned.
meta
object
id
string
The unique identifier of the authenticated customer.
statusEmoji
string
A cute emoji that represents the response status.
errors
Array [ErrorObject]
The list of errors returned in this response.
status
string
The HTTP status code associated with this error. This can also be obtained from the response headers. The status indicates the broad type of error according to HTTP semantics.
title
string
A short description of this error. This should be stable across multiple occurrences of this type of error and typically expands on the reason for the status code.
detail
string
A detailed description of this error. This should be considered unique to individual occurrences of an error and subject to change. It is useful for debugging purposes.
source
object
If applicable, location in the request that this error relates to. This may be a parameter in the query string, or a an attribute in the request body.
parameter
string
If this error relates to a query parameter, the name of the parameter.
pointer
string
If this error relates to an attribute in the request body, a rfc-6901 JSON pointer to the attribute.
Sample Request
curl https://api.up.com.au/api/v1/util/ping \-H 'Authorization: Bearer up:demo:kFxT8dk54551U2Nt'
Sample Response
{"meta": {"id": "e88a82ad-c44f-473b-b639-709a87bc52e7","statusEmoji": "⚡️"}}
Sample Request
curl https://api.up.com.au/api/v1/util/ping
Sample Response
{"errors": [{"status": "401","title": "Not Authorized","detail": "The request was not authenticated because no valid credential was found in the Authorization header, or the Authorization header was not present."}]}
Webhooks provide a mechanism for a configured URL to receive events when transaction activity occurs on Up. You can think of webhooks as being like push notifications for your server-side application.
GET /webhooks
Retrieve 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 ordered oldest first to
newest last.
page[size]
integer
The number of records to return in each page.
?page[size]=30
"+"
must be encoded as "%2B"
in order to be received as a plus-sign and not as a space character.data
Array [WebhookResource]
The list of webhooks returned in this response.
type
string
The type of this resource: webhooks
id
string
The unique identifier for this webhook.
attributes
object
url
string
The URL that this webhook is configured to POST
events to.
description
string
An optional description that was provided at the time the webhook was created.
secretKey
string
A shared secret key used to sign all webhook events sent to the configured webhook URL. This field is returned only once, upon the initial creation of the webhook. If lost, create a new webhook and delete this webhook.
The webhook URL receives a request with a
X-Up-Authenticity-Signature
header, which is the SHA-256 HMAC of
the entire raw request body signed using this secretKey
. It is
advised to compute and check this signature to verify the
authenticity of requests sent to the webhook URL. See
Handling webhook events for full
details.
createdAt
string (date-time)
The date-time at which this webhook was created.
relationships
object
logs
object
links
object
related
string
The link to retrieve the related resource(s) in this relationship.
links
object
self
string
The canonical link to this resource within the API.
links
object
prev
string
The link to the previous page in the results. If this value is null
there is no previous page.
next
string
The link to the next page in the results. If this value is null
there is no next page.
Sample Request