Top-ups

Retrieve a top-up by ID

Returns a top-up specified by its ID.

get/payments/topups/{topup_id}

Request

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

Response

OK.

idstring uuid required

Top up request unique identifier.

created_atstring date-time required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

cash_amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
settlement_referencestring

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

Changes

No recorded changes to this operation across all 25 revisions of this API.