Consents

Create

The API allows the TPP to ask an PASP to create a new account-access-consent resource.

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IlBlcm1pc3Npb25zIjpbIlJlYWRBY2NvdW50c0Jhc2ljIiwiUmVhZEFjY291bnRzRGV0YWlsIiwiUmVhZEJhbGFuY2VzIiwiUmVhZEJlbmVmaWNpYXJpZXNEZXRhaWwiLCJSZWFkVHJhbnNhY3Rpb25zQmFzaWMiLCJSZWFkVHJhbnNhY3Rpb25zQ3JlZGl0cyIsIlJlYWRUcmFuc2FjdGlvbnNEZWJpdHMiLCJSZWFkVHJhbnNhY3Rpb25zRGV0YWlsIiwiUmVhZE9mZmVycyIsIlJlYWRQQU4iLCJSZWFkUGFydHkiLCJSZWFkUGFydHlQU1UiLCJSZWFkUHJvZHVjdHMiLCJSZWFkU3RhbmRpbmdPcmRlcnNEZXRhaWwiLCJSZWFkU2NoZWR1bGVkUGF5bWVudHNEZXRhaWwiLCJSZWFkU3RhdGVtZW50c0RldGFpbCIsIlJlYWREaXJlY3REZWJpdHMiXSwiRXhwaXJhdGlvbkRhdGVUaW1lIjoiMjAxNy0wNS0wMlQwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uRnJvbURhdGVUaW1lIjoiMjAxNy0wNS0wM1QwMDowMDowMCswMDowMCIsIlRyYW5zYWN0aW9uVG9EYXRlVGltZSI6IjIwMTctMTItMDNUMDA6MDA6MDArMDA6MDAifSwiUmlzayI6e319.qwzlI_bp6dyCqysIOi81njOH4h8rYJc6r2S46r4v52Yrsm18I_9J1fwpmn4lVvcFsIrxvDLOC3f5bY7dab1EuRQK9dmfAxfNJTmK3CSIDDhXushsnYKg--iikNAhHLWaA7GRhyZHPqxq__r4rHGj0KSB8bTMdZKGeaQtxsqS1yKkxyZDvPnHkNthPzq2xI2weDpXa5orvETgR01OjlF9ZnoPS0ss1atrMi0psrMKTotSOiTpbBJ_-a7HYi-FEhTy9AO0l77HqB9ZV8P0upsrstu-6Iu1rXsWOS_YgIgPThn3eBcfYb8IjBpuYbOKfuHkqdaNu5j_9tTGxZRLO6n40Q' \ 
-X POST "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents"

Example of request

