Skip to content
API Reference
/
/
Create or update event su...

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

Balance

Operations

Company

Operations

EventGridDeadLetter

Operations

EventGridSubscription

Operations

Get event subscriptions 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

Company id

Query
skipinteger(int32)

Number of entries to skip

takeinteger(int32)

Number of entries to return

No request payload

Responses

OK

Body
totalCountinteger(int32)
skipinteger or null(int32)
takeinteger or null(int32)
itemsArray of objects or null(BankEventSubscriptionResponse)
Response
No response example

Get subscription.

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

Company id.

subscriptionNamestringrequired

Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).

No request payload

Responses

OK

Body
subscriptionNamestring or null
companyIdstring or null
provisioningStatestring or null
idstring or null
topicstring or null
labelsArray of strings or null
linksArray of objects or null(ApiLink)
Response
No response example

Create or update event subscription.

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

Company id.

subscriptionNamestringrequired

Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).

Body

Event subscription.

eventTypesArray of strings or null
destinationobject(EventSubscriptionDestination)
{
  "eventTypes": [
    "string"
  ],
  "destination": {
    "endpointUrl": "string",
    "maxEventsPerBatch": 0,
    "preferredBatchSizeInKilobytes": 0,
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string"
  }
}

Responses

OK

Body
subscriptionNamestring or null
companyIdstring or null
provisioningStatestring or null
idstring or null
topicstring or null
labelsArray of strings or null
linksArray of objects or null(ApiLink)
Response
No response example

Delete event subscription

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

Company id.

subscriptionNamestringrequired

Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).

No request payload

Responses

OK

Create or update event subscription for multiple companies.

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
subscriptionNamestringrequired

Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).

Query
skipinteger(int32)

Number of entries to skip.

takeinteger(int32)

Number of entries to return.

Body

Event subscription batch.

companyIdsArray of strings or null
eventTypesArray of strings or null
destinationobject(EventSubscriptionDestination)
{
  "companyIds": [
    "string"
  ],
  "eventTypes": [
    "string"
  ],
  "destination": {
    "endpointUrl": "string",
    "maxEventsPerBatch": 0,
    "preferredBatchSizeInKilobytes": 0,
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string"
  }
}

Responses

OK

Body
totalCountinteger(int32)
skipinteger or null(int32)
takeinteger or null(int32)
itemsArray of objects or null(BankEventSubscriptionResponse)
Response
No response example

Onboarding

Operations

Payment

Operations

Receivable

Operations

Recipients

Operations

Services

Operations

Statement

Operations

User

Operations