Sign in
latestOpenAPI 3.0.3Apache 2.02026-08-1915707.5 MB

2c6bc192bc09

Top-ups

Trigger a top-up

Triggers the creation of a top-up payment.

post/payments/topups

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

account_group_idstring uuid required

Account group unique identifier.

cash_amountstring required
currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling

Response

Top-up created.

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

Account group unique identifier.

cash_amountstring required
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