Salt Edge PSD2 Compliance Logo

OB

Consents

These endpoints are responsible for managing of account-access-consent resources. Consent creation is the start point of authentication and authorization of PSU for future access to accounts and transactions. Process of consent creation should start once PSU grants his consent to TPP. At the end of authorization (after user successful/unsuccessful authentication), Connector should update authorization status.

Create

Create an access token with a set of access rights, named scopes. As a result, Connector should send an create or update callback to Salt Edge PSD2 Compliance with the result of the operation, be it a success, fail or request for additional steps.

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 123" \ 
 -H "Access-Token: mhPZ9XlMR9dDEe4eiusQ_IU8fpoQE35_VWHLjMcfnNVRD3XG5HvqDoeyul560QQOdPKzuTfLa2gt2Z5ZY6fW0g" \ 
 -X POST "https://your.connector.url/api/priora/ob/v1/consents"

Example of request parameters

{"data":{"app_name":"Fentury","tpp_global_urn":"PSDNL-FCA-034681","provider_code":"demobank","access_token":"fejJAKKA12321AFK","consent_id":12,"permissions":["ReadAccountsDetail","ReadBalances","ReadBeneficiariesDetail","ReadDirectDebits","ReadProducts","ReadStandingOrdersDetail","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadOffers","ReadPAN","ReadParty","ReadPartyPSU","ReadScheduledPaymentsDetail","ReadStatementsDetail"],"expiration_date_time":"2017-05-02T00:00:00+00:00","transaction_from_date_time":"2017-05-02T00:00:00+00:00","transaction_to_date_time":"2017-05-02T00:00:00+00:00"},"exp":1606298169}
Request

POST https://your.connector.url/api/priora/ob/v1/consents

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response headers
Header Type Description
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 should be returned.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.

Revoke

Revoke an already existing and active access token.

CURL

curl -i  \ 
 -H "Authorization: Bearer Az90SAOJklae" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 123" \ 
 -H "Access-Token: mhPZ9XlMR9dDEe4eiusQ_IU8fpoQE35_VWHLjMcfnNVRD3XG5HvqDoeyul560QQOdPKzuTfLa2gt2Z5ZY6fW0g" \ 
 -X PATCH "https://your.connector.url/api/priora/ob/v1/consents/:consent_id/revoke"

Example of request parameters

{"data":{"provider_code":"demobank"},"exp":1606298169}
Request

PATCH https://your.connector.url/api/priora/ob/v1/consents/:consent_id/revoke

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response headers
Header Type Description
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 with an empty JSON "{}" should be returned.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.

Accounts

Refresh

This endpoint initiate refresh process of accounts and transactions on connector side before sending them to Salt Edge PSD2 Compliance Solution. As a result, Connector should send an refresh callback to Salt Edge PSD2 Compliance with identifiers of related consent and refresh process.

CURL

curl -i  \ 
 -H "Authorization: example_Authorization" \ 
 -H "Access-Token: e4649d535f5e3125bcc939e2f3b33a070127be520e2f1134ed8722976703e0b32d9354fb147014103ce39f6eed428ac65d82659b6289901449c73d12d939c28f" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 765" \ 
 -X POST "https://your.connector.url/api/priora/ob/v1/accounts/refresh"

Example of request parameters

{"data":{"app_name":"Fentury","provider_code":"demobank","consent_id":123,"session_id":456},"exp":1606298169}
Request

POST https://your.connector.url/api/priora/ob/v1/accounts/refresh

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response headers
Header Type Description
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 should be returned.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.

Get

Fetch list of accounts belonging to a PSU and all relevant information about them.

CURL

curl -i  \ 
 -H "Authorization: example_Authorization" \ 
 -H "Access-Token: e4649d535f5e3125bcc939e2f3b33a070127be520e2f1134ed8722976703e0b32d9354fb147014103ce39f6eed428ac65d82659b6289901449c73d12d939c28f" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 123" \ 
 -X GET "https://your.connector.url/api/priora/ob/v1/accounts"

Example of response

{"data":[{"id":"421","status":"Enabled","status_update_date_time":"2019-01-01T06:06:06+00:00","currency":"GBP","account_type":"Personal","account_sub_type":"CurrentAccount","description":"Description of account","nickname":"Bills","openingdate":"2019-01-01","maturity_date":"2019-01-01","switch_status":"processing","account":[{"scheme_name":"UK.OBIE.SortCodeAccountNumber","identification":"80200110203345","name":"Mr Kevin","secondary_identification":"00021"}],"servicer":{"scheme_name":"UK.OBIE.BICFI","identification":"80200110203345"},"balances":[{"amount":{"amount":"1230.00","currency":"GBP"},"credit_debit_indicator":"Credit","type":"InterimAvailable","date_time":"2017-04-05T10:43:07+00:00","credit_line":[{"included":true,"amount":{"amount":"1000.00","currency":"GBP"},"type":"Temporary"}]}]}]}
Request

