Create
The API allows the TPP to ask an ASPSP to create a new account-access-consent resource.
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IlBlcm1pc3Npb25zIjpbIlJlYWRBY2NvdW50c0Jhc2ljIiwiUmVhZEFjY291bnRzRGV0YWlsIiwiUmVhZEJhbGFuY2VzIiwiUmVhZEJlbmVmaWNpYXJpZXNEZXRhaWwiLCJSZWFkVHJhbnNhY3Rpb25zQmFzaWMiLCJSZWFkVHJhbnNhY3Rpb25zQ3JlZGl0cyIsIlJlYWRUcmFuc2FjdGlvbnNEZWJpdHMiLCJSZWFkVHJhbnNhY3Rpb25zRGV0YWlsIiwiUmVhZE9mZmVycyIsIlJlYWRQQU4iLCJSZWFkUGFydHkiLCJSZWFkUGFydHlQU1UiLCJSZWFkUHJvZHVjdHMiLCJSZWFkU3RhbmRpbmdPcmRlcnNEZXRhaWwiLCJSZWFkU2NoZWR1bGVkUGF5bWVudHNEZXRhaWwiLCJSZWFkU3RhdGVtZW50c0RldGFpbCIsIlJlYWREaXJlY3REZWJpdHMiXSwiRXhwaXJhdGlvbkRhdGVUaW1lIjoiMjAxNy0wNS0wMlQwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uRnJvbURhdGVUaW1lIjoiMjAxNy0wNS0wM1QwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uVG9EYXRlVGltZSI6IjIwMTctMTItMDNUMDA6MDA6MDArMDA6MDAifSwiUmlzayI6e319.G2ST4u6QP18mBEyz8bt0DT__6bTqHGLvguZ-fiPzxyvxWLs39lwYHKzb89Qvf5lES_qA1gh2_H793FvXNEuIMBkfqEjVk5Rsu56EwOVVQeIaCI6VxCGEXSrtiHNfapms9OJw-ryH7e0Ud_8MNe9N2JzUnjAjZDVa4OxPIpS9HsP0qYAId4UWvWXXLhMKz9j2IMYsj3vRrBUorGDCPESd0jg4H-3RH1fQxm95MzVIX5h17ChpADMuwVZeaYnkFi7xVvStwV3qVBigSYkrXCUAz0DKJdvNyFHRBX8JNOAuhYJZyOC1AvlPEjSQJflJH0Tm0bFwiDiU_S1nyZpIfKVEEw' \
-X POST "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IlBlcm1pc3Npb25zIjpbIlJlYWRBY2NvdW50c0Jhc2ljIiwiUmVhZEFjY291bnRzRGV0YWlsIiwiUmVhZEJhbGFuY2VzIiwiUmVhZEJlbmVmaWNpYXJpZXNEZXRhaWwiLCJSZWFkVHJhbnNhY3Rpb25zQmFzaWMiLCJSZWFkVHJhbnNhY3Rpb25zQ3JlZGl0cyIsIlJlYWRUcmFuc2FjdGlvbnNEZWJpdHMiLCJSZWFkVHJhbnNhY3Rpb25zRGV0YWlsIiwiUmVhZE9mZmVycyIsIlJlYWRQQU4iLCJSZWFkUGFydHkiLCJSZWFkUGFydHlQU1UiLCJSZWFkUHJvZHVjdHMiLCJSZWFkU3RhbmRpbmdPcmRlcnNEZXRhaWwiLCJSZWFkU2NoZWR1bGVkUGF5bWVudHNEZXRhaWwiLCJSZWFkU3RhdGVtZW50c0RldGFpbCIsIlJlYWREaXJlY3REZWJpdHMiXSwiRXhwaXJhdGlvbkRhdGVUaW1lIjoiMjAxNy0wNS0wMlQwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uRnJvbURhdGVUaW1lIjoiMjAxNy0wNS0wM1QwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uVG9EYXRlVGltZSI6IjIwMTctMTItMDNUMDA6MDA6MDArMDA6MDAifSwiUmlzayI6e319.G2ST4u6QP18mBEyz8bt0DT__6bTqHGLvguZ-fiPzxyvxWLs39lwYHKzb89Qvf5lES_qA1gh2_H793FvXNEuIMBkfqEjVk5Rsu56EwOVVQeIaCI6VxCGEXSrtiHNfapms9OJw-ryH7e0Ud_8MNe9N2JzUnjAjZDVa4OxPIpS9HsP0qYAId4UWvWXXLhMKz9j2IMYsj3vRrBUorGDCPESd0jg4H-3RH1fQxm95MzVIX5h17ChpADMuwVZeaYnkFi7xVvStwV3qVBigSYkrXCUAz0DKJdvNyFHRBX8JNOAuhYJZyOC1AvlPEjSQJflJH0Tm0bFwiDiU_S1nyZpIfKVEEw' \
-X POST "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents"
Example of request
{"Data":{"Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-05-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{}}
{"Data":{"Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-05-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{}}
Example of response
{"Data":{"ConsentId":"urn-alphabank-intent-88379","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-05-02T00:00:00+00:00","CreationDateTime":"2017-05-02T00:00:00+00:00","Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-08-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/account-access-consents/urn-alphabank-intent-88379"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"urn-alphabank-intent-88379","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-05-02T00:00:00+00:00","CreationDateTime":"2017-05-02T00:00:00+00:00","Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-08-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/account-access-consents/urn-alphabank-intent-88379"},"Meta":{"TotalPages":1}}
Request
POST
/api/:provider_code/open-banking/v3.1/aisp/account-access-consents
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
hash, required
Wrapper for the data.
array, required
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
Allowed values:
ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail, ReadOffers, ReadPAN, ReadProducts, ReadScheduledPaymentsDetail, ReadStatementsDetail, ReadBeneficiariesDetail, ReadBeneficiariesBasic, ReadDirectDebits, ReadStandingOrdersDetail, ReadStandingOrdersBasic, ReadParty, ReadPartyPSU
Can raise:
FieldInvalid
datetime, required
Specified date and time the permissions will expire.
Values in range between:
2024-09-07T11:41:23+00:00 and 2024-12-06T11:41:23Z
Can raise:
FieldInvalidDate
datetime, optional
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
datetime, optional
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.
hash, optional
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
string, required
Unique identification as assigned to identify the account access consent resource.
Can raise:
FieldInvalid
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Revoked
Can raise:
FieldInvalid
datetime, required
Date and time at which the resource status was updated.
datetime, required
Date and time at which the resource was created.
array, required
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
Allowed values:
ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail, ReadOffers, ReadPAN, ReadProducts, ReadScheduledPaymentsDetail, ReadStatementsDetail, ReadBeneficiariesDetail, ReadBeneficiariesBasic, ReadDirectDebits, ReadStandingOrdersDetail, ReadStandingOrdersBasic, ReadParty, ReadPartyPSU
datetime, optional
Specified date and time the permissions will expire.
datetime, optional
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
datetime, optional
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
FieldInvalidDate
|
400 |
An invalid date is supplied. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
Show
A TPP may optionally retrieve an account-access-consent resource that they have created to check its status. Prior to calling the API, the TPP must have an access token issued by the ASPSP using a client credentials grant.
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Q-iPB3_Foi4XWFd1Fvpt3KjwTJ5LXAmMlH31lDg2xMPMHVvrpfU6PQicg5ktOM08I453kVEbpBb5aeFwv5s7-La63CnTVvNdVTkqI3QBligwSHwYn71IlrwhxaHD3pf4CpXjdBcsyTEWd06J0NQ0KF_Szt-ILX15ipoU0k1FkCyrjFdYEfwxu2mj_GVzqfJ9EcFRAV8eN1a4ST8hNQ0ITxPyhMWdE7POLVFZc8HJC4r06LI9dRzOfKCXFNBUu3VQE5Ouft3Z1VjiqXrehyKV2zmwUei-tQfTODsUCcE0tP1OqWfPtZ-hNGO_PtJSn6UXebxY2zAo4M3H-09DuyUncA' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Q-iPB3_Foi4XWFd1Fvpt3KjwTJ5LXAmMlH31lDg2xMPMHVvrpfU6PQicg5ktOM08I453kVEbpBb5aeFwv5s7-La63CnTVvNdVTkqI3QBligwSHwYn71IlrwhxaHD3pf4CpXjdBcsyTEWd06J0NQ0KF_Szt-ILX15ipoU0k1FkCyrjFdYEfwxu2mj_GVzqfJ9EcFRAV8eN1a4ST8hNQ0ITxPyhMWdE7POLVFZc8HJC4r06LI9dRzOfKCXFNBUu3VQE5Ouft3Z1VjiqXrehyKV2zmwUei-tQfTODsUCcE0tP1OqWfPtZ-hNGO_PtJSn6UXebxY2zAo4M3H-09DuyUncA' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id"
Example of response
{"Data":{"ConsentId":"urn-alphabank-intent-88379","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-05-02T00:00:00+00:00","CreationDateTime":"2017-05-02T00:00:00+00:00","Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-08-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/account-access-consents/urn-alphabank-intent-88379"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"urn-alphabank-intent-88379","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-05-02T00:00:00+00:00","CreationDateTime":"2017-05-02T00:00:00+00:00","Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-08-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/account-access-consents/urn-alphabank-intent-88379"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
string, required
Unique identification as assigned to identify the account access consent resource.
Can raise:
FieldInvalid, ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
string, required
Unique identification as assigned to identify the account access consent resource.
Can raise:
FieldInvalid
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Revoked
Can raise:
FieldInvalid
datetime, required
Date and time at which the resource status was updated.
datetime, required
Date and time at which the resource was created.
array, required
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
Allowed values:
ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail, ReadOffers, ReadPAN, ReadProducts, ReadScheduledPaymentsDetail, ReadStatementsDetail, ReadBeneficiariesDetail, ReadBeneficiariesBasic, ReadDirectDebits, ReadStandingOrdersDetail, ReadStandingOrdersBasic, ReadParty, ReadPartyPSU
datetime, optional
Specified date and time the permissions will expire.
datetime, optional
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
datetime, optional
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
Destroy
If the PSU revokes consent to data access with the TPP, the TPP must delete the account-access-consent resource with the ASPSP as soon as is practically possible.
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.lc9JSmDIU6GD0JgyqkRC9hUj-E1AGWUVYwtLVaa1VVtMT8RW4ClKdrBgMZDqE6gPM-T3GM86V688voINsgF-e9e1kvWIX6q9bS6ZnjmfuwRm9QQaBrLqTfxV_BdH9YCUJ5vBU7eXeFtRlwfMH_nDj6BGtyh0lPhvNXrYbbL0cLToM5Ted1zHA2Kd5i5sVY_5l8HP-gl9mBYXhZolqsEQdkAq9gBRHXC9ddxvyTX1Rtt2FPLjXxs_clPzWDwgeF16rI_58-9742bPche96rT_BcVyNy9TouYnqIi0ySHjl7EhxBPt8gtX77drkPb2IeaTC-AODg510WkjHFXrBY6ZZw' \
-X DELETE "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.lc9JSmDIU6GD0JgyqkRC9hUj-E1AGWUVYwtLVaa1VVtMT8RW4ClKdrBgMZDqE6gPM-T3GM86V688voINsgF-e9e1kvWIX6q9bS6ZnjmfuwRm9QQaBrLqTfxV_BdH9YCUJ5vBU7eXeFtRlwfMH_nDj6BGtyh0lPhvNXrYbbL0cLToM5Ted1zHA2Kd5i5sVY_5l8HP-gl9mBYXhZolqsEQdkAq9gBRHXC9ddxvyTX1Rtt2FPLjXxs_clPzWDwgeF16rI_58-9742bPche96rT_BcVyNy9TouYnqIi0ySHjl7EhxBPt8gtX77drkPb2IeaTC-AODg510WkjHFXrBY6ZZw' \
-X DELETE "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id"
Request
DELETE
/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
string, required
Unique identification as assigned to identify the account access consent resource.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
ResourceInvalidConsentStatus
|
400 |
The action can't be performed with current status of consent. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Unauthorized
|
401 |
Unauthorized access. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
Refresh
A lot of ASPSP's can not return imediately all AIS information. Call the POST /refresh endpoint before GET /accounts .
TPP should await success or fail final status. TPP may retrieve status by calling GET /refresh_status.
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkluaXRpYXRlZEJ5Q3VzdG9tZXIiOnRydWV9fQ.uOMKb3ixXX64WP3pNLqIQAXF_u-Bw9ytHyJrwPF70PeDeMqNuIF-yuyyN4U_YKaZZpBVX92KfS1moWy8bSb3GlHl_ulQNrg2VqpQhJjqZ8FfbXXV7Kcx7lNjpXjDNIThmW_V0Mcsflnh7mYd8xj9T2VWq2OKAPhQJOIq-hV9449y8kZZYoSMGvSqsNAzAHRq8k06auG7RJIIjZUt-KR0QTwdkyD_mL381mJ8X5oN_WbvbboXhlFq4_cI70ZTIY1uFOrpNcHclCe3ulq9PhfA7pGof5dyhoqEiZvcn_qvtVBFhlX1ROnjD-1_cBo8AIVer4Z9c5VJjA_i6bFjCRTymw' \
-X POST "/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkluaXRpYXRlZEJ5Q3VzdG9tZXIiOnRydWV9fQ.uOMKb3ixXX64WP3pNLqIQAXF_u-Bw9ytHyJrwPF70PeDeMqNuIF-yuyyN4U_YKaZZpBVX92KfS1moWy8bSb3GlHl_ulQNrg2VqpQhJjqZ8FfbXXV7Kcx7lNjpXjDNIThmW_V0Mcsflnh7mYd8xj9T2VWq2OKAPhQJOIq-hV9449y8kZZYoSMGvSqsNAzAHRq8k06auG7RJIIjZUt-KR0QTwdkyD_mL381mJ8X5oN_WbvbboXhlFq4_cI70ZTIY1uFOrpNcHclCe3ulq9PhfA7pGof5dyhoqEiZvcn_qvtVBFhlX1ROnjD-1_cBo8AIVer4Z9c5VJjA_i6bFjCRTymw' \
-X POST "/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh"
Example of request
{"Data":{"InitiatedByCustomer":true}}
{"Data":{"InitiatedByCustomer":true}}
Example of response
{"Data":{"Status":"Processing"},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/refresh/status"},"Meta":{"TotalPages":1}}
{"Data":{"Status":"Processing"},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/refresh/status"},"Meta":{"TotalPages":1}}
Request
POST
/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
boolean, optional
Defines whether request was initiated by customer or automatically. Automatic requests can be performed no more than 4 times per 24 hours.
Default value:
false
Can raise:
ActionNotAllowed, AccessExceeded, AccessExceeded
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
string, required
Specifies the status of refresh process.
Allowed values:
NotInitiated, Processing, FetchingFinished, FetchingFailed, PartiallyFailed
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
ResourceInvalidConsentStatus
|
400 |
The action can't be performed with current status of consent. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Unauthorized
|
401 |
Unauthorized access. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
ActionNotAllowed
|
406 |
You're not allowed to perform this action. This might be a configuration problem or parameters incompatibility. |
TooEarly
|
425 |
The service is not ready to process the request. |
AccessExceeded
|
429 |
Exceeded the number of automatic requests for this action. |
AccessExceeded
|
429 |
Exceeded the number of automatic requests for this action. |
Status of Refresh
TPP can retrieve REFRESH process status by calling the GET /refresh_status endpoint.
TPP should await success final status before request AIS info (e.g. accounts, transactions, balances).
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.hBtKE4cPcjHFTc7nEkbcTOW-MF1u1x8wYWU4Q9xrXd8n4qbQWnWYQ3ju4JxttrYAjmtYxgqJRKqArjWJteVfFN7WnzWNPeSxGre142aujaO0MmvcVl0QCHyhiXSN1FhQ-LYXE7POGSA-iZKEzDsnwNB54lLY1L8ycA1XtO0Br1-F4MxInCg9hp4Nts1JfD18LrErWvmvuybFvl-yy0heQPYarpK4_lAdDEBQ7eX0jCsFd2AaJdansgkKIOUcnYKxOMJ_F4IeYx1QaY1DYM578IAnlc42gBR2OcPfxsm4K-pR0buH1g0-X3oIm-04FgsMxs-Cj9nLDsTYToB5bza93Q' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh/status"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.hBtKE4cPcjHFTc7nEkbcTOW-MF1u1x8wYWU4Q9xrXd8n4qbQWnWYQ3ju4JxttrYAjmtYxgqJRKqArjWJteVfFN7WnzWNPeSxGre142aujaO0MmvcVl0QCHyhiXSN1FhQ-LYXE7POGSA-iZKEzDsnwNB54lLY1L8ycA1XtO0Br1-F4MxInCg9hp4Nts1JfD18LrErWvmvuybFvl-yy0heQPYarpK4_lAdDEBQ7eX0jCsFd2AaJdansgkKIOUcnYKxOMJ_F4IeYx1QaY1DYM578IAnlc42gBR2OcPfxsm4K-pR0buH1g0-X3oIm-04FgsMxs-Cj9nLDsTYToB5bza93Q' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh/status"
Example of response
{"Data":{"Status":"FetchingFinished"},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/refresh/status"},"Meta":{"TotalPages":1}}
{"Data":{"Status":"FetchingFinished"},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/refresh/status"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh/status
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
string, required
Specifies the status of refresh process.
Allowed values:
NotInitiated, Processing, FetchingFinished, FetchingFailed, PartiallyFailed
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
Index
The first step for a TPP after an account request is authorised - is to call the GET /accounts endpoint.
A TPP will be given the full list of accounts (the AccountId(s)) that the PSU has authorised the TPP to access. The AccountId(s) returned may then be used to retrieve other resources for a specific AccountId. The selection of authorised accounts happens only at the ASPSP's interface.
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.O76t5beZe_PHoZnSSCNqyZa7wPr_Mm0zMfguyt74w42nAiyU7KGPgLbXkutPrVWPdTmqG-Txfy36hht92D2I7Qd7p9KUxO38007Hj6nu6JpXGq0TCu7JaENt3ZxSRlkqGHSzZcHvgQJY4eHKZo8de3lvbB2v4CecjtE4Fep5kbWNxM2B6OjcbCqfGOqxJXfCNf9AwoFyMGMM8cVZjkJeb-qZmLfBg7mLA2Qye3f7PZ5v6A617qynE2BFZMyZpOXwQ_JFaCX1r94GS3f0ILH8HtX3lnqRQgs8YQZznMgcAaG5h2W2JoPIGoqA8YmOYuviZrvxOz4vGdbXpr2GJAxaBw' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.O76t5beZe_PHoZnSSCNqyZa7wPr_Mm0zMfguyt74w42nAiyU7KGPgLbXkutPrVWPdTmqG-Txfy36hht92D2I7Qd7p9KUxO38007Hj6nu6JpXGq0TCu7JaENt3ZxSRlkqGHSzZcHvgQJY4eHKZo8de3lvbB2v4CecjtE4Fep5kbWNxM2B6OjcbCqfGOqxJXfCNf9AwoFyMGMM8cVZjkJeb-qZmLfBg7mLA2Qye3f7PZ5v6A617qynE2BFZMyZpOXwQ_JFaCX1r94GS3f0ILH8HtX3lnqRQgs8YQZznMgcAaG5h2W2JoPIGoqA8YmOYuviZrvxOz4vGdbXpr2GJAxaBw' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts"
Example of response
{"Data":{"Account":[{"AccountId":"22289","Status":"Enabled","StatusUpdateDateTime":"2019-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Description":"Description of account","Nickname":"Bills","OpeningDate":"2019-01-01","MaturityDate":"2019-01-01","SwitchStatus":"processing","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203345","Name":"Mr Kevin","SecondaryIdentification":"00021"}],"Servicer":{"SchemeName":"UK.OBIE.BICFI","Identification":"80200110203345"}},{"AccountId":"31820","Status":"Enabled","StatusUpdateDateTime":"2018-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Nickname":"Household","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203348","Name":"Mr Kevin"}]}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/"},"Meta":{"TotalPages":1}}
{"Data":{"Account":[{"AccountId":"22289","Status":"Enabled","StatusUpdateDateTime":"2019-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Description":"Description of account","Nickname":"Bills","OpeningDate":"2019-01-01","MaturityDate":"2019-01-01","SwitchStatus":"processing","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203345","Name":"Mr Kevin","SecondaryIdentification":"00021"}],"Servicer":{"SchemeName":"UK.OBIE.BICFI","Identification":"80200110203345"}},{"AccountId":"31820","Status":"Enabled","StatusUpdateDateTime":"2018-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Nickname":"Household","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203348","Name":"Mr Kevin"}]}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1/aisp/accounts
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
array, required
Unambiguous identification of the account to which credit and debit entries are made.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Can raise:
FieldInvalid
string, optional
Specifies the status of account resource in code form.
Allowed values:
Enabled, Disabled, Deleted, ProForma, Pending
Can raise:
FieldInvalid
datetime, optional
Date and time at which the resource status was updated.
string, optional
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
Can raise:
FieldInvalid, UnsupportedCurrency
string, optional
Specifies the type of account (personal or business).
Allowed values:
Business, Personal
Can raise:
FieldInvalid
string, optional
Specifies the sub type of account (product family group).
Allowed values:
ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings
Can raise:
FieldInvalid
string, optional
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
Can raise:
FieldInvalid
string, optional
Specifies the description of the account type.
Can raise:
FieldInvalid
date, optional
Date on which the account and related basic services are effectively operational for the account owner.
date, optional
Maturity date for the account.
string, optional
The switch status for the account.
Can raise:
FieldInvalid
array, optional
Unambiguous identification of the account to which credit and debit entries are made.
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
string, optional
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
hash, optional
Party that manages the account on behalf of the account owner, that manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
string, required
Unique and unambiguous identification of the servicing institution.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
ResourceInvalidConsentStatus
|
400 |
The action can't be performed with current status of consent. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Unauthorized
|
401 |
Unauthorized access. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
TooEarly
|
425 |
The service is not ready to process the request. |
Show
A TPP may retrieve the account information resources for the AccountId (which is retrieved in the call to GET /accounts).
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.RuB6BhIOetEytor7lpgfhY0OI307-ZvQRCeIx7OVT-oMKsbPF4XLQYDNrUHgYRlXSHkAa9H03bqU7nnJtEYWGmXsiSVgTc-_VIPUnxGKS-7rX__LysOceSRi0CeCsw_uwlT89ko4_sK3UuAq17Gin8pqbc3gpPVpLlZO5HuWOyT6N97nxxqMTv3P0ofmYnKSuqDQfY7nlK04Bk1TLwNaW8g_WkgyYgEpJoPl_P7qFOr2G8Zu3OihRx1nqcAqQnAGdbZQrWdK8B6O4UzekcKb8QTVLLmEjKV2j4tQb8-uW9Sw8wWOOri7beMB9_NtEa29SS0P3V3f3dOG9IJIMShkTA' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.RuB6BhIOetEytor7lpgfhY0OI307-ZvQRCeIx7OVT-oMKsbPF4XLQYDNrUHgYRlXSHkAa9H03bqU7nnJtEYWGmXsiSVgTc-_VIPUnxGKS-7rX__LysOceSRi0CeCsw_uwlT89ko4_sK3UuAq17Gin8pqbc3gpPVpLlZO5HuWOyT6N97nxxqMTv3P0ofmYnKSuqDQfY7nlK04Bk1TLwNaW8g_WkgyYgEpJoPl_P7qFOr2G8Zu3OihRx1nqcAqQnAGdbZQrWdK8B6O4UzekcKb8QTVLLmEjKV2j4tQb8-uW9Sw8wWOOri7beMB9_NtEa29SS0P3V3f3dOG9IJIMShkTA' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id"
Example of response
{"Data":{"Account":[{"AccountId":"22289","Status":"Enabled","StatusUpdateDateTime":"2019-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Description":"Description of account","Nickname":"Bills","OpeningDate":"2019-01-01","MaturityDate":"2019-01-01","SwitchStatus":"processing","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203345","Name":"Mr Kevin","SecondaryIdentification":"00021"}],"Servicer":{"SchemeName":"UK.OBIE.BICFI","Identification":"80200110203345"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289"},"Meta":{"TotalPages":1}}
{"Data":{"Account":[{"AccountId":"22289","Status":"Enabled","StatusUpdateDateTime":"2019-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Description":"Description of account","Nickname":"Bills","OpeningDate":"2019-01-01","MaturityDate":"2019-01-01","SwitchStatus":"processing","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203345","Name":"Mr Kevin","SecondaryIdentification":"00021"}],"Servicer":{"SchemeName":"UK.OBIE.BICFI","Identification":"80200110203345"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Can raise:
ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
array, required
Unambiguous identification of the account to which credit and debit entries are made.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Can raise:
FieldInvalid
string, optional
Specifies the status of account resource in code form.
Allowed values:
Enabled, Disabled, Deleted, ProForma, Pending
Can raise:
FieldInvalid
datetime, optional
Date and time at which the resource status was updated.
string, optional
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
Can raise:
FieldInvalid, UnsupportedCurrency
string, optional
Specifies the type of account (personal or business).
Allowed values:
Business, Personal
Can raise:
FieldInvalid
string, optional
Specifies the sub type of account (product family group).
Allowed values:
ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings
Can raise:
FieldInvalid
string, optional
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
Can raise:
FieldInvalid
string, optional
Specifies the description of the account type.
Can raise:
FieldInvalid
date, optional
Date on which the account and related basic services are effectively operational for the account owner.
date, optional
Maturity date for the account.
string, optional
The switch status for the account.
Can raise:
FieldInvalid
array, optional
Unambiguous identification of the account to which credit and debit entries are made.
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
string, optional
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
hash, optional
Party that manages the account on behalf of the account owner, that manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
string, required
Unique and unambiguous identification of the servicing institution.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
ResourceInvalidConsentStatus
|
400 |
The action can't be performed with current status of consent. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Unauthorized
|
401 |
Unauthorized access. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
TooEarly
|
425 |
The service is not ready to process the request. |
Transactions
An TPP may retrieve the transaction resource for a specific AccountId (which is retrieved in the call to GET /accounts).
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.mbKqb24OnRUUBmTiOzdZ_YMUslYnMtayX0oYjybmuYwKoRwxgGVxmqX5n1nwZCTAHaBABfBZ9dbdSPkjulKOeVahGjWCKnoNUl5biqbzfTxOrthYaPC52Fb42yujJxln8RkbK1aQ5kq0H-f3_WXhKKDh2cp2zXFeQ1JlXa7-PlgGVJ4-EbLqPGEyy3Xi6Ag5ToGH33Bn6el4p4lFLzobv54kFApYPKPPlec7PL0VLCcL2VF3xoB-eW2Q4ahA9OPUxvPS77NnNdcE_NmUUOTk6RfnDWl-zi72vnJLKUWSNbj3b6_o2u-yARGko-6CQU0Y41zlQXZT4GRDVhawjcJhhQ' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/transactions"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.mbKqb24OnRUUBmTiOzdZ_YMUslYnMtayX0oYjybmuYwKoRwxgGVxmqX5n1nwZCTAHaBABfBZ9dbdSPkjulKOeVahGjWCKnoNUl5biqbzfTxOrthYaPC52Fb42yujJxln8RkbK1aQ5kq0H-f3_WXhKKDh2cp2zXFeQ1JlXa7-PlgGVJ4-EbLqPGEyy3Xi6Ag5ToGH33Bn6el4p4lFLzobv54kFApYPKPPlec7PL0VLCcL2VF3xoB-eW2Q4ahA9OPUxvPS77NnNdcE_NmUUOTk6RfnDWl-zi72vnJLKUWSNbj3b6_o2u-yARGko-6CQU0Y41zlQXZT4GRDVhawjcJhhQ' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/transactions"
Example of response
{"Data":{"Transaction":[{"AccountId":"22289","TransactionId":"123","TransactionReference":"Ref 1","StatementReference":["some-ref"],"CreditDebitIndicator":"Credit","Status":"Booked","TransactionMutability":"Immutable","BookingDateTime":"2017-04-05T10:43:07+00:00","ValueDateTime":"2017-04-05T10:45:22+00:00","TransactionInformation":"Cash from Aubrey","Amount":{"Amount":"10.00","Currency":"GBP"},"ChargeAmount":{"Amount":"10.00","Currency":"GBP"},"CurrencyExchange":{"SourceCurrency":"EUR","TargetCurrency":"GBP","UnitCurrency":"GBP","ExchangeRate":"0.92","ContractIdentification":"some-identification","QuotationDate":"2017-04-05","InstructedAmount":{"Amount":"10.00","Currency":"GBP"}},"BankTransactionCode":{"Code":"ReceivedCreditTransfer","SubCode":"DomesticCreditTransfer"},"ProprietaryBankTransactionCode":{"Code":"Transfer","Issuer":"AlphaBank"},"Balance":{"Amount":{"Amount":"230.00","Currency":"GBP"},"Type":"InterimBooked","CreditDebitIndicator":"Credit"},"MerchantDetails":{"MerchantName":"Merchant name","MerchantCategoryCode":"some-code"},"CreditorAgent":{"SchemeName":"UK.OBIE.BICFI","Identification":"GB29NWBK60161331926819","Name":"Creditor Agent Name","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"CreditorAccount":{"SchemeName":"UK.OBIE.IBAN","Identification":"GB29NWBK60161331926819","Name":"Creditor Account Name","SecondaryIdentification":"12-34-56"},"DebtorAgent":{"SchemeName":"UK.OBIE.BICFI","Identification":"GB29NWBK60161331926810","Name":"Debtor Agent Name","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"DebtorAccount":{"SchemeName":"UK.OBIE.IBAN","Identification":"GB29NWBK60161331926810","Name":"Debtor Account Name","SecondaryIdentification":"22-33-55"},"CardInstrument":{"CardSchemeName":"Debit Card","AuthorizationType":"OAuth","Name":"Card Name","Identification":"12-34-56"},"SupplementaryData":{}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/transactions/"},"Meta":{"TotalPages":1,"FirstAvailableDateTime":"2017-05-03T00:00:00+00:00","LastAvailableDateTime":"2017-12-03T00:00:00+00:00"}}
{"Data":{"Transaction":[{"AccountId":"22289","TransactionId":"123","TransactionReference":"Ref 1","StatementReference":["some-ref"],"CreditDebitIndicator":"Credit","Status":"Booked","TransactionMutability":"Immutable","BookingDateTime":"2017-04-05T10:43:07+00:00","ValueDateTime":"2017-04-05T10:45:22+00:00","TransactionInformation":"Cash from Aubrey","Amount":{"Amount":"10.00","Currency":"GBP"},"ChargeAmount":{"Amount":"10.00","Currency":"GBP"},"CurrencyExchange":{"SourceCurrency":"EUR","TargetCurrency":"GBP","UnitCurrency":"GBP","ExchangeRate":"0.92","ContractIdentification":"some-identification","QuotationDate":"2017-04-05","InstructedAmount":{"Amount":"10.00","Currency":"GBP"}},"BankTransactionCode":{"Code":"ReceivedCreditTransfer","SubCode":"DomesticCreditTransfer"},"ProprietaryBankTransactionCode":{"Code":"Transfer","Issuer":"AlphaBank"},"Balance":{"Amount":{"Amount":"230.00","Currency":"GBP"},"Type":"InterimBooked","CreditDebitIndicator":"Credit"},"MerchantDetails":{"MerchantName":"Merchant name","MerchantCategoryCode":"some-code"},"CreditorAgent":{"SchemeName":"UK.OBIE.BICFI","Identification":"GB29NWBK60161331926819","Name":"Creditor Agent Name","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"CreditorAccount":{"SchemeName":"UK.OBIE.IBAN","Identification":"GB29NWBK60161331926819","Name":"Creditor Account Name","SecondaryIdentification":"12-34-56"},"DebtorAgent":{"SchemeName":"UK.OBIE.BICFI","Identification":"GB29NWBK60161331926810","Name":"Debtor Agent Name","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"DebtorAccount":{"SchemeName":"UK.OBIE.IBAN","Identification":"GB29NWBK60161331926810","Name":"Debtor Account Name","SecondaryIdentification":"22-33-55"},"CardInstrument":{"CardSchemeName":"Debit Card","AuthorizationType":"OAuth","Name":"Card Name","Identification":"12-34-56"},"SupplementaryData":{}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/transactions/"},"Meta":{"TotalPages":1,"FirstAvailableDateTime":"2017-05-03T00:00:00+00:00","LastAvailableDateTime":"2017-12-03T00:00:00+00:00"}}
Request
GET
/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/transactions
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Can raise:
ResourceNotFound
fromBookingDateTime
(query)
datetime, optional
Specifies start date and time for filtering of the Transaction records on the Transaction/BookingDateTime field.
toBookingDateTime
(query)
datetime, optional
Specifies end date and time for filtering of the Transaction records on the Transaction/BookingDateTime field.
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
array, required
Provides further details on an entry in the report.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Can raise:
FieldInvalid
string, optional
Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
Can raise:
FieldInvalid
array, optional
Unique reference for the statement. This reference may be optionally populated if available.
string, required
Indicates whether the transaction is a credit or a debit entry.
Allowed values:
Credit, Debit
Can raise:
FieldInvalid
string, required
Status of a transaction entry on the books of the account servicer.
Allowed values:
Pending, Rejected, Booked
Can raise:
FieldInvalid
string, optional
Specifies the Mutability of the Transaction record.
Can raise:
FieldInvalid
datetime, required
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.
datetime, optional
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.
string, optional
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
Can raise:
FieldInvalid
string, optional
Further details of the transaction. This is the transaction narrative, which is unstructured text.
Can raise:
FieldInvalid
hash, required
Amount of money in the cash transaction entry.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
hash, optional
Transaction charges to be paid by the charge bearer.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
hash, optional
Set of elements used to provide details on the currency exchange.
string, required
Currency from which an amount is to be converted in a currency conversion.
Can raise:
FieldInvalid
string, optional
Currency into which an amount is to be converted in a currency conversion.
Can raise:
FieldInvalid
string, optional
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
string, required
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
Can raise:
FieldInvalid
string, optional
Unique identification to unambiguously identify the foreign exchange contract.
Can raise:
FieldInvalid
date, optional
Date and time at which an exchange rate is quoted.
hash, optional
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
hash, optional
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
string, required
Specifies the family within a domain.
Can raise:
FieldInvalid
string, required
Specifies the sub-product family within a specific family.
Can raise:
FieldInvalid
ProprietaryBankTransactionCode
hash, optional
Set of elements to fully identify a proprietary bank transaction code.
string, required
Proprietary bank transaction code to identify the underlying transaction.
Can raise:
FieldInvalid
string, required
Identification of the issuer of the proprietary bank transaction code.
Can raise:
FieldInvalid
hash, optional
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
hash, required
Amount of money of the cash balance after a transaction entry is applied to the account.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
string, required
Balance type, in a coded form.
Can raise:
FieldInvalid
string, required
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
Allowed values:
Credit, Debit
Can raise:
FieldInvalid
hash, optional
Details of the merchant involved in the transaction.
string, optional
Name by which the merchant is known.
Can raise:
FieldInvalid
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Can raise:
FieldInvalid
hash, optional
Financial institution servicing an account for the creditor.
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
string, optional
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Can raise:
FieldInvalid
string, optional
Name by which an agent is known and which is usually used to identify that agent.
Can raise:
FieldInvalid
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
string, optional
Identification of a division of a large organisation or building.
Can raise:
FieldInvalid
string, optional
Identification of a sub-division of a large organisation or building.
Can raise:
FieldInvalid
string, optional
Name of a street or thoroughfare.
Can raise:
FieldInvalid
string, optional
Number that identifies the position of a building on a street.
Can raise:
FieldInvalid
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Can raise:
FieldInvalid
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Can raise:
FieldInvalid
string, optional
Identifies a subdivision of a country such as state, region, county.
Can raise:
FieldInvalid
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
string, optional
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Can raise:
FieldInvalid
hash, optional
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Can raise:
FieldInvalid
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
Can raise:
FieldInvalid
string, optional
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Can raise:
FieldInvalid
hash, optional
Financial institution servicing an account for the debtor.
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Can raise:
FieldInvalid
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
Can raise:
FieldInvalid
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
string, optional
Identification of a division of a large organisation or building.
Can raise:
FieldInvalid
string, optional
Identification of a sub-division of a large organisation or building.
Can raise:
FieldInvalid
string, optional
Name of a street or thoroughfare.
Can raise:
FieldInvalid
string, optional
Number that identifies the position of a building on a street.
Can raise:
FieldInvalid
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Can raise:
FieldInvalid
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Can raise:
FieldInvalid
string, optional
Identifies a subdivision of a country such as state, region, county.
Can raise:
FieldInvalid
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
string, optional
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Can raise:
FieldInvalid
hash, optional
Unambiguous identification of the account of the debtor, in the case of a credit transaction.
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Can raise:
FieldInvalid
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
Can raise:
FieldInvalid
string, optional
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Can raise:
FieldInvalid
hash, optional
Set of elements to describe the card instrument used in the transaction.
string, required
Name of the card scheme.
Can raise:
FieldInvalid
string, optional
The card authorisation type.
Can raise:
FieldInvalid
string, optional
Name of the cardholder using the card instrument.
Can raise:
FieldInvalid
string, optional
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
Can raise:
FieldInvalid
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
ResourceInvalidConsentStatus
|
400 |
The action can't be performed with current status of consent. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Unauthorized
|
401 |
Unauthorized access. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
TooEarly
|
425 |
The service is not ready to process the request. |
Balances
A TPP may retrieve the account balance information resource for a specific AccountId (which is retrieved in the call to GET /accounts).
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.C7Az_N5X0BkYEIC7Z-CfslRc9NNL52T-ZOyiSRjkLpfdFOMCW8zL_O-dMzyZtQ3kV4pSQ-Sf3g_es96ppJJFOg-ZXOVwzVTg8LnuTBUITXqrOJ7ieBTyLQdWP1ZJKquQaGMG4iKO2-KH_iUaK3ZXnenrO7sSfd0Yws3-62wRNOAVGfe14VUl2_hlgCfOH4BIKqpaIm3uxGQtSTQPJuoghvtvyvJ-0KILyWR_0pGxEULHBXCptOMyRDPaVhukalIkVcA22z-sZj3QGMlhDPpoTylGjnyo8SwsFpH6uvAFQdbTyYaZ_PkZwpeWQrwmuw23ed-1V33bW4fkZ6RJA7mzMQ' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/balances"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.C7Az_N5X0BkYEIC7Z-CfslRc9NNL52T-ZOyiSRjkLpfdFOMCW8zL_O-dMzyZtQ3kV4pSQ-Sf3g_es96ppJJFOg-ZXOVwzVTg8LnuTBUITXqrOJ7ieBTyLQdWP1ZJKquQaGMG4iKO2-KH_iUaK3ZXnenrO7sSfd0Yws3-62wRNOAVGfe14VUl2_hlgCfOH4BIKqpaIm3uxGQtSTQPJuoghvtvyvJ-0KILyWR_0pGxEULHBXCptOMyRDPaVhukalIkVcA22z-sZj3QGMlhDPpoTylGjnyo8SwsFpH6uvAFQdbTyYaZ_PkZwpeWQrwmuw23ed-1V33bW4fkZ6RJA7mzMQ' \
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/balances"
Example of response
{"Data":{"Balance":[{"AccountId":"22289","Amount":{"Amount":"1230.00","Currency":"GBP"},"CreditDebitIndicator":"Credit","Type":"InterimAvailable","DateTime":"2017-04-05T10:43:07+00:00","CreditLine":[{"Included":true,"Amount":{"Amount":"1000.00","Currency":"GBP"},"Type":"Temporary"}]},{"AccountId":"31820","Amount":{"Amount":"57.36","Currency":"GBP"},"CreditDebitIndicator":"Debit","Type":"InterimBooked","DateTime":"2017-05-02T14:22:09+00:00"}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/balances/"},"Meta":{"TotalPages":1}}
{"Data":{"Balance":[{"AccountId":"22289","Amount":{"Amount":"1230.00","Currency":"GBP"},"CreditDebitIndicator":"Credit","Type":"InterimAvailable","DateTime":"2017-04-05T10:43:07+00:00","CreditLine":[{"Included":true,"Amount":{"Amount":"1000.00","Currency":"GBP"},"Type":"Temporary"}]},{"AccountId":"31820","Amount":{"Amount":"57.36","Currency":"GBP"},"CreditDebitIndicator":"Debit","Type":"InterimBooked","DateTime":"2017-05-02T14:22:09+00:00"}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/balances/"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/balances
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Can raise:
ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
hash, required
Wrapper for the data.
array, required
Set of elements used to define the balance details.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Can raise:
FieldInvalid
hash, required
Amount of money of the cash balance.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
string, required
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
Allowed values:
Credit, Debit
Can raise:
FieldInvalid
string, required
Balance type, in a coded form.
Allowed values:
ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked
Can raise:
FieldInvalid
datetime, required
Indicates the date (and time) of the balance.
array, optional
Set of elements used to provide details on the credit line.
boolean, required
Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.
hash, optional
Amount of money of the credit line.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
string, optional
Limit type, in a coded form.
Allowed values:
Available, Credit, Emergency, Pre-Agreed, Temporary
Can raise:
FieldInvalid
hash, required
A list of hyperlinks to be recognized by the TPP.
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
hash, optional
Wrapper for the meta.
datetime, optional
Date of the first available transaction All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
datetime, optional
Date of the last available transaction. All dates are represented in ISO 8601 date-time format (e.g. 2020-04-05T10:43:07+00:00).
integer, optional
The total number of pages.
Related Errors
Class |
Code |
Description |
FieldInvalid
|
400 |
An invalid value is supplied in the field. More details in error_message . |
ResourceNotFound
|
400 |
Specified resource doesn't exist. |
ResourceInvalidConsentStatus
|
400 |
The action can't be performed with current status of consent. |
HeaderMissing
|
400 |
A required HTTP header has not been provided. |
HeaderInvalid
|
400 |
An invalid value is supplied in the HTTP header. |
Unauthorized
|
401 |
Unauthorized access. |
Forbidden
|
403 |
Action is forbidden. More details in error_message . |
TooEarly
|
425 |
The service is not ready to process the request. |