Skip to content
API Reference
/
/
Get account group by Acco...

Aritma Banking API (v3)

Download OpenAPI description
bankservice-openapi.json
bankservice-openapi.yaml
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v3/openapi/bankservice-openapi
Open Banking API
https://bankservice.zdata.no
Open Banking API (Dev)
https://bankservicedemo.zdata.no

Account

Operations

AccountGroup

Operations

Get all account groups for company

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
Query
includeUnassociatedboolean
Default false
includeUnassociatedDaughtersboolean
Default false
No request payload

Responses

Account groups for company

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Get account group by AccountGroupId

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
accountGroupIdstring(uuid)required
No request payload

Responses

Account groups

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Update account group name

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
accountGroupIdstring(uuid)required
Body
namestring or null
{
  "name": "string"
}

Responses

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Delete account group

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
accountGroupIdstring(uuid)required
No request payload

Responses

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Post new account group

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Body
companyIdstring(uuid)
namestring or null
{
  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  "name": "string"
}

Responses

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Add user to account group

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
accountGroupIdstring(uuid)required
Body
idstring(uuid)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Responses

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Remove user from account group

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
accountGroupIdstring(uuid)required
userIdstring(uuid)required
No request payload

Responses

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Add account to account group

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
accountGroupIdstring(uuid)required
Body
idstring(uuid)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Responses

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Remove account from account group

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required
accountGroupIdstring(uuid)required
accountIdstring(uuid)required
No request payload

Responses

Body
Array [
idstringnon-emptyrequired

Account group id

namestringnon-emptyrequired

Account group name

companyIdstring(uuid)required

Account group company id

accountsArray of objects or null(AccountGroupAccount)

Accounts

usersArray of objects or null(AccountGroupUser)

Users

]
Response
No response example

Balance

Operations

Company

Operations

EventGridDeadLetter

Operations

EventGridSubscription

Operations

Onboarding

Operations

Payment

Operations

Receivable

Operations

Recipients

Operations

Services

Operations

Statement

Operations

User

Operations