Skip to content
API Reference
/
/
Get account balances

Aritma Banking API (1.0.0)

API versioning

Over time there will be introduced changes to the API as we continuously introduce improvements. You have the option to use a specific version or the most recent version, supported versions are available in the response header api-supported-versions.

Use a specific version of the API by specifying the api-version header, for example api-version: 1.0. If you don't specify the header, the latest version will be used. If a version has been scheduled to be removed, it will be reported through the api-deprecated-versions header, for example api-deprecated-versions: 1.0, 1.1.

Idempotency

The API supports idempotency for safely retrying POST requests without accidentally performing the operation twice. To perform an idempotent request, specify the Idempotency-Key: UUID header with a value on UUID format, example: Idempotency-Key: 5bfa15da-0969-46a3-820d-be0ec7a16c24.

The idempotency works by storing the status code and body of the first response made for the idempotency key for a short timespan, regardless of whether if succeeds or fails. Subsequent request with the same key returns the response of the previous response. The presence of response header Idempotent-Replayed: true indicates that a previous response has been returned. Note that the replayed responses for created resources would change from status 201 to 200 ok, indicating that no resource was created.

Download OpenAPI description
banking-openapi.json
banking-openapi.yaml
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v4/openapi/banking-openapi
https://banking.zdata.io/api

Accounts

Read account information. Provides access to account lists, account details, balances and transaction information.

Operations

Get account

Request

The account-id is retrieved by using the "Get accounts" call.

Security
Api access(Required scopes:
services.banking
api
)
Path
idstringrequired

The id of the account.

Example: 3dc3d5b3-7023-4848-9853-f5400a64e81f
Headers
PSU-IP-Addressstring

IP Address of the PSU, it should only be set if this request was actively initiated by the PSU. Most operations have request limits that apply when a user is not present.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

  • /: Use all resources available.
  • /subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
  • /subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.
Example: /subscriptions/7fdf00601dfb/resource-groups/my-company
api-versionstring
No request payload

Responses

OK

Bodyapplication/json
idstring

Id of the account

