Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Settlement Accounts

Create a settlement account

The POST /virtual-accounts endpoint creates a settlement account.

post/virtual-accounts

Request body

accountNickNamestring

The alias name that identifies the settlement account. May contain up to 50 characters including letters, numbers, hyphens, underscores, and spaces.

currencystring required

The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.

onBehalfOfIdstring

The id of the ultimate client on whose behalf the account is created. If the account is created on behalf of a sub-TPP, this field will contain the sub-TPP referenceId. This field is mandatory for unregulated TPPs.

countrystring required

Two-letter country code in upper case (ISO 3166-1 alpha-2).

Example request

{
  "accountNickName": "Account Alias",
  "currency": "EUR",
  "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
  "country": "GB"
}

Response

Successful response

Example response

{
  "virtualAccount": {
    "accountId": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV",
    "accountName": "Account Name",
    "accountNickName": "Account Alias",
    "accountNumber": "12345678",
    "bic": "BOFIIE2D",
    "country": "GB",
    "createdDateTime": "2023-04-05T10:43:07.000+00:00",
    "currency": "EUR",
    "iban": "GB29NWBK60161331926819",
    "status": "ACTIVE",
    "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7"
  }
}