---
title: "List top-ups"
method: GET
path: "/account_groups/{account_group_id}/payments/topups"
tags: ["Top-ups"]
---

# List top-ups

`GET /account_groups/{account_group_id}/payments/topups`

## Request

- Base URL: `https://sandbox.upvest.co`
- URL: `https://sandbox.upvest.co/account_groups/{account_group_id}/payments/topups`
- Auth: OAuth 2 (client credentials, token URL `https://sandbox.upvest.co/auth/token`, scopes: `topups:admin`, `topups:read`)

Returns a list of top-ups.

## Query parameters

- `sort` 'id' | 'created_at'
- `order` 'ASC' | 'DESC'
- `limit` integer
- `offset` integer

## Response `200`

List of top-ups.

- object: Paginated list of top-ups for an account group, including cursor-based pagination metadata.
  - `meta` object, required: Offset/limit pagination metadata for a list response. Contains the `offset` and `limit` applied to the request, the `count` of resources returned in this page, and the `total_count` of matching resources.
    - `offset` integer, required: Amount of resource to offset in the response.
    - `limit` integer, required: Total limit of the response.
    - `count` integer, required: Count of the resources returned in the response.
    - `total_count` integer, required: Total count of all the resources.
    - `sort` string: The field that the list is sorted by.
    - `order` 'ASC' | 'DESC': The ordering applied to the list. * ASC — Ascending order. * DESC — Descending order.
  - `data` object[], required
    - `id` string, uuid, required: Top up request unique identifier.
    - `created_at` string, date-time, required: Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `account_group_id` string, uuid, required: Universally Unique Identifier (UUID) of the account group.
    - `cash_amount` string, required: A positive cash amount, as a decimal string with up to two decimal places.
    - `currency` 'EUR' | 'GBP', required: Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR — Euro. * GBP — Pound Sterling.
    - `settlement_reference` string: Settlement reference to be included in the corresponding bank transfer to settle this top up.
    - `status` 'CONFIRMED' | 'SETTLED' | 'CANCELLED': Status of the top up * CONFIRMED - The top up is created and confirmed. * SETTLED - The top up is settled. * CANCELLED - The top up is cancelled

## Other responses

- `400`: Bad Request. The incoming request had a malformed parameter/object.
- `401`: Unauthorized. The caller has not been authenticated.
- `403`: Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `404`: Not Found. The requested resource could not be found.
- `406`: Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429`: Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500`: Internal Server Error. The service encountered an unexpected error.
- `503`: Service Unavailable. The service handling for this request cannot be reached at this time.
- `504`: Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.dev/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.dev/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc.dev/upvest/apis/upvest-investment-api/revisions/ca69534b631d?raw)