Payments

Virtual Bank Accounts

Download Spec

All virtual bank accounts related paths

get/account_groups/{account_group_id}/payments/virtual_bank_accounts

List virtual bank accounts

Returns a list of virtual bank accounts.

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 virtual bank accounts.

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "22913092-0484-42e9-9273-9ffd6dfd0b13",
      "created_at": "2021-07-21T14:10:00.00Z",
      "account_group_id": "d1354aad-6da7-4da7-aaa1-e00ebfd3240d",
      "name": "Max's Virtual Bank Account",
      "owner": {
        "name": "Max Musterman"
      },
      "identification": {
        "swift": {
          "iban": "DE89000000000000000000",
          "bic": "ABCDEXXX"
        }
      }
    }
  ]
}

post/payments/virtual_bank_accounts

Create a virtual bank account

Triggers the creation of a virtual bank account.

account_group_idstring

required

Account group unique identifier.

Format: uuid

namestring

required

Name of the virtual bank account

Responses

Request examples

{
  "account_group_id": "f874a64a-ceaa-42b2-b59a-39d4f62166fb",
  "name": "Max's Virtual Bank Account"
}

Response examples

Virtual Bank Account created.

{
  "id": "22913092-0484-42e9-9273-9ffd6dfd0b13",
  "created_at": "2021-07-21T14:10:00.00Z",
  "account_group_id": "d1354aad-6da7-4da7-aaa1-e00ebfd3240d",
  "name": "Max's Virtual Bank Account",
  "owner": {
    "name": "Max Musterman"
  },
  "identification": {
    "swift": {
      "iban": "DE89000000000000000000",
      "bic": "ABCDEXXX"
    }
  }
}

get/payments/virtual_bank_accounts/{virtual_bank_account_id}

Retrieve a virtual bank account by ID

Returns a virtual bank account specified by its ID.

virtual_bank_account_idstring

required

Virtual bank account request unique identifier.

Format: uuid

Responses

Response examples

OK.

{
  "id": "22913092-0484-42e9-9273-9ffd6dfd0b13",
  "created_at": "2021-07-21T14:10:00.00Z",
  "account_group_id": "d1354aad-6da7-4da7-aaa1-e00ebfd3240d",
  "name": "Max's Virtual Bank Account",
  "owner": {
    "name": "Max Musterman"
  },
  "identification": {
    "swift": {
      "iban": "DE89000000000000000000",
      "bic": "ABCDEXXX"
    }
  }
}

webhook