{"Data":{"Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-05-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{}}

Example of response

{"Data":{"ConsentId":"urn-alphabank-intent-88379","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-05-02T00:00:00+00:00","CreationDateTime":"2017-05-02T00:00:00+00:00","Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-08-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/account-access-consents/urn-alphabank-intent-88379"},"Meta":{"TotalPages":1}}
Request

POST /api/:provider_code/open-banking/v3.1/aisp/account-access-consents

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Idempotency-Key string, optional Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound
Risk
hash, optional
The Risk section is sent by the initiating party to the PASP. It is used to specify additional details for risk scoring for Account Info.
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.


Risk
hash, required
The Risk section is sent by the initiating party to the PASP. It is used to specify additional details for risk scoring for Account Info.
Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.
ResourceNotFound 400 Specified resource doesn't exist.
FieldInvalidDate 400 An invalid date is supplied.
HeaderMissing 400 A required HTTP header has not been provided.
HeaderInvalid 400 An invalid value is supplied in the HTTP header.
Forbidden 403 Action is forbidden. More details in error_message.

Show

A TPP may optionally retrieve an account-access-consent resource that they have created to check its status. Prior to calling the API, the TPP must have an access token issued by the PASP using a client credentials grant.

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.kQaDMoqIMrVDNjqbiLTa4ixrNcEbupaQz4XKZROXhKLBdf-1hcb6WgEa7o2QisyqhMTMQVDVyvPcODnCiuaEvaxiQ3WsHBsVpWaO48gD1QFS_cyEVxJE2dsBvcn-9Bcva9a8KbphnhXsDvGz5vZpVfJwks_e6SvciIasE_e-kekstPh9jCWm53yG__KQP4_9iuHEBuO_u0V1lFYvNqs-epW9twhnYiKNQ1MRJ4izruQNV3bFa2cbLn8oN7TDJEWlf6VsZR-31hQP_l_BCQkwm5-FQTbx6hoekSSbc__H47aWjJpc3HT6yBfBW0TSCQgzeZLZedXoLDDxzOl88qaQ-A' \ 
-X GET "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id"

Example of response

{"Data":{"ConsentId":"urn-alphabank-intent-88379","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-05-02T00:00:00+00:00","CreationDateTime":"2017-05-02T00:00:00+00:00","Permissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadProducts","ReadStandingOrdersDetail","ReadScheduledPaymentsDetail","ReadStatementsDetail","ReadDirectDebits"],"ExpirationDateTime":"2017-08-02T00:00:00+00:00","TransactionFromDateTime":"2017-05-03T00:00:00+00:00","TransactionToDateTime":"2017-12-03T00:00:00+00:00"},"Risk":{},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/account-access-consents/urn-alphabank-intent-88379"},"Meta":{"TotalPages":1}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound
consent_id (path)
string, required
Unique identification as assigned to identify the account access consent resource. Can raise: FieldInvalid, 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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.


Risk
hash, required
The Risk section is sent by the initiating party to the PASP. It is used to specify additional details for risk scoring for Account Info.
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 PASP as soon as is practically possible.

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Tcnp6wZpot5iyM46qhcW1LkhqaxVZ320ga6Htcu0JrLsjjLq7eQEqNU69QpXDFwfqLHLXAU5Y4ix2Mr0EMVFBOmHjz95nea22kgkb2y4Ap1jpvuajaK-b7HrizHawh-MMTQEiGBRBYrQL3SBScfHZPYeHRW1T80t2nHgHdwLw7-lPl9ccaTonSvv2SArR_5SnUSJCF0j4PARP4g5Ebxjxi0LdElGcuObxMWZbY9TQHM18RIMDRLNlYG1gIW-4v-5kyXT9TUbxu_oJTkBXJGwUwDBv--zom7DIs__MSzcmnEcb-O59imFi6JWPE3Xo4OiLuSzQhnGhLQte4fxDxGhoQ' \ 
-X DELETE "/api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id"
Request

DELETE /api/:provider_code/open-banking/v3.1/aisp/account-access-consents/:consent_id

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound
consent_id (path)
string, required
Unique identification as assigned to identify the account access consent resource. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.

Accounts

Refresh

A lot of PASP's can not return imediately all AIS information. Call the POST /refresh endpoint before GET /accounts .
TPP should await success or fail final status. TPP may retrieve status by calling GET /refresh_status.

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkluaXRpYXRlZEJ5Q3VzdG9tZXIiOnRydWV9fQ.UE4Ec7x5frF52IrW2d3Y_PyAWciHvgxZORVlbcp5RydRZCw5Gud65QMIvEmT9FYUdG8W6ydPqLFuklDl3r78fJNF5kiWOmB4f_524zVHeWhVgZjC3s30ePtrCy7nDBCJgcrxTeMQwPs2URrYtv4D-DopSBYM61JAEENz_PpyUSN2yEkqfWhv44JI2DE7_QQNOgtEsStFoZUKDK8gsCpd5w-rKKwhqsxdJ6PgnirD9jTDXUPevmVbIh29nDLc9Kh3iNa3jfwql3s9FFz6Dqm8xSz-3FumYSgj3fCtwmzzNQMfARhBFOBrZfnVyMrwIFSE0vXKsqQWproBEweN79ugIQ' \ 
-X POST "/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh"

Example of request

{"Data":{"InitiatedByCustomer":true}}

Example of response

{"Data":{"Status":"Processing"},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/refresh/status"},"Meta":{"TotalPages":1}}
Request

POST /api/:provider_code/open-banking/v3.1/aisp/accounts/refresh

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
InitiatedByCustomer
boolean, optional
Defines whether request was initiated by customer or automatically. Automatic requests can be performed no more than 4 times per 24 hours. Default value: false Can raise: ActionNotAllowed, AccessExceeded, AccessExceeded
Response headers
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
ActionNotAllowed 406 You're not allowed to perform this action. This might be a configuration problem or parameters incompatibility.
TooEarly 425 The service is not ready to process the request.
AccessExceeded 429 Exceeded the number of automatic requests for this action.
AccessExceeded 429 Exceeded the number of automatic requests for this action.

Status of Refresh

TPP can retrieve REFRESH process status by calling the GET /refresh_status endpoint.
TPP should await success final status before request AIS info (e.g. accounts, transactions, balances).

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.jdww2m3ekLqQ9b0LynSwm1iupLGiJWNOglOqEW3JS_loDw2sGBGjAfwgIEanfSTNnj7Ho1LOTLw7aaE9XsF2LMyS_nge0NUpyj0oJTrThV4UFmRF6V46z1CHZVnMbTXup9wNo51vnDtc_11E0LteD7mJk6fELk_BZG-eevd4ms4_O-CgbgC5Oa80HwEhPuI_o96Se5C197nIj0cFyH-L0YA4gx1_vNz5rO2qyvRFRnU_3PIDQul5MhC3vAHyF1HBKQinYfKhmPRjFwGk6atwfqq07qSUVQpAn7Cl2DExp0rtKjdKVvqdGyIapkZgBR0ZUfLlEk7M3ahOKSnCinteBg' \ 
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/refresh/status"

Example of response

{"Data":{"Status":"FetchingFinished"},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/refresh/status"},"Meta":{"TotalPages":1}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/refresh/status

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. 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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.


Related Errors
Class Code Description
ResourceNotFound 400 Specified resource doesn't exist.
HeaderMissing 400 A required HTTP header has not been provided.
HeaderInvalid 400 An invalid value is supplied in the HTTP header.
Forbidden 403 Action is forbidden. More details in error_message.

Index

The first step for a TPP after an account request is authorised - is to call the GET /accounts endpoint.
A TPP will be given the full list of accounts (the AccountId(s)) that the PSU has authorised the TPP to access. The AccountId(s) returned may then be used to retrieve other resources for a specific AccountId. The selection of authorised accounts happens only at the PASP's interface.

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.V4UMAmzfc6HXWM0Mcl9bitcW_Ck10CYe_y5PEsJaLLzIXTPa-7fZ3A8swY1rk1xty1NrqxDN4YMSI7Znp7bFmzLiqUz9WyRUqYk5A_z9Xu_HpiUf1EtvUUWXCTur6Rjjj2MweP4-F2V4NVQkH7kr173xRmq6UiY-3Xr31tRJHNS1baChlm9EGrE1Cgb5X7JjwyJZVYMbCqUMgaCX-WGeKhsM8ZFjbWPkpuyGZ-Kkvi9F3p3pK0BjM0veENa0wv9vhk4li-9erqJlaREBThxUytGuYCPVLPzwl57R6GVNaJ601puQmLuF6GY7Y8M3qTkofEpTqxVdoLfxkBXLfvwEhg' \ 
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts"

Example of response

{"Data":{"Account":[{"AccountId":"22289","Status":"Enabled","StatusUpdateDateTime":"2019-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Description":"Description of account","Nickname":"Bills","OpeningDate":"2019-01-01","MaturityDate":"2019-01-01","SwitchStatus":"processing","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203345","Name":"Mr Kevin","SecondaryIdentification":"00021"}],"Servicer":{"SchemeName":"UK.OBIE.BICFI","Identification":"80200110203345"}},{"AccountId":"31820","Status":"Enabled","StatusUpdateDateTime":"2018-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Nickname":"Household","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203348","Name":"Mr Kevin"}]}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/"},"Meta":{"TotalPages":1}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
TooEarly 425 The service is not ready to process the request.

Show

A TPP may retrieve the account information resources for the AccountId (which is retrieved in the call to GET /accounts).

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.E96wgh0Vh4YSB9OtZfgWsukqgJte9b-T0rTZYJcux6mncBa0GGH-FUvqEmqTULmD0Z2cNClvQiE0Jti7-pqfDopF8HtsjZLc6O1JHBe3j8fNc9F1E0np9CBzHN9kQa5zGlwek_8fjNXnjd06OlQk42ICz5DMCNIGv9jPDjVZgk1If9is36u2pQcqy7mV9EqVnUxN8XnSfloc1WKWp5-uSyEyB36nPwOhRM1E0ojG9QqAbQ3hjqSC9Q5awK3Ls5obb6-SVoWAAWcZrP3szIxOFO8Hox7JPw1E6WBHt-YZafQwnLR8E1jugiBSRn1lqpsvRJBDmy3thBi4SdVlYY0OZQ' \ 
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id"

Example of response

{"Data":{"Account":[{"AccountId":"22289","Status":"Enabled","StatusUpdateDateTime":"2019-01-01T06:06:06+00:00","Currency":"GBP","AccountType":"Personal","AccountSubType":"CurrentAccount","Description":"Description of account","Nickname":"Bills","OpeningDate":"2019-01-01","MaturityDate":"2019-01-01","SwitchStatus":"processing","Account":[{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"80200110203345","Name":"Mr Kevin","SecondaryIdentification":"00021"}],"Servicer":{"SchemeName":"UK.OBIE.BICFI","Identification":"80200110203345"}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289"},"Meta":{"TotalPages":1}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
account_id (path)
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
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
TooEarly 425 The service is not ready to process the request.

Transactions

An TPP may retrieve the transaction resource for a specific AccountId (which is retrieved in the call to GET /accounts).

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.HbBBrkLvj-N5aE-UQnridnvGe9OpOcz2TL--IuUAT29a7sguxNpZMChwXzCo5M7KiqC2JlOd_w7oVjjbXTrSb66PJiekyh3SLzxzuWLP_lbew9qH4UGaIDoVi1w1aOX51eDuwguIRNNYK0U5oc4FJd6YxwFr87M-c7rZrDjFYbsf2Xtr_OsVUu37bTwo5ekvnuE7e0I3q13vUOnoTqBVEkHCgPNa5bAgRq97AeYe40tqhfKHcEM8H_5EE5EYMER8UACMqtdcQrv6hM7irzsXnSjmH0r-lGY6j3xc-RFAocsjhZkkrSnMYzBVXA-Kvq9YIYX4yscFwVr00uZDsoMJ2A' \ 
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/transactions"

Example of response

{"Data":{"Transaction":[{"AccountId":"22289","TransactionId":"123","TransactionReference":"Ref 1","StatementReference":["some-ref"],"CreditDebitIndicator":"Credit","Status":"Booked","TransactionMutability":"Immutable","BookingDateTime":"2017-04-05T10:43:07+00:00","ValueDateTime":"2017-04-05T10:45:22+00:00","TransactionInformation":"Cash from Aubrey","Amount":{"Amount":"10.00","Currency":"GBP"},"ChargeAmount":{"Amount":"10.00","Currency":"GBP"},"CurrencyExchange":{"SourceCurrency":"EUR","TargetCurrency":"GBP","UnitCurrency":"GBP","ExchangeRate":"0.92","ContractIdentification":"some-identification","QuotationDate":"2017-04-05","InstructedAmount":{"Amount":"10.00","Currency":"GBP"}},"BankTransactionCode":{"Code":"ReceivedCreditTransfer","SubCode":"DomesticCreditTransfer"},"ProprietaryBankTransactionCode":{"Code":"Transfer","Issuer":"AlphaBank"},"Balance":{"Amount":{"Amount":"230.00","Currency":"GBP"},"Type":"InterimBooked","CreditDebitIndicator":"Credit"},"MerchantDetails":{"MerchantName":"Merchant name","MerchantCategoryCode":"some-code"},"CreditorAgent":{"SchemeName":"UK.OBIE.BICFI","Identification":"GB29NWBK60161331926819","Name":"Creditor Agent Name","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"CreditorAccount":{"SchemeName":"UK.OBIE.IBAN","Identification":"GB29NWBK60161331926819","Name":"Creditor Account Name","SecondaryIdentification":"12-34-56"},"DebtorAgent":{"SchemeName":"UK.OBIE.BICFI","Identification":"GB29NWBK60161331926810","Name":"Debtor Agent Name","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"DebtorAccount":{"SchemeName":"UK.OBIE.IBAN","Identification":"GB29NWBK60161331926810","Name":"Debtor Account Name","SecondaryIdentification":"22-33-55"},"CardInstrument":{"CardSchemeName":"Debit Card","AuthorizationType":"OAuth","Name":"Card Name","Identification":"12-34-56"},"SupplementaryData":{}}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/transactions/"},"Meta":{"TotalPages":1,"FirstAvailableDateTime":"2017-05-03T00:00:00+00:00","LastAvailableDateTime":"2017-12-03T00:00:00+00:00"}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/transactions

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
account_id (path)
string, required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. Can raise: ResourceNotFound
fromBookingDateTime (query)
datetime, optional
Specifies start date and time for filtering of the Transaction records on the Transaction/BookingDateTime field.
toBookingDateTime (query)
datetime, optional
Specifies end date and time for filtering of the Transaction records on the Transaction/BookingDateTime field.
Response headers
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
TooEarly 425 The service is not ready to process the request.

Balances

A TPP may retrieve the account balance information resource for a specific AccountId (which is retrieved in the call to GET /accounts).

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -H "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.tD6PMU60PLd11y9aAIT_fV4NHYuP5QBHnkwIreDlagPQK7mlh1FE8jn-lNCddW6krnW6FN0QK3x64BwIrWbsW6U4RZwjHaNZ3cexQeX5GY0ifXtwVTEDvZsUV8tL-V0Q3Oe4sMoEppTUsMjNr5aNwMCQ8vKzbAS9nbtZYDnaZ5a6D5GWbkqmD4SvFi0NILGEhOELBRVp2YihUeTd1NxGhs73gM8uJzbG3gEQYNM9uqPwscBFIhC_iGixKeYoISRoUJZ-WIZ0hREN5admQDbn6r-viFpArZqd-l_fg5TuWcdvZeySIUqM6ESa-MYJ6k8KVs59YY8woxOXTPtN4H6vbw' \ 
-X GET "/api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/balances"

Example of response

{"Data":{"Balance":[{"AccountId":"22289","Amount":{"Amount":"1230.00","Currency":"GBP"},"CreditDebitIndicator":"Credit","Type":"InterimAvailable","DateTime":"2017-04-05T10:43:07+00:00","CreditLine":[{"Included":true,"Amount":{"Amount":"1000.00","Currency":"GBP"},"Type":"Temporary"}]},{"AccountId":"31820","Amount":{"Amount":"57.36","Currency":"GBP"},"CreditDebitIndicator":"Debit","Type":"InterimBooked","DateTime":"2017-05-02T14:22:09+00:00"}]},"Links":{"Self":"https://api.alphabank.com/open-banking/v3.1/aisp/balances/"},"Meta":{"TotalPages":1}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/balances

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
account_id (path)
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
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
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 "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.wCx8iokkSyPUwwdgWIE_4gQ9fyoUuytrHITFUgvuSPEyfckFibbNO1Tq8z7RbNhsi7rYERQszfR5-Xs0D0Q86BdPrskIY_E-MD-API6CIgPzgA8INVXNrJcUIzRu9eRdjAD5Cs51ky77sb3drjsZH7YR-NaWU4VvaJdtaz7TlaZ3QTbYYqgC62UNcW3LP0d5tEZ4urd17Sl36IoMXajjgLC6E6oGRuA9ayhmPfpXYX1uUaRwQWZ11ov1yRnbf9gRE2Tl0YfR83vA-FQZkvr7-U5BsbngKCIrdwF5GNtpvVD-rU40yBWK4rHIJgvgUdoVm-RNgznZ8PcGcJC0xZCybA' \ 
-X GET "/api/:provider_code/open-banking/v3.1/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}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/beneficiaries

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
account_id (path)
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
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
TooEarly 425 The service is not ready to process the request.

Direct Debits

An PASP 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 "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.ln0Y46bmNF4g-GyJTCfhabswrpBn_Nd5HhNccMqDPlKS3fLeUGHDN8L708J4XxOfCaE9jyFSCc_KctqWG2OTyUW49anqzXtjV1dEK9sAstw0o1_AtFCZtIYTPgVfMdyN7sND7zgsPUty10dxL30ms9x1Ofp7BfAhM_MG6ezWS6ItiYMg0Z39JmHTYjpBuX-k45oeLsIClgx6g1V6I16u3US5YfTjFgfege5M-1ksmi5_JLm9l06eHsMt5mdJAqVO2SQwTfcApWNT9OtMoVaw-1_ymvfI3ILokabf15fUlEx2LBcmRe77Ryag79vgs4DAWI9LKjpriCqcqj1nzKCDVQ' \ 
-X GET "/api/:provider_code/open-banking/v3.1/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}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/direct-debits

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
account_id (path)
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
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
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 "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.DfI7XyFfPF52AkfQ1F4v73ETRi0bfSiEPNwunUoJMMag-X4UICKkqFCcOeH1jAieuumU01_PLYbR6dhLAxDrpjtIUfS5_LrX53GDDFAX7viCScy9FHI8ILgH_cMc7egugA7XSeqmHTC3rdMy4YrogkoVDe--yGosbcvP-YpCMcAT28mNsNfCLUTP85P30w743CCbs7dmNEly_coNEdFCczBxp9QHcafzjqvIbB7UW3_z8t9Dy-K14LQ_LikWSHWqhQiLWhV36BLRW5bwbbRNuSQXvPfV74tx4eLr5OTpYkcLUpIcwFxW5v1Z7WJulBD6BjS-nRoUkK6zwCvTvg8C2A' \ 
-X GET "/api/:provider_code/open-banking/v3.1/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}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/standing-orders

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
account_id (path)
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
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
TooEarly 425 The service is not ready to process the request.

Party

The PASP 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 "Content-Type: application/json" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.GNauVMIpUVBGxU3rNrOVX3Kw1MZL6MDP3exWwz_WZifXYrAtDVH2H1_BUXatyyRR0Ht1N1XD_lukqKrcnv22wgbXm-rnMyrihoy-D0koQo8hI_t37dpknFaedM5ot1jT7rlaKctWqW7hYhoemMcJiA-4pIU_TkQpfPCLtd4kFP90e9sFYaZRXzYQQRRDs6nsu-yMfyNnkEGt2gXRwPrjDj1dnX3MNIiTEB2gO6Hv5GxC-9OGeXsAlS2p8bvm_ZB-WlxAxo2T4wGKv3aYp7uLq_MptsUzP06iOz3_dPJMCocR-Kg516JI2kfm4rsKhThJo0qdDTj6dh3Wdb8aAuloAA' \ 
-X GET "/api/:provider_code/open-banking/v3.1/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}}
Request

GET /api/:provider_code/open-banking/v3.1/aisp/accounts/:account_id/party

Headers
Header Type Description
Content-Type string, optional The media type of the body of the request. 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
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus, TooEarly
account_id (path)
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
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 PASP 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 OB KSA Compliance Solution resends the previously failed request.
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.
TooEarly 425 The service is not ready to process the request.