v1
latestOpenAPI 3.0.12026-08-0674476716.0 KBGet settlement accounts
The GET /virtual-accounts endpoint retrieves information for all settlement accounts.
Query parameters
The maximum number of records to return. <br/>The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200.
The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response. <br/>The offset value should not be parsed and/or understood in any way.
The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
Two-letter country code in upper case (ISO 3166-1 alpha-2).
The alias name that identifies the settlement account.
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 should contain the sub-TPP referenceId. This field is mandatory for unregulated TPPs.
Response
Successful response
Example response
{
"pageInfo": {
"limit": 20,
"offset": "LerV6Jmex",
"nextOffset": "KgwG8Qkat"
},
"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"
}
]
}