GET https://your.connector.url/api/priora/ob/v1/accounts

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
Response headers
Header Type Description
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 should be returned.


Transactions

This endpoint is responsible for fetching transactions which belong to requested account.

CURL

curl -i  \ 
 -H "Authorization: example_Authorization" \ 
 -H "Access-Token: 2cab054fa0dfd20d725ef46c533b537701c29d47ebea97893374d4e47714e49e2e331764e4f4a20d5e285dbb08af9566e14a8f597230bca6d9f5b3b2048a71f5" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 123" \ 
 -X GET "https://your.connector.url/api/priora/ob/v1/accounts/:account_id/transactions"

Example of request parameters

{"data":{"account_id":"87","from_date":"2019-11-18","to_date":"2019-11-18","from_id":"101"},"exp":1574093209}

Example of response

{"meta":{"next_id":"151"},"data":[{"id":"214","transaction_reference":"Ref 1","statement_reference":["some-ref"],"credit_debit_indicator":"Credit","status":"Booked","transaction_mutability":"Immutable","booking_date_time":"2017-04-05T10:43:07+00:00","value_date_time":"2017-04-05T10:45:22+00:00","transaction_information":"Cash from Aubrey","amount":{"amount":"10.00","currency":"GBP"},"charge_amount":{"amount":"10.00","currency":"GBP"},"currency_exchange":{"source_currency":"EUR","target_currency":"GBP","unit_currency":"GBP","exchange_rate":"0.92","contract_identification":"some-identification","quotation_date":"2017-04-05","instructed_amount":{"amount":"10.00","currency":"GBP"}},"bank_transaction_code":{"code":"ReceivedCreditTransfer","sub_code":"DomesticCreditTransfer"},"proprietary_bank_transaction_code":{"code":"Transfer","issuer":"AlphaBank"},"balance":{"amount":{"amount":"230.00","currency":"GBP"},"type":"InterimBooked","credit_debit_indicator":"Credit"},"merchant_details":{"merchant_name":"Merchant name","merchant_category_code":"some-code"},"creditor_agent":{"scheme_name":"UK.OBIE.IBAN","identification":"GB29NWBK60161331926819","name":"Creditor Agent Name","postal_address":{"address_type":"Address with house number and street","department":"Prime Minister's Office","sub_department":"Cabinet Office","street_name":"Sir George Downing","building_number":"10 Downing Street","post_code":"SW1A 2AA","town_name":"City of Westminster London,","country_sub_division":"London","country":"GB","address_line":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"creditor_account":{"scheme_name":"UK.OBIE.IBAN","identification":"GB29NWBK60161331926819","name":"Creditor Account Name","secondary_identification":"12-34-56"},"debtor_agent":{"scheme_name":"UK.OBIE.IBAN","identification":"GB29NWBK60161331926810","name":"Debtor Agent Name","postal_address":{"address_type":"Address with house number and street","department":"Prime Minister's Office","sub_department":"Cabinet Office","street_name":"Sir George Downing","building_number":"10 Downing Street","post_code":"SW1A 2AA","town_name":"City of Westminster London,","country_sub_division":"London","country":"GB","address_line":"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"}},"debtor_account":{"scheme_name":"UK.OBIE.IBAN","identification":"GB29NWBK60161331926810","name":"Debtor Account Name","secondary_identification":"22-33-55"},"card_instrument":{"card_scheme_name":"Debit Card","authorization_type":"OAuth","name":"Card Name","identification":"12-34-56"},"supplementary_data":{}}]}
Request

GET https://your.connector.url/api/priora/ob/v1/accounts/:account_id/transactions

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response headers
Header Type Description
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 should be returned.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.

Beneficiaries

An AISP may retrieve the account beneficiaries information resource for a specific AccountId

CURL

curl -i  \ 
 -H "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X GET "https://your.connector.url/api/priora/ob/v1/accounts/:account_id/beneficiaries"

Example of response

{"data":{"beneficiary_id":"Ben1","reference":"Towbar Club","creditor_account":{"scheme_name":"UK.OBIE.SortCodeAccountNumber","identification":"80200112345678","name":"Mrs Juniper"}},"exp":1606298169}
Request

GET https://your.connector.url/api/priora/ob/v1/accounts/:account_id/beneficiaries

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
Response headers
Header Type Description
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 should be returned.


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 "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X GET "https://your.connector.url/api/priora/ob/v1/accounts/:account_id/direct_debits"

Example of response

{"data":{"direct_debit_id":"DD03","mandate_identification":"Caravanners","direct_debit_status_code":"Active","name":"Towbar Club 3 - We Love Towbars","previous_payment_date_time":"2017-04-05T10:43:07+00:00","previous_payment_amount":{"amount":"0.57","currency":"GBP"}},"exp":1606298169}
Request

GET https://your.connector.url/api/priora/ob/v1/accounts/:account_id/direct_debits

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
Response headers
Header Type Description
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 should be returned.


Standing Orders

An AISP may retrieve the standing-order resource for a specific AccountId

CURL

curl -i  \ 
 -H "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X GET "https://your.connector.url/api/priora/ob/v1/accounts/:account_id/standing_orders"

Example of response

{"data":{"standing_order_id":"Ben3","frequency":"EvryWorkgDay","reference":"Towbar Club 2 - We Love Towbars","first_payment_date_time":"2017-08-12T00:00:00+00:00","first_payment_amount":{"amount":"0.57","currency":"GBP"},"next_payment_date_time":"2017-08-13T00:00:00+00:00","next_payment_amount":{"amount":"0.56","currency":"GBP"},"final_payment_date_time":"2027-08-12T00:00:00+00:00","final_payment_amount":{"amount":"0.56","currency":"GBP"},"standing_order_status_code":"Active","creditor_account":{"scheme_name":"UK.OBIE.SortCodeAccountNumber","identification":"80200112345678","name":"Mrs Juniper"}},"exp":1606298169}
Request

GET https://your.connector.url/api/priora/ob/v1/accounts/:account_id/standing_orders

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
Response headers
Header Type Description
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 should be returned.


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 "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X GET "https://your.connector.url/api/priora/ob/v1/accounts/:account_id/party"

Example of response

{"data":{"party_id":"PXSIF023","party_number":"0000007456","party_type":"Delegate","name":"Kevin Atkinson","full_legal_name":"Mr Kevin Bartholmew Atkinson","legal_structure":"UK.OBIE.Individual","beneficial_ownership":false,"account_role":"UK.OBIE.Administrator","email_address":"kev@semiotec.co.jp","relationships":{"account":{"related":"https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289","id":"22289"}},"address":{"address_type":"Business","street_name":"Street","building_number":"15","post_code":"NW1 1AB","town_name":"London","country":"GB"}},"exp":1606298169}
Request

GET https://your.connector.url/api/priora/ob/v1/accounts/:account_id/party

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
Response headers
Header Type Description
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 should be returned.


Errors

Create

This endpoint is responsible for receiving validation errors of responses which Connector sends to Salt Edge PSD2 Compliance Solution.

CURL

curl -i  \ 
 -H "Authorization: example_Authorization" \ 
 -H "Access-Token: b2077c5c020a5e262767aac63fdbc75fd64461afc660784fbc3451766f586bb4836e3405007c2caf497a1125ba58fb49be65b3c352285dea68328aded84e2f91" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 685" \ 
 -X POST "https://your.connector.url/api/priora/ob/v1/errors"

Example of request parameters

{"data":{"request":{"method":"delete","url":"https://user.will.be/redirected/here","headers":{}},"error":{"error_message":"something went wrong","error_class":"InternalProviderError"}},"exp":1574093209}
Request

POST https://your.connector.url/api/priora/ob/v1/errors

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key.
Access-Token string, required The token which is created by a connector as a result of successful authentication.
Accept string, required Media type that is acceptable for the response. Allowed values: application/json
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Client-Id integer, required Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation.
Consent-Id integer, optional ID of the corresponding consent object as returned by an Account Information Consent Request.
Unpacked Request Authorization
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response headers
Header Type Description
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 should be returned.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.

Authorizations

Create

Send all the received data from TPP to Salt Edge PSD2 Compliance in order to create an authorization attempt and allow Salt Edge PSD2 Compliance to validate all the incoming data.

CURL

curl -i  \ 
 -H "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X POST "/api/connectors/ob/v1/authorizations"

Example of request parameters

{"data":{"authorize_url":"https://bank.com?client_id=some_client_id&redirect_uri=https://tpp.com&scope=openid%20accounts&response_type=code&state=weqe","auth_code":"xf7dhf-edfgbDf","auth_code_exp":"2021-01-25T15:03:52.177Z"},"exp":1606298169}

Example of response

{"data":{"redirect_uri":"https://tpp.com?error=access_denied&error_description=User+denied+the+authorization&state=weqe","authorization_id":153,"consent_id":162,"access_token":"cziaTXgBaCYerEHDvWE9"}}
Request

POST /api/connectors/ob/v1/authorizations

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Allowed values: application/jwt, text/plain
App-Id string, required Provider's app_id from connection details tab. Can raise: ProviderNotFound, ProviderDisabled, ConfigurationError
App-Secret string, required Provider's app_secret from connection details tab.
Unpacked Request Body (JWT)
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
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.
InvalidScope 400 TPP has sent wrong scopes.
InvalidRequest 400 Given data is invalid. More in message.
RequestFormatInvalid 400 Request format is wrong. Details are stored in error_message
ConfigurationError 400 Missing configurations in dashboard.
UnauthorizedClient 401 Wrong client_id in authorize_url.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Update

Update the status of just created authorization. Should be invoked after user successful/unsuccessful authentication.

CURL

curl -i  \ 
 -H "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X PUT "/api/connectors/ob/v1/authorizations/:id"

Example of request parameters

Example of response

{"data":{"authorization_id":123,"status":"approved","redirect_uri":"https://tpp.com?code=auth_code&state=weqe&scope=openid%20accounts"}}
Request

PUT /api/connectors/ob/v1/authorizations/:id

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Allowed values: application/jwt, text/plain
App-Id string, required Provider's app_id from connection details tab. Can raise: ProviderNotFound, ProviderDisabled, ConfigurationError
App-Secret string, required Provider's app_secret from connection details tab.
Unpacked Request Body (JWT)
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.
ConfigurationError 400 Missing configurations in dashboard.
NotFound 404 A resource could not be found. More in error_message.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Accounts

Accounts Endpoints allow Connector to notify about changes in AIS state.

Refresh

Notify about finishing of refreshing of accounts and transactions on Connector side.

CURL

curl -i  \ 
 -H "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X PUT "/api/connectors/ob/v1/accounts/refresh"

Example of request parameters

{"data":{"consent_id":123,"session_id":456},"exp":1606298169}
Request

PUT /api/connectors/ob/v1/accounts/refresh

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Allowed values: application/jwt, text/plain
App-Id string, required Provider's app_id from connection details tab. Can raise: ProviderNotFound, ProviderDisabled, ConfigurationError
App-Secret string, required Provider's app_secret from connection details tab.
Unpacked Request Body (JWT)
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
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.
ResourceInvalidConsentStatus 400 The action can't be performed with current status of consent.
ConfigurationError 400 Missing configurations in dashboard.
Unauthorized 401 Consent is already expired.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Consents

Revoke

Revoke consents callback needs to be called any time the consent is revoked on the Provider Connector side. E.g. if the PSU revokes consent to data access that AISP is granted with, by using the corresponding functionality is ASPSP's direct interface (web/mobile banking).

CURL

curl -i  \ 
 -H "App-Id: ds213FtasF23" \ 
 -H "App-Secret: WE21ffgGjgYqwigjhgh&g15f3" \ 
 -H "Content-Type: application/jwt" \ 
 -X PATCH "/api/connectors/ob/v1/consents/:consent_id/revoke"

Example of request parameters

{"data":{},"exp":1606298169}
Request

PATCH /api/connectors/ob/v1/consents/:consent_id/revoke

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Allowed values: application/jwt, text/plain
App-Id string, required Provider's app_id from connection details tab. Can raise: ProviderNotFound, ProviderDisabled, ConfigurationError
App-Secret string, required Provider's app_secret from connection details tab.
Unpacked Request Body (JWT)
data
hash, required
Wrapper for the data.
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
consent_id (path)
integer, required
The consent identifier assigned to the created resource. Can raise: Unauthorized, ResourceNotFound, ResourceInvalidConsentStatus
Response

Upon successful request, 200 status code with an empty JSON "{}" should be returned.


Related Errors
Class Code Description
ResourceNotFound 400 Specified resource doesn't exist.
ResourceInvalidConsentStatus 400 The action can't be performed with current status of consent.
ConfigurationError 400 Missing configurations in dashboard.
Unauthorized 401 Consent is already expired.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled 406 Cooperation with specified Provider is impossible.