Payments

Top-ups

Download Spec

All top-ups related paths

get/account_groups/{account_group_id}/payments/topups

List top-ups

Returns a list of top-ups.

sortstring

Field of resource to sort by

Default: "created_at"
Enum: id
created_at
Example: "id"

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

Responses

Response examples

List of top-ups.

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
      "created_at": "2020-08-24T14:15:22Z",
      "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
      "cash_amount": "200.00",
      "currency": "EUR",
      "status": "CONFIRMED"
    }
  ]
}

post/payments/topups

Trigger a top-up

Triggers the creation of a top-up payment.

account_group_idstring

required

Account group unique identifier.

Format: uuid

cash_amountstring

required

Pattern: ^[0-9]{1,9}(\.[0-9]{2})?$

currencystring

required

Alphabetic three-letter ISO 4217 currency code.

EUR - Euro
GBP - Pound Sterling

Enum: EUR
GBP

Responses

Request examples

{
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "cash_amount": "200.00",
  "currency": "EUR"
}

Response examples

Top-up created.

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "CONFIRMED",
  "settlement_reference": "1ab4fef9-a097-4c6f-9345-647025d5fde6"
}

get/payments/topups/{topup_id}

Retrieve a top-up by ID

Returns a top-up specified by its ID.

topup_idstring

required

Top up request unique identifier.

Format: uuid

Responses

Response examples

OK.

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "CONFIRMED"
}

delete/payments/topups/{topup_id}

Cancel a top-up by ID

Cancels a top-up specified by its ID. It is only possible to cancel a top-up if it has the status NEW or CONFIRMED.

topup_idstring

required

Top up request unique identifier.

Format: uuid

Responses

Response examples

Request has been processed successfully.

Empty response

webhook

Top-up events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

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

Format: date-time

typestring

required

Event type

Enum: TOPUP.CONFIRMED
TOPUP.SETTLED
TOPUP.CANCELLED

objectobject

required

idstring

required

Top up request unique identifier.

Format: uuid

created_atstring

required

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

Format: date-time

account_group_idstring

required

Account group unique identifier.

Format: uuid

cash_amountstring

required

Pattern: ^[0-9]{1,9}(\.[0-9]{2})?$

currencystring

required

Alphabetic three-letter ISO 4217 currency code.

EUR - Euro
GBP - Pound Sterling

Enum: EUR
GBP

settlement_referencestring

Settlement reference to be included in the corresponding bank transfer to settle this top up.

Pattern: ^[0-9A-Za-z+?/\-:()\.,'; ]{0,130}$
Max Length: 130

statusstring

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

Enum: CONFIRMED
SETTLED
CANCELLED

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "ac62dbc4-c94e-45e4-a16e-381c51c8de38",
  "created_at": "2022-12-05T12:34:56Z",
  "type": "TOPUP.SETTLED",
  "object": {
    "id": "a4496ff8-ce69-4e23-9f2e-6c3c7914b95c",
    "account_group_id": "2a761567-251b-450e-8615-025d61dcc95e",
    "settlement_reference": "91a44df3-7278-4dee-a1bf-2bc254eca66c",
    "cash_amount": "100.01",
    "currency": "EUR",
    "created_at": "2022-12-05T12:34:56Z",
    "status": "SETTLED"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?