Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-08-0715707.5 MB
Top-ups

Retrieve a top-up by ID

Returns a top-up specified by its ID.

get/payments/topups/{topup_id}

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

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