Accounts

These endpoints provide authorized access to an authenticated user's account information.

Get information for all accounts

The GET /accounts endpoint retrieves information for all bank accounts.

SecurityBearer or BasicAuth
Request
header Parameters
on-behalf-of
required
string

The tokenId represents the consent granted by the user (PSU).

Example: ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4>

The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.

Example: 172.16.254.1
Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a payment, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

get/accounts
Request samples 
Response samples 
application/json
{
  • "accounts": [
    ]
}
Get account information
The GET /accounts/{accountId} endpoint retrieves the information for a specific bank account.


SecurityBearer or BasicAuth 
Request 
path Parameters
accountId
string
The system-generated, unique bank account id, which specifies the account for which the information is requested.


 
 Example:  a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
header Parameters
on-behalf-of
required
string
The tokenId represents the consent granted by the user (PSU).


 
 Example:  ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4> 
The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.


 
 Example:  172.16.254.1
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a payment, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/accounts/{accountId}
Request samples 
Response samples 
application/json
{
  • "account": {
    }
}
Get account balances
The GET /account-balance endpoint retrieves the balances for multiple bank accounts.


SecurityBearer or BasicAuth 
Request 
query Parameters
accountId
Array of strings
A list of account ids for which you wish to retrieve account balances. Each accountId should be specified separately as accountId=a:xxx:xxx&accountId=a:yyy:yyy.


 
 Example:  accountId=a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV&accountId=a:9TFpwkcQmcsMbdjQcpdjfsEBosDw28503fAAGPEMF2MVF19hfk3nc&accountId=a:rtmv254gaskGLdkadQvdNesk2Y9ferbvpaom5mvepm0mv2nfGnaix
header Parameters
on-behalf-of
required
string
The tokenId represents the consent granted by the user (PSU).


 
 Example:  ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4> 
The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.


 
 Example:  172.16.254.1
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a payment, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/account-balance
Request samples 
Response samples 
application/json
{
  • "response": [
    ]
}
Get an account balance
The GET /accounts/{accountId}/balance endpoint retrieves the balance for a given bank account.


SecurityBearer or BasicAuth 
Request 
path Parameters
accountId
string
The unique bank account id, which specifies the account for which the information is requested.


 
 Example:  a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
header Parameters
on-behalf-of
required
string
The tokenId represents the consent granted by the user (PSU).


 
 Example:  ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4> 
The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.


 
 Example:  172.16.254.1
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a payment, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/accounts/{accountId}/balance
Request samples 
Response samples 
application/json
{
  • "balance": {
    },
  • "status": "SUCCESSFUL_REQUEST"
}
Get information for all standing orders
The GET /accounts/{accountId}/standing-orders endpoint retrieves information for all standing orders in a given account, once consent has been given.


SecurityBearer or BasicAuth 
Request 
path Parameters
accountId
string
The unique bank account id, which specifies the account for which the information is requested.


 
 Example:  a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
query Parameters
page.offset
string
The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data. 
The offset is not visible to a user and should not be parsed and/or understood in any way.


 
 Example:  page.offset=LerV6Jmex
page.limit
required
integer <int32> 
 Default:  1
The maximum number of records to return. This must be less than 200.


 
 Example:  page.limit=175
header Parameters
on-behalf-of
required
string
The tokenId represents the consent granted by the user (PSU).


 
 Example:  ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4> 
The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.


 
 Example:  172.16.254.1
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a payment, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/accounts/{accountId}/standing-orders
Request samples 
Response samples 
application/json
{
  • "offset": "LerV6Jmex",
  • "standingOrders": [
    ],
  • "status": "SUCCESSFUL_REQUEST"
}
Get standing order information
The GET /accounts/{accountId}/standing-orders/{standingOrderId} endpoint retrieves information for a specific standing order in a given account, once consent has been given.


SecurityBearer or BasicAuth 
Request 
path Parameters
accountId
string
The system-generated, unique bank account id, which specifies the account for which the information is requested.


 
 Example:  a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
standingOrderId
required
string
The unique standing order identifier, which specifies the standing order requested.


 
header Parameters
on-behalf-of
required
string
The tokenId represents the consent granted by the user (PSU).


 
 Example:  ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4> 
The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.


 
 Example:  172.16.254.1
Responses 
200
Successful response


400
The client specified an invalid argument


get/accounts/{accountId}/standing-orders/{standingOrderId}
Request samples 
Response samples 
application/json
{
  • "standingOrder": {
    },
  • "status": "SUCCESSFUL_REQUEST"
}
Get account transactions
The GET /accounts/{accountId}/transactions endpoint retrieves information for all transactions in a given account.


SecurityBearer or BasicAuth 
Request 
path Parameters
accountId
string
The system-generated unique bank account id, which specifies the account for which the information is requested.


 
 Example:  a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
query Parameters
page.offset
string
The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data. 
The offset is not visible to a user and should not be parsed and/or understood in any way.


 
 Example:  page.offset=LerV6Jmex
page.limit
required
integer <int32> 
 Default:  1
The maximum number of records to return. This must be less than 200.


 
 Example:  page.limit=175
startDate
string
The earliest transaction date requested, in ISO 8601 format.


 
 Example:  startDate=2022-06-15
endDate
string
The latest transaction date requested, in ISO 8601 format.


 
 Example:  endDate=2022-11-30
header Parameters
on-behalf-of
required
string
The tokenId represents the consent granted by the user (PSU).


 
 Example:  ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4> 
The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.


 
 Example:  172.16.254.1
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a payment, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/accounts/{accountId}/transactions
Request samples 
Response samples 
application/json
{
  • "offset": "LerV6Jmex",
  • "status": "SUCCESSFUL_REQUEST",
  • "transactions": [
    ]
}
Get transaction information
The GET /accounts/{accountId}/transaction/{transactionId} endpoint retrieves information for a specific transaction in a given account.


SecurityBearer or BasicAuth 
Request 
path Parameters
accountId
string
The unique bank account id, which specifies the account for which the information is requested.


 
 Example:  a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
transactionId
required
string
The unique transaction identifier, which specifies the transaction requested.


 
 Example:  42909b155d4942299c39017686b5dc36
header Parameters
on-behalf-of
required
string
The tokenId represents the consent granted by the user (PSU).


 
 Example:  ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq
token-customer-ip-address
string <ipv4> 
The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.


 
 Example:  172.16.254.1
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a payment, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/accounts/{accountId}/transaction/{transactionId}
Request samples 
Response samples 
application/json
{
  • "status": "SUCCESSFUL_REQUEST",
  • "transaction": {
    }
}
➔ Next to Tokens