API status
  • Balances

Virtual Cash Balances

All virtual cash balances related paths

post

Trigger a virtual cash increase

Trigger a virtual cash increase

account_group_idstring

required

Account group unique identifier.

Format
uuid
amountstring

required

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

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Enum
  • EUR
  • GBP

Responses

Request examples

{
  "account_group_id": "2596db3b-0d03-4651-9eda-970910479dfb",
  "amount": "200.00",
  "currency": "EUR"
}

Response examples

Virtual Cash Balances Increase

{
  "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
  "amount": "200.00",
  "currency": "EUR",
  "status": "ISSUED"
}
post

Trigger a virtual cash decrease

Trigger a virtual cash decrease

account_group_idstring

required

Account group unique identifier.

Format
uuid
amountstring

required

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

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Enum
  • EUR
  • GBP

Responses

Request examples

{
  "account_group_id": "2596db3b-0d03-4651-9eda-970910479dfb",
  "amount": "200.00",
  "currency": "EUR"
}

Response examples

Virtual Cash Balances Decrease

{
  "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
  "amount": "200.00",
  "currency": "EUR",
  "status": "ISSUED"
}
delete

Cancel virtual cash decrease by ID

Cancels a virtual cash decrease specified by its ID. It is only possible to cancel a virtual cash decrease if it has the status ISSUED or QUEUED.

virtual_cash_decrease_idstring

required

Virtual cash unique identifier

Format
uuid

Responses

Response examples

The request has been successfully accepted and will be processed asynchronously.

Empty response

webhook

Virtual cash increase 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
  • VIRTUAL_CASH_INCREASE.ISSUED
  • VIRTUAL_CASH_INCREASE.CONFIRMED
objectobject (Virtual Cash Balance - Virtual Cash Increase)

required

idstring

required

Virtual cash unique identifier

Format
uuid
created_atstring

required

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

Format
date-time
updated_atstring

required

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

Format
date-time
account_group_idstring

required

Account group unique identifier.

Format
uuid
amountstring

required

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

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Enum
  • EUR
  • GBP
statusstring

required

Status of the virtual cash

  • ISSUED - Virtual cash increase is created.
  • CONFIRMED - Virtual cash increase was successfully processed.
Enum
  • ISSUED
  • CONFIRMED
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "VIRTUAL_CASH_INCREASE.ISSUED",
  "object": {
    "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
    "created_at": "2020-08-24T14:15:22Z",
    "updated_at": "2020-08-24T14:15:22Z",
    "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
    "amount": "200.00",
    "currency": "EUR",
    "status": "ISSUED"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

webhook

Virtual cash decrease 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
  • VIRTUAL_CASH_DECREASE.ISSUED
  • VIRTUAL_CASH_DECREASE.CONFIRMED
  • VIRTUAL_CASH_DECREASE.QUEUED
  • VIRTUAL_CASH_DECREASE.CANCELLED
objectobject (Virtual Cash Balance - Virtual Cash Decrease)

required

idstring

required

Virtual cash unique identifier

Format
uuid
created_atstring

required

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

Format
date-time
updated_atstring

required

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

Format
date-time
account_group_idstring

required

Account group unique identifier.

Format
uuid
amountstring

required

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

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Enum
  • EUR
  • GBP
statusstring

required

Status of the virtual cash

  • ISSUED - Virtual cash decrease is created.
  • CONFIRMED - Virtual cash decrease was successfully processed.
  • QUEUED - Virtual cash decrease was queued.
  • CANCELLED - Virtual cash decrease was cancelled.
Enum
  • ISSUED
  • CONFIRMED
  • QUEUED
  • CANCELLED
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "VIRTUAL_CASH_DECREASE.ISSUED",
  "object": {
    "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
    "created_at": "2020-08-24T14:15:22Z",
    "updated_at": "2020-08-24T14:15:22Z",
    "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
    "amount": "200.00",
    "currency": "EUR",
    "status": "ISSUED"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?