Example: "67e98aeec65145888fefa7cb935c9197"
ibannull or string[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

IBAN (International Bank Account Number) of the account

Example: "FR7612345987650123456789014"
bbannull or string[a-zA-Z0-9]{1,30}

BBAN (Basic Bank Account Number) - ISO 20022

Example: "BARC12345612345678"
otherobject(GenericAccountDto)

Generic account reference.

bicnull or string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...

BICFI

Example: "AAAADEBBXXX"
currencynull or string

ISO 4217 Alpha 3 currency code.

Example: "NOK"
namenull or string

Name of the account

Example: "Usage Account"
displayNamenull or string

Name of the account for use within online channels.

Example: "My usage account"
statusstring(StatusType)
Enum"enabled""deleted""blocked"
ownerNamenull or string

Name of the legal account owner.

Example: "Corporation AB"
ownerobject(AccountOwnerDto)
balancesArray of objects(AccountBalance)

Account balances

Response
application/json
{
  "id": "67e98aeec65145888fefa7cb935c9197",
  "iban": "FR7612345987650123456789014",
  "bban": "BARC12345612345678",
  "other": {
    "identification": "123-1234",
    "schemeName": "BGNR"
  },
  "bic": "AAAADEBBXXX",
  "currency": "NOK",
  "name": "Usage Account",
  "displayName": "My usage account",
  "status": "enabled",
  "ownerName": "Corporation AB",
  "owner": {
    "name": "Corporation AB",
    "role": "owner",
    "postalAddress": { … },
    "organisationId": "699317284"
  },
  "balances": [
    { … }
  ]
}

Delete account

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
idstringrequired

The id of the account to delete.

Example: 3dc3d5b3-7023-4848-9853-f5400a64e81f
Headers
PSU-IP-Addressstring

IP Address of the PSU, it should only be set if this request was actively initiated by the PSU. Most operations have request limits that apply when a user is not present.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

  • /: Use all resources available.
  • /subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
  • /subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.
Example: /subscriptions/7fdf00601dfb/resource-groups/my-company
api-versionstring
No request payload

Responses

Accepted

Response
No content

Get accounts

Request

Security
Api access(Required scopes:
services.banking
api
)
Query
withBalanceboolean

If the account balance should be included.

bbanstring

The Basic Bank Account Number (BBAN) used to filter accounts.

Example: bban=12345612345678
ibanstring

The International Bank Account Number (IBAN) used to filter accounts.

Example: iban=FR7612345987650123456789014
searchstring

Search for an account matching the phrase.

cursorstring

A reference to a specific page.

Headers
PSU-IP-Addressstring

IP Address of the PSU, it should only be set if this request was actively initiated by the PSU. Most operations have request limits that apply when a user is not present.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

  • /: Use all resources available.
  • /subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
  • /subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.
Example: /subscriptions/7fdf00601dfb/resource-groups/my-company
api-versionstring
No request payload

Responses

OK

Bodyapplication/json
accountsArray of objects(AccountResponse)

List of account details.

_linksobject(Links)

Pagination links for navigating between pages of results.

Response
application/json
{
  "accounts": [
    { … }
  ],
  "_links": {
    "next": { … },
    "previous": { … }
  }
}

Get transactions

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
idstringrequired

The id of the account.

Example: 3dc3d5b3-7023-4848-9853-f5400a64e81f
Query
dateFromstringrequired

Starting date (inclusive) of the transactions.

Example: dateFrom=2026-01-01T00:00:00Z
dateTostring

End date (inclusive) of the transaction list, default is "now" if not given.

bookingStatusstring(BookingStatus)required

The booking status to include.

Enum"booked""pending""both""information""all"
Example: bookingStatus=booked
transactionTypestring(TransactionType)

The kind of transaction.

Enum"credit""debit"
Example: transactionType=credit
transactionSourcestring(TransactionSource)

The source of the transaction.

Enum ValueDescription
default

Will give transactions only from Camt.53. Specifying this value is the same as omitting the field or choosing statement

creditDebitNotification

Notifications are files usually delivered from the bank multiple times a day, and contains comprehensive information on transactions (Filetype : Camt.54)

statement

Statements are files usually delivered from the bank one time a day, at the end of the day contains information on transactions (Filetype : Camt.53)

Example: transactionSource=default
cursorstring

A reference to a specific page.

Headers
PSU-IP-Addressstring

IP Address of the PSU, it should only be set if this request was actively initiated by the PSU. Most operations have request limits that apply when a user is not present.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

  • /: Use all resources available.
  • /subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
  • /subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.
Example: /subscriptions/7fdf00601dfb/resource-groups/my-company
api-versionstring
No request payload

Responses

OK

Bodyapplication/json
accountobject(AccountReference)

Account reference

transactionsobject(AccountReport)
Response
application/json
{
  "account": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR",
    "pan": "5409050000000000",
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+491701234567"
  },
  "transactions": {
    "booked": [ … ],
    "pending": [],
    "information": [],
    "_links": { … }
  }
}

Get transaction details

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
accountIdstringrequired

The id of the account.

Example: 3dc3d5b3-7023-4848-9853-f5400a64e81f
idstringrequired

The id of the transaction.

Example: 3dc3d5b3-7023-4848-9853-f5400a64e80f
Query
cursorstring

A reference to a specific page.

Headers
PSU-IP-Addressstring

IP Address of the PSU, it should only be set if this request was actively initiated by the PSU. Most operations have request limits that apply when a user is not present.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

  • /: Use all resources available.
  • /subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
  • /subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.
Example: /subscriptions/7fdf00601dfb/resource-groups/my-company
api-versionstring
No request payload

Responses

OK

Bodyapplication/json
transactionDetailsobject(TransactionDetail)

A single transaction detail

Response
application/json
{
  "transactionDetails": {
    "transactionId": "DEAF96E4-5063-46D9-89D4-E32A8E51994C",
    "accountId": "1234",
    "entryReference": "123456789",
    "references": { … },
    "valueDate": "2025-10-25T22:20:31.8361914+00:00",
    "bookingDate": "2025-10-26T07:20:31.8361914+00:00",
    "transactionAmount": { … },
    "amountDetails": { … },
    "currencyExchange": [ … ],
    "charge": { … },
    "creditor": { … },
    "creditorAccount": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "remittanceInformationUnstructured": [ … ],
    "remittanceInformationStructured": [ … ],
    "purposeCode": "SALA",
    "purposeProprietary": null,
    "bankTransactionCode": null,
    "bankTransactionCodeProprietary": null,
    "additionalInformation": null,
    "entryDetailsCount": null,
    "entryDetails": [ … ],
    "_links": { … }
  }
}

