Access account information.
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
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v4/openapi/banking-openapi
https://banking.dev.zdata.io/api
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