Skip to content
/Virtual IBANs

Account management (1.0)

Download OpenAPI description
account-management.json
account-management.yaml
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/digital-banking/account-management/

Accounts

Operations

Person accounts

Operations

Business accounts

Operations

Reference accounts

Operations

Account closure requests

Operations

Fee collection

Operations

Reservations

Operations

Seizures

Operations

Bank statements

Operations

Statements of account

Operations

Fee summary statements

Operations

Person messages

Operations

Business messages

Operations

Trusted IBANs

Operations

Virtual IBANs

Operations

List virtual IBANs

Request

Returns all virtual IBANs bound to the account specified in the request.

Path
account_idstringrequired
Query
page[number]string

The specific results page to return. See the pagination docs for more details.

page[size]string

The size of the results page to return. See the pagination docs for more details.

filter[virtual_iban]string

Filters the response for a specific virtual IBAN.

filter[state]string

Filters the response for virtual IBANs based on their state (ACTIVE or INACTIVE).

No request payload

Responses

Successful result of the operation.

Body*/*Array [
idstring

Unique identifier of the Virtual IBAN.

Example: "dfcfdb70-e082-4c79-91de-d32e67a5f2e8"
virtual_ibanstring

The virtual IBAN.

Example: "DE84110101016453209874"
target_account_bicstring

BIC of the target account.

Example: "SOBKDEB2XXX"
target_account_ibanstring

IBAN of the target account.

Example: "DE84110101019999999999"
bicstring

Virtual IBAN BIC.

Example: "SOBKDEB2XXX"
created_atstring

Date and time when the virtual IBAN was created.

Example: "2021-09-10T12:57:59Z"
currencystring

Currency of the virtual IBAN.

Example: "EUR"
descriptionstring

Description of the virtual IBAN. Can be seen by the customer.

Example: "Example description"
disabled_atstring

Date and time when the virtual IBAN was disabled. null if the status is ENABLED.

Example: "null"
statestring

The state of the virtual IBAN.

Enum"ENABLED""DISABLED"
Example: "ENABLED"
updated_atstring

Date and time when the virtual IBAN was last updated.

Example: "2021-09-10T12:57:59Z"
customer_idstring

ID of the virtual IBAN customer.

customer_typestring

Type of the virtual IBAN customer.

]

Create virtual IBAN

Request

Creates a new virtual IBAN and attaches it to the account specified in the request.

Path
account_idstringrequired
Bodyapplication/jsonrequired
referencestring(uuid)required

Partners must generate a reference for the vIBAN and supply it in this property. This property acts as an idempotency key and must be unique.

Example: "f3757e7e-57ec-4e07-a3f1-7a5d1e412be7"
customer_idstring

Customer data related to the issued Virtual IBAN. Optional if partner configuration allows issuing vIBANs without customer.

Example: "12312312cus"
descriptionstring

A description of the vIBAN. Visible to the customer.

Example: "Example description"
application/json
{
  "customer_id": "12312312cus",
  "reference": "f3757e7e-57ec-4e07-a3f1-7a5d1e412be7",
  "description": "Example description"
}

Responses

The virtual IBAN was already created.

Body*/*
idstring

The ID of the created vIBAN.

Example: "919325d2-cd99-4875-8935-542c36240ec3"
virtual_ibanstring(IBAN)

The vIBAN created and assigned to the account.

Example: "DE88110101013303512971"
account_idstring

ID of the account to which the vIBAN was assigned.

Example: "8e98fe2c6b0df0cdeff56517494abbadcacc"
referencestring(uuid)

Partner-generated reference for the created vIBAN.

Disable virtual IBAN

Request

Changes the state of the virtual IBAN in the request URL to DISABLED.

Path
account_idstringrequired
virtual_iban_idstringrequired
No request payload

Responses

The virtual IBAN was successfully disabled.

Body*/*
object(VirtualIban_Disable_enable)

Enable virtual IBAN

Request

Changes the state of a previously disabled virtual IBAN to ENABLED.

Path
account_idstringrequired
virtual_iban_idstringrequired
No request payload

Responses

The virtual IBAN was enabled.

Body*/*
object(VirtualIban_Disable_enable)

IBAN validation

Operations

Savings Accounts

Operations