Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Settlement Accounts

Get a settlement account

The GET /virtual-accounts/{accountId} endpoint the information, for a given settlement account.

get/virtual-accounts/{accountId}

Path parameters

accountIdstring required

The system-generated, unique id which specifies the settlement account.

Query parameters

onBehalfOfIdstring

Filters payments by the onBehalfOfId value - returns only payments with the onBehalfOfId value specified in this parameter. This field is mandatory for unregulated TPPs.

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"
  }
}