Skip to content

Aritma Banking API (v3)

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

Get dead letter event

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
eventIdstring(uuid)required
No request payload

Responses

OK

Body
eventany or null
linksArray of objects or null(ApiLink)
Response
No response example

Delete dead letter event

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
eventIdstring(uuid)required
No request payload

Responses

OK

Get list of dead letter event metadata for client

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
)
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(DeadLetterEventResponse)
Response
No response example

Get list of dead letter event metadata 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(DeadLetterEventResponse)
Response
No response example

Get list of dead letter event metadata for 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

Query
skipinteger(int32)

Number of entries to skip

takeinteger(int32)

Number of entries to return

No request payload

Responses

OK

BodyArray [
eventIdstring or null
subscriptionNamestring or null
clientIdstring or null
companyIdstring or null
linksArray of objects or null(ApiLink)
]
Response
No response example

EventGridSubscription

Operations

Onboarding

Operations

Payment

Operations

Receivable

Operations

Recipients

Operations

Services

Operations

Statement

Operations

User

Operations