Get account parameters

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
idstringrequired

The id of the account.

Example: 3dc3d5b3-7023-4848-9853-f5400a64e81f
Headers
PSU-IP-Addressstring

IP Address of the PSU, it should only be set if this request was actively initiated by the PSU. Most operations have request limits that apply when a user is not present.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

  • /: Use all resources available.
  • /subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
  • /subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.
Example: /subscriptions/7fdf00601dfb/resource-groups/my-company
api-versionstring
No request payload

Responses

OK

Bodyapplication/json
accountobject(AccountReference)

Account reference

parametersobject(AccountParameters)

Parameters for an account.

Response
application/json
{
  "account": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR",
    "pan": "5409050000000000",
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+491701234567"
  },
  "parameters": {
    "payments": { … }
  }
}

Get account balances

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
idstringrequired

The id of the account.

Example: 3dc3d5b3-7023-4848-9853-f5400a64e81f
Query
dateFromstring

Starting date (inclusive) from which to return balances.

cursorstring

A reference to a specific page.

typestring(BalanceType)

The type of balance to include, when not set all types will be returned.

Enum ValueDescription
closingBooked

Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period. For card-accounts, this is composed of invoiced, but not yet paid entries. Most requests for balances of an account belonging to a private customer will include this balancetype.

openingBooked

Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.

expected

Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted. For card accounts, this is composed of invoiced, but not yet paid entries, not yet invoiced but already booked entries and pending item(not yet booked) Most requests for balances of an account belonging to a private customer will include this balancetype

interimAvailable

Available balance calculated in the course of the account servicer’s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. For card-accounts, this is composed of invoiced, but not yet paid entries and not yet invoiced but already booked entries

interimBooked

Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.

forwardAvailable

Forward available balance of money that is at the disposal of the account owner on the date specified.

nonInvoiced

Only for card accounts, to be checked yet.

Example: type=closingBooked
Headers
PSU-IP-Addressstring

IP Address of the PSU, it should only be set if this request was actively initiated by the PSU. Most operations have request limits that apply when a user is not present.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

  • /: Use all resources available.
  • /subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
  • /subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.
Example: /subscriptions/7fdf00601dfb/resource-groups/my-company
api-versionstring
No request payload

Responses

OK

Bodyapplication/json
accountobject(AccountReference)required

Account reference

ibannull or string[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

IBAN of the account

Example: "FR7612345987650123456789014"
bbannull or string[a-zA-Z0-9]{1,30}

BBAN of the account - ISO 20022

Example: "BARC12345612345678"
otherobject(GenericAccountDto)

Generic account reference.

currencynull or string[A-Z]{3}

Currency code - ISO 4217

Example: "EUR"
pannull or string

Primary Account Number - ISO/IEC 7812

Example: "5409050000000000"
maskedPannull or string

Masked Primary Account Number - ISO/IEC 7812

Example: "123456xxxxxx1234"
msisdnnull or string

Mobile phone number

Example: "+491701234567"
accountBalancesArray of objects(AccountBalance)

List of account balances.

_linksobject(Links)

Pagination links for navigating between pages of results.

Response
application/json
{
  "account": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR",
    "pan": "5409050000000000",
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+491701234567"
  },
  "accountBalances": [
    { … }
  ],
  "_links": {
    "next": { … },
    "previous": { … }
  }
}

Banks

Access information about the available banks.

Operations

Consents

Obtaining a consent is the first thing you need to do in order to access bank information.

Start by sending a request to the create consent endpoint which will return a link you can redirect the user to. When the user visits the link, we will gather the necessary information needed to obtain a consent linked to the chosen bank.

When a consent has been obtained you can use it to access data through the available endpoints, keep in mind that a consent can potentially be withdrawn by the user at any point.

Operations

Payments

Operations

SigningBaskets

A signing basket groups multiple payments for authorisation with a single SCA operation. The basket can contain both bulk payments and individual payment lines, each with different authorisation requirements. Payments are exported to bank as soon as their authorisation requirements are fulfilled, even if other payments in the basket are still pending.

Operations