---
title: "Trigger a top-up"
method: POST
path: "/payments/topups"
tags: ["Top-ups"]
---

# Trigger a top-up

`POST /payments/topups`

Triggers the creation of a top-up payment.

## Headers

- `idempotency-key` string, uuid, required

## Request body

- object
  - `account_group_id` string, uuid, required — Account group unique identifier.
  - `cash_amount` string, required
  - `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

## Response `200`

Top-up created.

- object
  - `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 — Account group unique identifier.
  - `cash_amount` string, required
  - `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.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/2c6bc192bc09/schema)