Skip to content
/Balance

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

Get balance for account.

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

accountstringrequired

Account number

Query
datestring(date-time)

Date (yyyy-mm-dd). Returns balance. When no balance, returns the nearest older balance.

dateSwitchboolean

False, same as above. When True , Returns balance. When no balance, returns the nearest newer balance.

Default false
No request payload

Responses

OK

Body
datestring(date-time)

Balance date

balanceBookednumber(double)

Booked balance in bank

Example: 1337
balanceAvailablenumber or null(double)

Available balance in bank

Example: 1033.7
accountNumberstring or null

Account number

Example: "13370101337"
currencystring or null
Response
No response example

Company

Operations

EventGridDeadLetter

Operations

EventGridSubscription

Operations

Onboarding

Operations

Payment

Operations

Receivable

Operations

Recipients

Operations

Services

Operations

Statement

Operations

User

Operations