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 "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IlBlcm1pc3Npb25zIjpbIlJlYWRBY2NvdW50c0Jhc2ljIiwiUmVhZEFjY291bnRzRGV0YWlsIiwiUmVhZEJhbGFuY2VzIiwiUmVhZEJlbmVmaWNpYXJpZXNEZXRhaWwiLCJSZWFkVHJhbnNhY3Rpb25zQmFzaWMiLCJSZWFkVHJhbnNhY3Rpb25zQ3JlZGl0cyIsIlJlYWRUcmFuc2FjdGlvbnNEZWJpdHMiLCJSZWFkVHJhbnNhY3Rpb25zRGV0YWlsIiwiUmVhZFBBTiIsIlJlYWRQYXJ0eSIsIlJlYWRTdGFuZGluZ09yZGVyc0RldGFpbCIsIlJlYWREaXJlY3REZWJpdHMiXSwiRXhwaXJhdGlvbkRhdGVUaW1lIjoiMjAxNy0wNS0wMlQwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uRnJvbURhdGVUaW1lIjoiMjAxNy0wNS0wM1QwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uVG9EYXRlVGltZSI6IjIwMTctMTItMDNUMDA6MDA6MDArMDA6MDAifSwiUmlzayI6e319.fDNXckOQe49tEmAhqvtoeS8Sa-pgjtUUDz5eIwt6y4wLSYB57sVk8I2Bkn8VB17my5WL1TQcy_ntOFnWGAXKi0fjEo08yF78BWSrBgMhvjzRVyipX1StM-byafnLjwveJVgLQqfot2Jf_ZFZg0dbCYOODvMh4_sTLzZbI_tvAKbsRJh981PZb1T3v0A8OGbEW8Ath_kyFUqjoOaX2My6AvpDgYGzSBZvrcYjlAzSP7eO8RhX6M3VzoSeU5IusfBdrnyzmqUjyeIPrKl-RTVK0ywIBPMhJU1WnoHzMFhai14_AOeckHbfZDLMalZksEPqYAHIOLEjHmI03ZCQH7895w' \
-X POST "/api/:provider_code/open-banking/v3.1.11/aisp/account-access-consents"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IlBlcm1pc3Npb25zIjpbIlJlYWRBY2NvdW50c0Jhc2ljIiwiUmVhZEFjY291bnRzRGV0YWlsIiwiUmVhZEJhbGFuY2VzIiwiUmVhZEJlbmVmaWNpYXJpZXNEZXRhaWwiLCJSZWFkVHJhbnNhY3Rpb25zQmFzaWMiLCJSZWFkVHJhbnNhY3Rpb25zQ3JlZGl0cyIsIlJlYWRUcmFuc2FjdGlvbnNEZWJpdHMiLCJSZWFkVHJhbnNhY3Rpb25zRGV0YWlsIiwiUmVhZFBBTiIsIlJlYWRQYXJ0eSIsIlJlYWRTdGFuZGluZ09yZGVyc0RldGFpbCIsIlJlYWREaXJlY3REZWJpdHMiXSwiRXhwaXJhdGlvbkRhdGVUaW1lIjoiMjAxNy0wNS0wMlQwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uRnJvbURhdGVUaW1lIjoiMjAxNy0wNS0wM1QwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uVG9EYXRlVGltZSI6IjIwMTctMTItMDNUMDA6MDA6MDArMDA6MDAifSwiUmlzayI6e319.fDNXckOQe49tEmAhqvtoeS8Sa-pgjtUUDz5eIwt6y4wLSYB57sVk8I2Bkn8VB17my5WL1TQcy_ntOFnWGAXKi0fjEo08yF78BWSrBgMhvjzRVyipX1StM-byafnLjwveJVgLQqfot2Jf_ZFZg0dbCYOODvMh4_sTLzZbI_tvAKbsRJh981PZb1T3v0A8OGbEW8Ath_kyFUqjoOaX2My6AvpDgYGzSBZvrcYjlAzSP7eO8RhX6M3VzoSeU5IusfBdrnyzmqUjyeIPrKl-RTVK0ywIBPMhJU1WnoHzMFhai14_AOeckHbfZDLMalZksEPqYAHIOLEjHmI03ZCQH7895w' \
-X POST "/api/:provider_code/open-banking/v3.1.11/aisp/account-access-consents"
Example of request
{"Data":{"Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadPAN","ReadParty","ReadStandingOrdersDetail","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","ReadPAN","ReadParty","ReadStandingOrdersDetail","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","ReadPAN","ReadParty","ReadStandingOrdersDetail","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","ReadPAN","ReadParty","ReadStandingOrdersDetail","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.11/aisp/account-access-consents
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
object, 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, ReadPAN, ReadBeneficiariesDetail, ReadBeneficiariesBasic, ReadDirectDebits, ReadStandingOrdersDetail, ReadStandingOrdersBasic, ReadParty, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail
Can raise:
FieldInvalid
datetime, optional
Specified date and time the permissions will expire.
Values in range between:
2026-03-04T23:06:28+00:00 and 2026-06-02T23:06:28Z
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.
Can raise:
ResourceInvalidFormat
object, 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.
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
object, 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, ReadPAN, ReadBeneficiariesDetail, ReadBeneficiariesBasic, ReadDirectDebits, ReadStandingOrdersDetail, ReadStandingOrdersBasic, ReadParty, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail
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.
Can raise:
ResourceInvalidFormat
object, 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.
object, optional
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
object, 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. |
|
ResourceInvalidFormat
|
400 |
Payload schema does not match to the endpoint. |
|
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 "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Yzv8ijw8tF11qFlKqzWdbclbVW-xNjBIfQ4dxBHPcCcVNkY4C21gFPXqQTc8YXyKBsAceDLyfCpmLVX615dTAX1GbEMb3_ylLn2o3q6JuHaREox3Ic8JspcJG7VSbfbHDlzNRCHBPp8c2QwQIsNZfaB5YNfHYsdpNQzeEIwkwQmWCz-SGvcEjFOaLFHe_OiDvDBmUiE89USFc4V4HhHRRzkgH6E_Hvv_xtUA0_cvnysJ9LBe7LYSb2fDrMpKNh1QXRXEnOE_5IUWLYLGDDHPpOlbjPMEwBI9IsWDI0e4oSJ4itxXwC7RyPgjNupOtD_klEJpE8_-mREiblAMEfXHdQ' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/account-access-consents/:consent_id"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Yzv8ijw8tF11qFlKqzWdbclbVW-xNjBIfQ4dxBHPcCcVNkY4C21gFPXqQTc8YXyKBsAceDLyfCpmLVX615dTAX1GbEMb3_ylLn2o3q6JuHaREox3Ic8JspcJG7VSbfbHDlzNRCHBPp8c2QwQIsNZfaB5YNfHYsdpNQzeEIwkwQmWCz-SGvcEjFOaLFHe_OiDvDBmUiE89USFc4V4HhHRRzkgH6E_Hvv_xtUA0_cvnysJ9LBe7LYSb2fDrMpKNh1QXRXEnOE_5IUWLYLGDDHPpOlbjPMEwBI9IsWDI0e4oSJ4itxXwC7RyPgjNupOtD_klEJpE8_-mREiblAMEfXHdQ' \
-X GET "/api/:provider_code/open-banking/v3.1.11/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","ReadPAN","ReadParty","ReadStandingOrdersDetail","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","ReadPAN","ReadParty","ReadStandingOrdersDetail","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.11/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.
object, 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, ReadPAN, ReadBeneficiariesDetail, ReadBeneficiariesBasic, ReadDirectDebits, ReadStandingOrdersDetail, ReadStandingOrdersBasic, ReadParty, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail
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.
Can raise:
ResourceInvalidFormat
object, 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.
object, optional
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
object, 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 "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.qcP39_Rc42A4AMA7_0A0ySVNwy5KrwA4KbwaOeGt1ZMLzYsi-TdIgvGBoktNcQD_vIfyDS0A842PzPKwBwdvosXLA7MLa-FD-g6zjf19CvIOobWOJB5EX80XSFkaan4aSJ1suUpOPkMQu1jrtbJrUQ84pbRbknr8ZIFP2gOhpwitFqKPPUbx8nLQ7O5cYC-zHzJwy42WDbfW-fwLVSxo_CWEMCZX-gXHYwypOoxkXom52o-K1l0Ko9QjHYO2uZhelK5qmHpamXODYhY6G5IEcWjASK93RZllumvm8MZT8J8wVFVuMr-jVMRZg1vlabY96RNb_QlrkqqirhCpXGpykQ' \
-X DELETE "/api/:provider_code/open-banking/v3.1.11/aisp/account-access-consents/:consent_id"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.qcP39_Rc42A4AMA7_0A0ySVNwy5KrwA4KbwaOeGt1ZMLzYsi-TdIgvGBoktNcQD_vIfyDS0A842PzPKwBwdvosXLA7MLa-FD-g6zjf19CvIOobWOJB5EX80XSFkaan4aSJ1suUpOPkMQu1jrtbJrUQ84pbRbknr8ZIFP2gOhpwitFqKPPUbx8nLQ7O5cYC-zHzJwy42WDbfW-fwLVSxo_CWEMCZX-gXHYwypOoxkXom52o-K1l0Ko9QjHYO2uZhelK5qmHpamXODYhY6G5IEcWjASK93RZllumvm8MZT8J8wVFVuMr-jVMRZg1vlabY96RNb_QlrkqqirhCpXGpykQ' \
-X DELETE "/api/:provider_code/open-banking/v3.1.11/aisp/account-access-consents/:consent_id"
Request
DELETE
/api/:provider_code/open-banking/v3.1.11/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. |
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 "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.cwWkvVKveM_kikYGZcxDXg1aH6XQPZfEQsqoCR4FcUSYyDQHMOYZAhG0crjCD933bcNMQHQYD0MtPc_zMHIyfuCZ37kjJfxM1iCA19bk31UI9wU0A2NT5-bpXxqTgi_17FJiGXWIDcXEDqM2ZUHZGu34XN7hZ6O432KEhPghw6yndV7SjtAPgT6HqCAVdWJYSY6-7EKsvAieuR-AAsafdXvd90841v-Y4k6LZxp9HK_ahxdDYuy53RujarUmco5pWHmRg3Gw-CqtfnZByoY5b_jBPGU-TQE43tYTxHwLhbvaLU_Nsl5JLXF_X09VsEGvwSiUmnfJxnW6gybV0ZeOiQ' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.cwWkvVKveM_kikYGZcxDXg1aH6XQPZfEQsqoCR4FcUSYyDQHMOYZAhG0crjCD933bcNMQHQYD0MtPc_zMHIyfuCZ37kjJfxM1iCA19bk31UI9wU0A2NT5-bpXxqTgi_17FJiGXWIDcXEDqM2ZUHZGu34XN7hZ6O432KEhPghw6yndV7SjtAPgT6HqCAVdWJYSY6-7EKsvAieuR-AAsafdXvd90841v-Y4k6LZxp9HK_ahxdDYuy53RujarUmco5pWHmRg3Gw-CqtfnZByoY5b_jBPGU-TQE43tYTxHwLhbvaLU_Nsl5JLXF_X09VsEGvwSiUmnfJxnW6gybV0ZeOiQ' \
-X GET "/api/:provider_code/open-banking/v3.1.11/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.11/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.
object, 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
object, 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
object, optional
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
object, 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 "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Jv9mNHPieLFBLejFJMLUyTWzQidFvq8ryFYfXhPllnHqL2Q0dqdETio5kc3d-CgM1EoaSOQwI-0bmEZNzyiecAJiMXoe2jJFOK6r0b9Od2Ysdi1k5RUl7gckjR7go3QfTjUlgs6mZXSs21Lv40GWcsS0OcMbd8Zn2lNP1x4Mt_sFqJWAnH65qWkVPtZbSm8jcQ4qg0HaBqhAnkCwOSlvzDXvsDKVcVCK1NYfBsDVxV520S-u1hgkRr7cO5zd3cvUDy5CBW-_NEHmsEY2JWav8akHn7HRAQwXG9S9Qq3_mHDK5YZnkrGDHh5hJm0j_XJXz-ph6jGgqGfnJ4TdTWb6uw' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Jv9mNHPieLFBLejFJMLUyTWzQidFvq8ryFYfXhPllnHqL2Q0dqdETio5kc3d-CgM1EoaSOQwI-0bmEZNzyiecAJiMXoe2jJFOK6r0b9Od2Ysdi1k5RUl7gckjR7go3QfTjUlgs6mZXSs21Lv40GWcsS0OcMbd8Zn2lNP1x4Mt_sFqJWAnH65qWkVPtZbSm8jcQ4qg0HaBqhAnkCwOSlvzDXvsDKVcVCK1NYfBsDVxV520S-u1hgkRr7cO5zd3cvUDy5CBW-_NEHmsEY2JWav8akHn7HRAQwXG9S9Qq3_mHDK5YZnkrGDHh5hJm0j_XJXz-ph6jGgqGfnJ4TdTWb6uw' \
-X GET "/api/:provider_code/open-banking/v3.1.11/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.11/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.
object, 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
object, 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
object, optional
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
object, 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 "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.aMSeOlJpyXJufqBy0nPZkZQLfXf6gsYKSWTtZpTB73QvoTxbns18Ip7t6egN_-N1kGbA6l8iVGcYIxzwnu4aN2dpbyg1dmY6z-vxb_tbCt7-7vIYzFBW_Fwoz3URIT09jOM51tpu9rGpQpL7GmnqsH0y0eLwIX7L9uKpcsGQlyx3p3OJ2LStORuNiFavV-cUzwbONEQXC31baISlnx6AuZ8w0EX1IZ_lTjE6x1pWnmSuvoCtD_2BwnR3LdSmV6b4oYosDRnITBUxWhYiAr5RC__CGWCn2bHYlwNluRgodIsGqyiKblP54oOWRzOxPigoO38_zYiO1a2hHGHmM82q8Q' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/transactions"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.aMSeOlJpyXJufqBy0nPZkZQLfXf6gsYKSWTtZpTB73QvoTxbns18Ip7t6egN_-N1kGbA6l8iVGcYIxzwnu4aN2dpbyg1dmY6z-vxb_tbCt7-7vIYzFBW_Fwoz3URIT09jOM51tpu9rGpQpL7GmnqsH0y0eLwIX7L9uKpcsGQlyx3p3OJ2LStORuNiFavV-cUzwbONEQXC31baISlnx6AuZ8w0EX1IZ_lTjE6x1pWnmSuvoCtD_2BwnR3LdSmV6b4oYosDRnITBUxWhYiAr5RC__CGWCn2bHYlwNluRgodIsGqyiKblP54oOWRzOxPigoO38_zYiO1a2hHGHmM82q8Q' \
-X GET "/api/:provider_code/open-banking/v3.1.11/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.11/aisp/accounts/:account_id/transactions
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
Account ID.
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.
integer, optional
The limit query parameter specifies the maximum number of items to be returned in a single response when pagination is enabled (i.e., when paginated=1). This allows clients to control the size of the response, making it easier to handle large datasets and improving the efficiency of data retrieval.
The maximum allowable value for the limit parameter is 100.
string, optional
The offset query parameter indicates the starting point or the number of items to skip in the result set when pagination is enabled. It allows clients to navigate through the paginated data by specifying how many records should be bypassed before retrieving the next set of items.
Can raise:
FieldInvalid
integer, optional
This query parameter determines whether pagination is applied to the response. When set to 1, the API will return paginated results, allowing for controlled retrieval of a subset of the collection based on the specified limit and offset. Conversely, when set to 0, the API will return the entire collection in a single response, without any pagination applied.
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
object, 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
object, 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, RequestFormatInvalid
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
object, 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, RequestFormatInvalid
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
object, 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.
object, 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, RequestFormatInvalid
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
object, 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
object, 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, optional
Identification of the issuer of the proprietary bank transaction code.
Can raise:
FieldInvalid
object, 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.
object, 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, RequestFormatInvalid
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
object, 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
object, 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
object, 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
object, 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.
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
object, 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
object, 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
object, 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.
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
object, 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
object, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
string, optional
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
object, optional
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
object, 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 "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.gp7Qk6Wn6EpGuCuuB4hA49yfNHFhi9MRcPhefSOxMUoRnWlKvqBJSWL4KafaANwkozrBS9LSbW3RLFlQwthVU3s2OGVY21zXWXMTwpaOcWt-lgHdBxq92FbahGpqyeLpIAi4ggN5zmJSPEKRZG9Jfa689gnOHTIT9dICu16woVDMDKcJIrqMI4UNlEsA_4eKM4M3CTwU_qx3ovKeBRLnZ73Za_8PgtgE7x2mHeyDsBUkJHig3kaWSpuC3WVkrKAnHHKm2hx5tUqa3ZB-ChMg7PRFyQAjNOLb0GgoOKm3wU-vahCJTb5md6e9bVbrmNm6xsd8m_Z-2yMn-VM8iaStwA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/balances"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.gp7Qk6Wn6EpGuCuuB4hA49yfNHFhi9MRcPhefSOxMUoRnWlKvqBJSWL4KafaANwkozrBS9LSbW3RLFlQwthVU3s2OGVY21zXWXMTwpaOcWt-lgHdBxq92FbahGpqyeLpIAi4ggN5zmJSPEKRZG9Jfa689gnOHTIT9dICu16woVDMDKcJIrqMI4UNlEsA_4eKM4M3CTwU_qx3ovKeBRLnZ73Za_8PgtgE7x2mHeyDsBUkJHig3kaWSpuC3WVkrKAnHHKm2hx5tUqa3ZB-ChMg7PRFyQAjNOLb0GgoOKm3wU-vahCJTb5md6e9bVbrmNm6xsd8m_Z-2yMn-VM8iaStwA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/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.11/aisp/accounts/:account_id/balances
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
Account ID.
Can raise:
ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
object, required
Wrapper for the data.
object, optional
Total value of all balances for the account.
string, required
Amount of money of the credit line.
Can raise:
FieldInvalid, RequestFormatInvalid
string, required
Currency code of the total value from ISO 4217.
Can raise:
FieldInvalid, UnsupportedCurrency
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
object, 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, RequestFormatInvalid
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
Subtype of the balance amount (e.g. interim, opening, closing).
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
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.
object, optional
Amount in local currency.
string, required
Amount of money of the credit line.
Can raise:
FieldInvalid, RequestFormatInvalid
string, required
Currency code of the local amount from ISO 4217.
Can raise:
FieldInvalid, UnsupportedCurrency
string, optional
Subtype of the local amount.
Can raise:
FieldInvalid
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.
object, 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, RequestFormatInvalid
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
object, optional
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
object, 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. |
Beneficiaries
An AISP may retrieve the account beneficiaries information resource for a specific AccountId
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Jsn1ZVOcmKSU3vRzcbSxJCYGGQmXsrS1fiYVuv8qhbCKP9znYPJRj_tc_Aphi34t1E-jJ44YOiwU2OyIFS5zNBdyto5HnljJwGPoPoPL4reHYkurM8nRic5uWtxh_oymkitbBGy1LcEIygYPdnoSvNrA8duSMjFc5gBpU2m-z1r-vRcFJPU_E_onbvAJ_kmV1P6WU-y76S_89fn0UlirDZHrs_hsPEyIdesD2luOFGi_dRa7T-9DvbGju5FZi9UfwTns5-2LANUkNtmIaE6lvo3wwM0ncTtl5dGiG2bvL7nVBX7iggu0ZtazgCkQ5k2N1IBGRCLKrlnoRIsRjJYgdQ' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/beneficiaries"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Jsn1ZVOcmKSU3vRzcbSxJCYGGQmXsrS1fiYVuv8qhbCKP9znYPJRj_tc_Aphi34t1E-jJ44YOiwU2OyIFS5zNBdyto5HnljJwGPoPoPL4reHYkurM8nRic5uWtxh_oymkitbBGy1LcEIygYPdnoSvNrA8duSMjFc5gBpU2m-z1r-vRcFJPU_E_onbvAJ_kmV1P6WU-y76S_89fn0UlirDZHrs_hsPEyIdesD2luOFGi_dRa7T-9DvbGju5FZi9UfwTns5-2LANUkNtmIaE6lvo3wwM0ncTtl5dGiG2bvL7nVBX7iggu0ZtazgCkQ5k2N1IBGRCLKrlnoRIsRjJYgdQ' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/beneficiaries"
Example of response
{"Data":{"Beneficiary":[{"AccountId":"22289","BeneficiaryId":"Ben1","Reference":"Towbar Club","CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200112345678","Name":"Mrs Juniper"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/beneficiaries"},"Meta":{"TotalPages":1}}
{"Data":{"Beneficiary":[{"AccountId":"22289","BeneficiaryId":"Ben1","Reference":"Towbar Club","CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200112345678","Name":"Mrs Juniper"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/beneficiaries"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/beneficiaries
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
Account ID.
Can raise:
ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
object, required
Wrapper for the data.
array, required
Beneficiaries wrapper.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
string, optional
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
string, optional
Specifies the Beneficiary Type.
string, optional
Additional information that cannot be captured in the structured fields and/or any other specific block.
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
object, optional
Provides the details to identify the beneficiary account.
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
object, optional
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
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
object, optional
Information that locates and identifies a specific address, as defined by postal services.
string, optional
dentifies 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
object, optional
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
object, 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. |
Direct Debits
An ASPSP must provide this endpoint for AISPs to retrieve the direct-debits for a specific account identified by AccountId.
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.sdF9eN5rk7vwP7ULUPdvgop17guIMai3ISWw6FUKbSdO0MS7BM03krt7yhpeWZ5WHVjkxVhPRNkADct52JCNIUo5Ti6zeN3M-4JFqi4cyv4efnvRf-KHo5G5VfXNY2yuH3m0CRiBLISxBtFV6c7o--VhzrFHZySJR9M4hVQGgU7Py8v1EUXs71OOgzR36IHs-G37xZ5ov_xu6QGfzt8IXNt7LC_ofuQd2Oti3tXcL_0k_c-XhCk_gIz-0g5YGVm49Mw4a5q-17pZxSnjCX-MtX2HjH_DrCnzfOS8xOFip81-OuIt9rcHCkvSI8R8TLzsF40aBI2DKSMx8HNyyJtSmA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/direct-debits"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.sdF9eN5rk7vwP7ULUPdvgop17guIMai3ISWw6FUKbSdO0MS7BM03krt7yhpeWZ5WHVjkxVhPRNkADct52JCNIUo5Ti6zeN3M-4JFqi4cyv4efnvRf-KHo5G5VfXNY2yuH3m0CRiBLISxBtFV6c7o--VhzrFHZySJR9M4hVQGgU7Py8v1EUXs71OOgzR36IHs-G37xZ5ov_xu6QGfzt8IXNt7LC_ofuQd2Oti3tXcL_0k_c-XhCk_gIz-0g5YGVm49Mw4a5q-17pZxSnjCX-MtX2HjH_DrCnzfOS8xOFip81-OuIt9rcHCkvSI8R8TLzsF40aBI2DKSMx8HNyyJtSmA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/direct-debits"
Example of response
{"Data":{"DirectDebit":[{"AccountId":"22289","DirectDebitId":"DD03","MandateIdentification":"Caravanners","DirectDebitStatusCode":"Active","Name":"Towbar Club 3 - We Love Towbars","PreviousPaymentDateTime":"2017-04-05T10:43:07+00:00","PreviousPaymentAmount":{"Amount":"0.57","Currency":"GBP"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/direct-debits"},"Meta":{"TotalPages":1}}
{"Data":{"DirectDebit":[{"AccountId":"22289","DirectDebitId":"DD03","MandateIdentification":"Caravanners","DirectDebitStatusCode":"Active","Name":"Towbar Club 3 - We Love Towbars","PreviousPaymentDateTime":"2017-04-05T10:43:07+00:00","PreviousPaymentAmount":{"Amount":"0.57","Currency":"GBP"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/direct-debits"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/direct-debits
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
Account ID.
Can raise:
ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
object, required
Wrapper for the data.
array, required
DirectDebits wrapper.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
string, optional
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
string, required
Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
string, optional
Specifies the status of the direct debit in code form.
string, required
Name of Service User.
string, optional
Regularity with which direct debit instructions are to be created and processed
datetime, optional
Date of most recent direct debit collection.
object, optional
The amount of the most recent direct debit collection.
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.
Can raise:
FieldInvalid, UnsupportedCurrency
object, optional
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
object, 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. |
Standing Orders
An AISP may retrieve the standing-order resource for a specific AccountId
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.MoN0fsQzkLnF_DWDn0VIkjHbNU0e8ioQUC8ak6FsvgGvcHjCQmvYc89F868PpL61n6-9wIO4VqMuxp5nfxeF_FO1kjorhLkIu7cG_uoeBHwLts-5LgfCq91IaEsyQiy9mUN7qxeBYc5NheUqSQsErUAjzhCMrLHKowvsmwnUxS58feqF2inkjHuIZyze9e1UMkpSydRRDI7VnUYUrCfzm-CmdltW-KZvJGH_54NQr1TW7XSkJyD80_pZQ8Z7Hwwj51GM6Umykbigbsw4Q_AKO5GReC5JIZ74o4BxmE2ut1qosOeRTByd7IO-XaPtU8GLhAxvCPhveVdkk6mUvQJRtg' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/standing-orders"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.MoN0fsQzkLnF_DWDn0VIkjHbNU0e8ioQUC8ak6FsvgGvcHjCQmvYc89F868PpL61n6-9wIO4VqMuxp5nfxeF_FO1kjorhLkIu7cG_uoeBHwLts-5LgfCq91IaEsyQiy9mUN7qxeBYc5NheUqSQsErUAjzhCMrLHKowvsmwnUxS58feqF2inkjHuIZyze9e1UMkpSydRRDI7VnUYUrCfzm-CmdltW-KZvJGH_54NQr1TW7XSkJyD80_pZQ8Z7Hwwj51GM6Umykbigbsw4Q_AKO5GReC5JIZ74o4BxmE2ut1qosOeRTByd7IO-XaPtU8GLhAxvCPhveVdkk6mUvQJRtg' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/standing-orders"
Example of response
{"Data":{"StandingOrder":[{"AccountId":"22289","StandingOrderId":"Ben3","Frequency":"EvryWorkgDay","Reference":"Towbar Club 2 - We Love Towbars","FirstPaymentDateTime":"2017-08-12T00:00:00+00:00","FirstPaymentAmount":{"Amount":"0.57","Currency":"GBP"},"NextPaymentDateTime":"2017-08-13T00:00:00+00:00","NextPaymentAmount":{"Amount":"0.56","Currency":"GBP"},"FinalPaymentDateTime":"2027-08-12T00:00:00+00:00","FinalPaymentAmount":{"Amount":"0.56","Currency":"GBP"},"StandingOrderStatusCode":"Active","CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200112345678","Name":"Mrs Juniper"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/standing_orders"},"Meta":{"TotalPages":1}}
{"Data":{"StandingOrder":[{"AccountId":"22289","StandingOrderId":"Ben3","Frequency":"EvryWorkgDay","Reference":"Towbar Club 2 - We Love Towbars","FirstPaymentDateTime":"2017-08-12T00:00:00+00:00","FirstPaymentAmount":{"Amount":"0.57","Currency":"GBP"},"NextPaymentDateTime":"2017-08-13T00:00:00+00:00","NextPaymentAmount":{"Amount":"0.56","Currency":"GBP"},"FinalPaymentDateTime":"2027-08-12T00:00:00+00:00","FinalPaymentAmount":{"Amount":"0.56","Currency":"GBP"},"StandingOrderStatusCode":"Active","CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200112345678","Name":"Mrs Juniper"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/standing_orders"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/standing-orders
Headers
| Header |
Type |
Description |
Accept
|
string, optional
|
Media type that is acceptable for the response.
Default value:
application/json
|
x-fapi-interaction-id
|
string, optional
|
An RFC4122 UID used as a correlation Id.
|
Authorization
|
string, required
|
Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes.
Can raise:
HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden
|
x-fapi-auth-date
|
string, optional
|
The time when the PSU last logged in with the TPP. Supplied as HTTP-date (RFC7231), e.g. Sun, 10 Sep 2017 19:43:31 GMT.
|
x-fapi-customer-ip-address
|
string, optional
|
The PSU's IP address if the PSU is currently logged in with the TPP. Identifies user presence for the data fetch.
|
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
Account ID.
Can raise:
ResourceNotFound
Response headers
| Header |
Type |
Description |
Content-Type
|
string, required
|
The media type of the body of the request.
|
x-fapi-interaction-id
|
string, required
|
An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header.
|
Retry-After
|
integer, optional
|
Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request.
|
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
object, required
Wrapper for the data.
array, required
Standing Orders wrapper.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
string, optional
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
string, required
This is a specific format of describing the rule for creating the payments of a standing order.
It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Can raise:
UnsupportedFrequency
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
datetime, optional
The date on which the first payment for a Standing Order schedule will be made.
object, optional
The amount of the first Standing Order.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
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.
datetime, optional
The date on which the next payment for a Standing Order schedule will be made.
object, optional
The amount of the next Standing Order.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
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.
datetime, optional
The date on which the final payment for a Standing Order schedule will be made.
object, optional
The amount of the final Standing Order.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
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.
string, optional
Specifies the status of the standing order in code form.
string, optional
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
object, optional
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary 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.
Can raise:
FieldInvalid
object, optional
Provides the details to identify the beneficiary account.
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
Beneficiary account identification.
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
string, optional
Additional information that cannot be captured in the structured fields and/or any other specific block.
object, optional
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
object, 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. |
Party
The ASPSP must return details on the account owner:
In the case of a business - this will be the details of the business.
In the case of a joint account - this will be the party that has given authorisation to the AISP to view the account. If the AISP wishes to access details of other parties linked to the AccountId, the AISP must go through an authorisation flow with the other parties.
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Awzz_j0IdExPbsDqnP8i-dB4i51oVybwCnp5n6ye7e2HcM1pR9d9U2INSClZzbBIef53-OXRfgvtTvXu_Mxr8XsatVpEj7z0ENhu68wraVqEXlicrWS6-TUJjQ21E807CeG8txjHBRLyEPcE6xAWYmRVkfsvBnlAMlc6vplmO9tUMgigTJnxVRXBafo5plNMybx_nr2b9kBPhlOD2YCUQtYbBhvq1DUDxcApzudROBgKBygvK6VgRM-BoB2p3DsSbW-wCtRkWLPW0E9RFwCBeuocMjyOqkD6RD4kI52RMOEU7SQ1EDOYVww7wlAKw0BKnOznVD5qFBTnHAZ_sHh8fA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/party"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Awzz_j0IdExPbsDqnP8i-dB4i51oVybwCnp5n6ye7e2HcM1pR9d9U2INSClZzbBIef53-OXRfgvtTvXu_Mxr8XsatVpEj7z0ENhu68wraVqEXlicrWS6-TUJjQ21E807CeG8txjHBRLyEPcE6xAWYmRVkfsvBnlAMlc6vplmO9tUMgigTJnxVRXBafo5plNMybx_nr2b9kBPhlOD2YCUQtYbBhvq1DUDxcApzudROBgKBygvK6VgRM-BoB2p3DsSbW-wCtRkWLPW0E9RFwCBeuocMjyOqkD6RD4kI52RMOEU7SQ1EDOYVww7wlAKw0BKnOznVD5qFBTnHAZ_sHh8fA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/party"
Example of response
{"Data":{"Party":[{"PartyId":"PABC123","PartyType":"Sole","Name":"Semiotec","FullLegalName":"Semiotec Limited","LegalStructure":"UK.OBIE.PrivateLimitedCompany","BeneficialOwnership":true,"AccountRole":"UK.OBIE.Principal","EmailAddress":"contact@semiotec.co.jp","Phone":"+44-00000000","Mobile":"+44-00000001","Relationships":{"Account":{"Related":"https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289","Id":"22289"}},"Address":{"AddressType":"Business","StreetName":"Street","BuildingNumber":"15","PostCode":"NW1 1AB","TownName":"London","Country":"GB"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/party"},"Meta":{"TotalPages":1}}
{"Data":{"Party":[{"PartyId":"PABC123","PartyType":"Sole","Name":"Semiotec","FullLegalName":"Semiotec Limited","LegalStructure":"UK.OBIE.PrivateLimitedCompany","BeneficialOwnership":true,"AccountRole":"UK.OBIE.Principal","EmailAddress":"contact@semiotec.co.jp","Phone":"+44-00000000","Mobile":"+44-00000001","Relationships":{"Account":{"Related":"https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289","Id":"22289"}},"Address":{"AddressType":"Business","StreetName":"Street","BuildingNumber":"15","PostCode":"NW1 1AB","TownName":"London","Country":"GB"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/party"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/party
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
Account ID.
Can raise:
ResourceNotFound
Response headers
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
object, required
Wrapper for the data.
object, required
Party wrapper.
string, optional
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
string, optional
Number assigned by an agent to identify its customer.
string, optional
Party type.
string, optional
Name by which a party is known and which is usually used to identify that party.
string, optional
The full legal name of the party.
string, optional
Legal standing of the party.
boolean, optional
A flag to indicate a party's beneficial ownership of the related account.
string, optional
A party's role with respect to the related account.
string, optional
Address for electronic mail (e-mail).
string, optional
Collection of information that identifies a phone number as defined by telecom services.
string, optional
Collection of information that identifies a mobile phone number as defined by telecom services.
object, optional
The Party's relationships with other resources.
object, optional
Relationship to the Account resource.
string, required
Absolute URI to the related resource.
string, required
Unique identification as assigned by the ASPSP to uniquely identify the related resource.
object, optional
Postal address of a party.
string, optional
Identifies the nature of the postal address.
array, optional
Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.
string, optional
Name of a street or thoroughfare.
string, optional
Number that identifies the position of a building on a street.
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.
string, optional
Name of a built-up area, with defined boundaries, and a local government.
string, optional
Identifies a subdivision of a country eg, state, region, county.
string, required
Nation with its own government, occupying a particular territory. (ISO 3166-1 alpha-2 code)
Can raise:
FieldInvalid, CountryNameInvalid
object, optional
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
object, 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. |
Scheduled Payments
An AISP may retrieve the account scheduled payments information for a specific AccountId
CURL
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.fg0PfHEED7TnTm3V8lcbmYOmRzA0NyqXbhtoSK91-qsuJrNSLicPwjtWgoBAZ2ZyylBqfmilocgD3fIuBqcINeVoUv6kw0IGW-mvQFHXfunP2Tb73TWAdFsQeg17zEd7VT6ekQkJqEXWKzUGFXJImfjyy6Uul3bE6loWHo2JV5QgAKe1KlubrWct1GfTymHYMnzkomDi1S_8GLXEuyPbO91jajT1ZcQtMlqfTpngDIwoMUTl-1-Xpp0bTEyPAGA_3x8dKLelG81XdFPJA_F9O4w-NFSPOg1dM5jj-el8yq9Bs2N3Kz-EC1grIjCp8n08fZSzMjMEUzW3Xeo6yWZkLA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/scheduled-payments"
curl -i \
-H "Authorization: Bearer Az90SAOJklae" \
-H "x-fapi-interaction-id: some-uuid" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-H "Content-Type: application/json" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.fg0PfHEED7TnTm3V8lcbmYOmRzA0NyqXbhtoSK91-qsuJrNSLicPwjtWgoBAZ2ZyylBqfmilocgD3fIuBqcINeVoUv6kw0IGW-mvQFHXfunP2Tb73TWAdFsQeg17zEd7VT6ekQkJqEXWKzUGFXJImfjyy6Uul3bE6loWHo2JV5QgAKe1KlubrWct1GfTymHYMnzkomDi1S_8GLXEuyPbO91jajT1ZcQtMlqfTpngDIwoMUTl-1-Xpp0bTEyPAGA_3x8dKLelG81XdFPJA_F9O4w-NFSPOg1dM5jj-el8yq9Bs2N3Kz-EC1grIjCp8n08fZSzMjMEUzW3Xeo6yWZkLA' \
-X GET "/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/scheduled-payments"
Example of response
{"Data":{"ScheduledPayment":[{"AccountId":"22289","ScheduledPaymentId":"SP03","ScheduledPaymentDateTime":"2017-05-05T00:00:00+00:00","ScheduledType":"Execution","InstructedAmount":{"Amount":"10.00","Currency":"GBP"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"23605490179017","Name":"Mr Tee"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/scheduled-payments"},"Meta":{"TotalPages":1}}
{"Data":{"ScheduledPayment":[{"AccountId":"22289","ScheduledPaymentId":"SP03","ScheduledPaymentDateTime":"2017-05-05T00:00:00+00:00","ScheduledType":"Execution","InstructedAmount":{"Amount":"10.00","Currency":"GBP"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"23605490179017","Name":"Mr Tee"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/scheduled-payments"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1.11/aisp/accounts/:account_id/scheduled-payments
Headers
Request parameters
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
string, required
Account ID.
Can raise:
ResourceNotFound
Response headers
Response
An AISP may retrieve the account scheduled payments information for a specific AccountId
object, required
Wrapper for the data.
array, required
Scheduled Payments wrapper.
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
string, optional
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
datetime, required
The date on which the scheduled payment will be made.
string, required
Specifies the scheduled payment date type requested
Allowed values:
Arrival, Execution
string, optional
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
object, optional
Provides the details to identify the beneficiary account.
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
Beneficiary account identification.
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
object, optional
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary 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.
Can raise:
FieldInvalid
object, required
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. Usage: This amount has to be transported unchanged through the transaction chain.
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
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".
object, optional
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
object, 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. |
