Provides details of user's bank accounts and transaction histories.
Accounts Information Service
Provides details of user's bank accounts and transaction histories.
Establish Account Information Consent
Creates an account information consent resource at the ASPSP regarding access to accounts specified in this request. All permitted "access" attributes ("accounts", "balances" and "transactions") used in this message shall carry a non-empty array of account references, indicating the accounts where the type of access is requested. Please note that a "transactions", "balances" or "accounts" access right also gives access to the generic /accounts endpoints. "access" attributes can carry an empty array, indicating that TPP is asking for accessible account list.
/ais/{apiGroupVersion}/consents/account-access
RESPONSES
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
{
"access": {
"payments": [
{
"rights": [
"ais"
]
}
]
},
"consentType": "global",
"recurringIndicator": true,
"validTo": "2017-10-30",
"frequencyPerDay": "10"
}Responses
201
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"consentId": "e521cf62-a45f-49c5-8372-94853fffeb55",
"consentStatus": "received",
"_links": {
"startAuthorisation": {
"href": "/consents/account-access/e521cf62-a45f-49c5-8372-94853fffeb55/authorisations"
}
}
}
}
}Get SCA status
Checks the SCA status of a authorisation sub-resource.
/ais/{apiGroupVersion}/consents/account-access/{consent-id}/authorisations/{authorisation-id}
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"scaStatus": "received",
"_links": {
"scaRedirect": {
"href": "https://bank.com/sca"
}
}
}
}
}Get authorisation sub-resources
Will deliver an array of resource identifications of all generated authorisation sub-resources.
/ais/{apiGroupVersion}/consents/account-access/{consent-id}/authorisations
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"authorisationsIds": [
123321
]
}
}
}Start authorisation process
Starts an authorisation process in for establishing account information consent data on the server.
/ais/{apiGroupVersion}/consents/account-access/{consent-id}/authorisations
RESPONSES
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
201
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"scaStatus": "received",
"authorisationId": "d3f9c3f2-7a8f-4c7f-9b7e-b02e6fdc9420",
"_links": {
"scaRedirect": {
"href": "https://bank.com/sca"
}
}
}
}
}Read Transaction details
Reads transaction data from a given account addressed by 'account-id' and 'transactionId'. This call is only available on transactions as reported in a JSON format.
/ais/{apiGroupVersion}/accounts/{account-id}/transactions/{transactionId}
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"account": {
"iban": "LV80BANK0000435195001",
"currency": "MKD"
},
"transactionsDetails": {
"transactionId": 123,
"debtor": {
"name": "Debtor name"
},
"debtorAccount": {
"iban": "LV80BANK0000435195001",
"currency": "MKD"
},
"creditor": {
"name": "Creditor name"
},
"creditorAccount": {
"iban": "LV80BANK0000435195321",
"currency": "MKD"
},
"transactionAmount": {
"currency": "MKD",
"amount": 123.32
},
"bookingDate": "2012-12-12",
"valueDate": "2012-12-12",
"remittanceInformationUnstructured": "Some details"
}
}
}
}Get Consent
Returns the content of an account information consent object.
/ais/{apiGroupVersion}/consents/account-access/{consent-id}
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"access": {
"payments": [
{
"rights": [
"ais"
]
}
]
},
"consentType": "global",
"recurringIndicator": true,
"validTo": "2017-10-30",
"frequencyPerDay": "20",
"consentStatus": "valid"
}
}
}Delete Consent
Delete an account information consent object.
/ais/{apiGroupVersion}/consents/account-access/{consent-id}
RESPONSES
204
No Content
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
204
400
401
403
404
405
406
415
429
Get Status of consent
Can check the status of an account information consent resource.
/ais/{apiGroupVersion}/consents/account-access/{consent-id}/status
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"consentStatus": "received"
}
}
}Read Transactions List
Reads account data from a given account addressed by 'account-id'.
/ais/{apiGroupVersion}/accounts/{account-id}/transactions
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"account": {
"iban": "LV80BANK0000435195001",
"currency": "MKD"
},
"transactions": {
"booked": [
{
"transactionId": 123,
"debtor": {
"name": "Debtor name"
},
"debtorAccount": {
"iban": "LV80BANK0000435195001",
"currency": "MKD"
},
"creditor": {
"name": "Creditor name"
},
"creditorAccount": {
"iban": "LV80BANK0000435195321",
"currency": "MKD"
},
"transactionAmount": {
"currency": "MKD",
"amount": 123.32
},
"bookingDate": "2012-12-12",
"valueDate": "2012-12-12",
"remittanceInformationUnstructured": "Some details"
}
],
"pending": [
{
"transactionId": 321,
"debtor": {
"name": "Debtor name"
},
"debtorAccount": {
"iban": "LV80BANK0000435195001",
"currency": "MKD"
},
"creditor": {
"name": "Creditor name"
},
"creditorAccount": {
"iban": "LV80BANK0000435195321",
"currency": "MKD"
},
"transactionAmount": {
"currency": "MKD",
"amount": 333.32
},
"valueDate": "2012-12-12",
"remittanceInformationUnstructured": "Some details 2"
}
]
},
"balances": [
{
"balanceAmount": {
"currency": "MKD",
"amount": 12.21
},
"balanceType": "closingBooked",
"referenceDate": "2021-12-12"
}
]
}
}
}Read Account Details
Reads details about an account, with balances where required.
/ais/{apiGroupVersion}/accounts/{account-id}
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"account": {
"iban": "LV80BANK0000435195001",
"currency": "MKD",
"resourceId": 12321,
"name": "string",
"balances": [
{
"balanceAmount": {
"currency": "MKD",
"amount": 12.21
},
"balanceType": "closingBooked",
"referenceDate": "2021-12-12"
}
]
}
}
}
}Read Balance
Reads account data from a given account addressed by 'account-id'.
/ais/{apiGroupVersion}/accounts/{account-id}/balances
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"account": {
"iban": "LV80BANK0000435195001",
"currency": "MKD"
},
"balances": [
{
"balanceAmount": {
"currency": "MKD",
"amount": 12.21
},
"balanceType": "closingBooked",
"referenceDate": "2021-12-12"
}
]
}
}
}Read Accounts List
Reads a list of bank accounts, with balances where required.
/ais/{apiGroupVersion}/accounts
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"accounts": [
{
"iban": "LV80BANK0000435195001",
"currency": "MKD",
"resourceId": 12321,
"name": "string",
"balances": [
{
"balanceAmount": {
"currency": "MKD",
"amount": 12.21
},
"balanceType": "closingBooked",
"referenceDate": "2021-12-12"
}
]
}
]
}
}
}