# Aritma Banking API ## 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. Version: 1.0.0 ## Servers ``` https://banking.zdata.io/api/ ``` ## Security ### Api access Type: oauth2 Token URL: https://id.aritma.localhost/connect/token Scopes: - `services.banking`: Grants access to banking service - `api`: Grants client access to the api ### User access Type: oauth2 ## Download OpenAPI description [Aritma Banking API](https://developer.aritma.com/_bundle/apis/banking/v4/openapi/banking-openapi.yaml) ## Accounts Read account information. Provides access to account lists, account details, balances and transaction information. ### Get account - [GET /accounts/{id}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/accounts/getaccount.md): The account-id is retrieved by using the "Get accounts" call. ### Delete account - [DELETE /accounts/{id}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/accounts/deleteaccount.md) ### Get accounts - [GET /accounts](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/accounts/getaccounts.md) ### Get transactions - [GET /accounts/{id}/transactions](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/accounts/gettransactions.md) ### Get transaction details - [GET /accounts/{accountId}/transactions/{id}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/accounts/gettransactiondetails.md) ### Get account parameters - [GET /accounts/{id}/parameters](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/accounts/getaccountparameters.md) ### Get account balances - [GET /accounts/{id}/balances](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/accounts/getaccountbalances.md) ## Banks Access information about the available banks. ### Get banks - [GET /banks](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/banks/getbanks.md): This endpoint does not require authentication. ### Get bank - [GET /banks/{bankId}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/banks/getbank.md) ## 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. ### Create consent - [POST /consents](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/consents/createconsent.md): Returns a redirect URL for the PSU to authorise the consent with the chosen bank. ### Get consents - [GET /consents](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/consents/getconsents.md) ### Refresh consent - [PUT /consents/{id}/refresh](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/consents/refreshconsent.md): Returns a redirect URL for the PSU to re-authorise an expiring consent. ### Get consent - [GET /consents/{id}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/consents/getconsent.md) ### Delete consent - [DELETE /consents/{id}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/consents/deleteconsent.md): The PSU can also withdraw the consent independently at any point. ## Payments ### Initiate bulk payment - [POST /bulk-payments/{paymentProduct}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/payments/initiatepayment.md): All payments in the bulk must share the same debtor account (or creditor account for direct-debit payments) and requested execution date. ### Get bulk payments - [GET /bulk-payments/{paymentProduct}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/payments/getbulkpayments.md) ### Get bulk payment information - [GET /bulk-payments/{paymentProduct}/{paymentId}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/payments/getbulkpaymentinformation.md) ### Get payment status - [GET /payments/{paymentProduct}/{paymentId}/status](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/payments/getpaymentstatus.md) ### Start authorisation - [POST /payments/{paymentProduct}/{paymentId}/authorizations](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/payments/startauthorization.md): The PSU will be redirected to complete Strong Customer Authentication (SCA). ### Update authorisation - [PUT /payments/{paymentProduct}/{paymentId}/authorizations/{authorizationId}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/payments/updateauthorization.md): Called after the PSU has completed the redirect SCA flow. ### Get payment information - [GET /payments/{paymentProduct}/{paymentId}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/payments/getpaymentinformation.md) ## 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. ### Get signing basket - [GET /signing-baskets/{basketId}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/signingbaskets/getsigningbasket.md) ### Cancel signing basket - [DELETE /signing-baskets/{basketId}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/signingbaskets/cancelsigningbasket.md) ### Get signing basket status - [GET /signing-baskets/{basketId}/status](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/signingbaskets/getsigningbasketstatus.md) ### Start basket authorisation - [POST /signing-baskets/{basketId}/authorizations](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/signingbaskets/startsigningbasketauthorization.md): The PSU will be redirected to complete SCA for all payments in the basket. ### Update basket authorisation - [PUT /signing-baskets/{basketId}/authorizations/{authorizationId}](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/signingbaskets/updatesigningbasketauthorization.md): Called after the PSU has completed the redirect SCA flow. ### Create signing basket - [POST /signing-baskets](https://developer.aritma.com/apis/banking/v4/openapi/banking-openapi/signingbaskets/createsigningbasket.md): The basket can contain bulk payments and individual payment lines with different authorisation requirements. Payments are exported as soon as their requirements are fulfilled.