NAV
SaltEdge PSD2 Compliance Logo

AISP

Accounts

All

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6NjY1fSwiZXhwIjoxNTk2OTU5MTQ4fQ.Yf7T9yUUloypYBys_Uz_g7ifSJthCHUgtN3O1ceaeQIYvsrbFjw596JUj46lAMhnmGkuOy3hit4HvUpxLWI8tr24TqKaUIpg75_0QTPfjMEvv1_8C7LmBo9pYnKWhhbl6FtMESGBG-phM8K5UozmUbc6dbYx-siVpfBWEvEPKNi98WcIW_oxrMcWQT_6QtSljeND8_mml-jhKUt6WfaTPPpLNY9vPicRl7O3nUYluLReYBfzUsOS0VJzXNveaf9fpWgo8qbwotfD_CqwCo1C_mzQ04DtzvsC_qHpec_dgcylBkHnuS6kwTvbG38ZN-YGizmFN_emc5UB7eLakyLC8w" \ 
 -H "App-Id: hdxOnJzz7tUdwso5TeGIOQ" \ 
 -H "App-Secret: mQdTa13N7SoBsmnoHok0mQ" \ 
 -H "Access-Token: 0bd6a34ce608515b9ce2c2afae5d52fa047aaa07c10563b9e7ef4e786faf935f29d255858fac37d314bef7d24651ddebe60cb4342d98e0feaee5ca010c500c04" \ 
 -H "Client-Request-Id: 34" \ 
 -X GET "https://priora.saltedge.com/api/v2/accounts/all"

Example of unpacked Authorization header

{"data":{"per_page":50,"from_id":665},"exp":1574093211}

Example of response

{"data":[{"id":"864","name":"Visa","nature":"credit_card","iban":"FK54RAND61068428516174","number":"450746508","sort_code":"16-26-63","swift_code":"qALtN","currency_code":"GBP","balance":37,"available_amount":30.5,"provider_account_id":"229","extra":{},"payment_account":true,"created_at":"2019-11-18T16:04:51.182Z","updated_at":"2019-11-18T16:04:51.182Z"}],"meta":{"time":"2019-11-18T16:04:51.182Z","next_id":865}}

Returns all accounts belonging to a PSU and all relevant information about them. This endpoint should be called after refreshing PSU data on Salt Edge side.

Request

GET https://priora.saltedge.com/api/v2/accounts/all

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: AuthorizationMissing
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, ConfigurationError
App-Secret string, required Application’s app_secret from connection details tab.
Access-Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Authorization
Parameter Type Description
data hash, required Wrapper for the data.
exp integer, required The lifetime of the request in timestamp UTC format. Values greater than: Current time.
data.from_id integer, optional Return all accounts starting with a specific id. Values greater than: 0
data.per_page integer, optional Number of accounts that should be returned per request. Values in range between: 1 and 1000 Default value: 20
Response
Response Type Description
data array, required Wrapper for the data.
data.created_at datetime, required Datetime of account creation on Priora side.
data.currency_code string, required Account currency code in ISO 4217.
data.id string, required Account identifier on Priora.
data.name string, required Human readable account name.
data.nature string, required Account nature. Allowed values: account, card, debit_card, credit_card, checking, savings, investment, bonus, loan, credit, insurance, ewallet, mortgage
data.payment_account boolean, required Specifies whether account can be used to initiate payments. Allowed values: true, false
data.provider_account_id string, required ID that uniquely identifies this account in provider’s system.
data.status string, required Conveys current status of the operation. Allowed values: active, inactive
data.updated_at datetime, required Datetime of last account updation on Priora side.
meta hash, required Wrapper for the response metadata.
meta.time datetime, required Time when the request was processed.
data.available_amount float, optional Physically available funds.
data.balance float, optional Account balance.
data.extra hash, optional Any extra information related to an account. Default value: {}
data.iban string, optional International Bank Account Number.
data.number string, optional Account number identifier within Bank.
data.sort_code string, optional Used to identify bank accounts in United Kingdom and Ireland.
data.swift_code string, optional Business Identifier Code.
meta.next_id integer, optional Id of the next entity used in paginated responses.
Related Errors
Class Code Description
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
TokenNotFound 401 Token specified in request does not exist or cannot be retrieved.
TokenRevoked 401 Token specified in request is revoked and cannot be used anymore.
TokenExpired 401 Token specified in request is expired and cannot be used.
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.

Holder

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNTk2OTU5MTQ4fQ.IkM3AkiLvNZZibLGKVl0hKWxpR3xt5IRkQHxvi2lUZUtd4I9GIMpWuguJbqRQTbOdJw1IdMJapNg2ODai05bg8BcLcGHsBoTUsmGxHCx0GVsRylvxms6fxIjOYU1byUlA99_w5V60bW63ohZN97ipVuG6bSvNSyvApEclPhjsOTOedwQrG5KjOtelAw86I5vhgmwf7O20FRNaDPfHWZTiMeLsStAz0janeyHEEWvJZT74vI7w80ueOEJRg1VSdqsuGaIUMtXvUbfatc0Odkh_mkBOpEPYm1zFlZoDfClnVCq2qyRNpEk3Kqo6YF_oaAKn2juXUtfyU1JYWI42ohBdw" \ 
 -H "App-Id: HyR-HnEk7_WMUJv8BD6LkA" \ 
 -H "App-Secret: yqQW_-qL3l1YnoJyzDvX-g" \ 
 -H "Access-Token: 20442d11db40783035aa521337d264760fe46e0b241389fdc2081dae37a9952f6b5f58a7341a990c46a38b6b38c03770a4ecbd4d495c4030e323ad1b292d428f" \ 
 -H "Client-Request-Id: 17" \ 
 -X GET "https://priora.saltedge.com/api/v2/accounts/holder"

Example of unpacked Authorization header

{"data":{},"exp":1574093211}

Example of response

{"data":{"name":"John Smith","email":"example@example.com","phone":"727096456","address":"409 Broadway GUILDFORD","date_of_birth":"1989-01-18"}}

Returns holder information that belongs to a PSU. This endpoint should be called after refreshing PSU data on Salt Edge side.

Request

GET https://priora.saltedge.com/api/v2/accounts/holder

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: AuthorizationMissing
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, ConfigurationError
App-Secret string, required Application’s app_secret from connection details tab.
Access-Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Authorization
Parameter Type Description
data hash, required Wrapper for the data.
exp integer, required The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response
Response Type Description
data hash, required Wrapper for the data.
data.address string, optional PSU adress.
data.date_of_birth string, optional PSU date of birth in datetime format.
data.email string, optional PSU email.
data.name string, optional PSU name.
data.phone string, optional PSU phone number.
Related Errors
Class Code Description
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
TokenNotFound 401 Token specified in request does not exist or cannot be retrieved.
TokenRevoked 401 Token specified in request is revoked and cannot be used anymore.
TokenExpired 401 Token specified in request is expired and cannot be used.
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.

Payment

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNTk2OTU5MTQ4fQ.IkM3AkiLvNZZibLGKVl0hKWxpR3xt5IRkQHxvi2lUZUtd4I9GIMpWuguJbqRQTbOdJw1IdMJapNg2ODai05bg8BcLcGHsBoTUsmGxHCx0GVsRylvxms6fxIjOYU1byUlA99_w5V60bW63ohZN97ipVuG6bSvNSyvApEclPhjsOTOedwQrG5KjOtelAw86I5vhgmwf7O20FRNaDPfHWZTiMeLsStAz0janeyHEEWvJZT74vI7w80ueOEJRg1VSdqsuGaIUMtXvUbfatc0Odkh_mkBOpEPYm1zFlZoDfClnVCq2qyRNpEk3Kqo6YF_oaAKn2juXUtfyU1JYWI42ohBdw" \ 
 -H "App-Id: 9zP5wU8ItSUlkvWHViCt1w" \ 
 -H "App-Secret: SJDCclW3NkeeAhJX7CX4dA" \ 
 -H "Access-Token: 728037d96181287cd2394f43943d07897fc1a52a0b657489ee2fc34c54c7e8dc95959621394c1a6ce49db0c6e19a9a62909152bd4e39a9a7ca57bb572ee7ef41" \ 
 -H "Client-Request-Id: 17" \ 
 -X GET "https://priora.saltedge.com/api/v2/accounts/payment"

Example of unpacked Authorization header

{"data":{},"exp":1574093211}

Example of response

{"data":[{"id":"735","name":"Test payment","nature":"account","iban":"FK93RAND00954339238694","number":"836076798","sort_code":"84-42-94","swift_code":"CN9zd","currency_code":"EUR","provider_account_id":"43","created_at":"2019-11-18T16:04:50.985Z","updated_at":"2019-11-18T16:04:50.986Z"}]}

Returns accounts that are available for making payments and belong to a PSU. This endpoint should be called after refreshing PSU data on Salt Edge side.

Request

GET https://priora.saltedge.com/api/v2/accounts/payment

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: AuthorizationMissing
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, ConfigurationError
App-Secret string, required Application’s app_secret from connection details tab.
Access-Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Authorization
Parameter Type Description
data hash, required Wrapper for the data.
exp integer, required The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response
Response Type Description
data array, required Wrapper for the data.
data.created_at datetime, required Datetime of account creation on Priora side.
data.currency_code string, required Account currency code in ISO 4217.
data.id string, required Account identifier on Priora.
data.name string, required Human readable account name.
data.nature string, required Account nature. Allowed values: account, card, debit_card, credit_card, checking, savings, investment, bonus, loan, credit, insurance, ewallet, mortgage
data.provider_account_id string, required ID that uniquely identifies this account in provider’s system.
data.updated_at datetime, required Datetime of last account updation on Priora side.
data.iban string, optional International Bank Account Number.
data.number string, optional Account number identifier within Bank.
data.sort_code string, optional Used to identify bank accounts in United Kingdom and Ireland.
data.status string, optional Conveys current status of the operation. Allowed values: active, inactive
data.swift_code string, optional Business Identifier Code.
Related Errors
Class Code Description
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
TokenNotFound 401 Token specified in request does not exist or cannot be retrieved.
TokenRevoked 401 Token specified in request is revoked and cannot be used anymore.
TokenExpired 401 Token specified in request is expired and cannot be used.
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.

Refresh

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImZyb21fZGF0ZSI6IjIwMTktMDgtMTgiLCJ0b19kYXRlIjoiMjAxOS0xMS0xOCIsImluaXRpYXRlZF9ieV9jdXN0b21lciI6ZmFsc2UsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSJ9LCJleHAiOjE1OTY5NTkxNDh9.u9QFKN-zqrkb9fSwcY59zlyO3WmW1CS1vNkRTWotyIL1wDIsS8UfClIvavaySsYrfkk_QOD5SfX2i6lsi_ejs7BayGQZTtRn_yArfLYXLtAlEdSAQGW2oe3mn9KBj0QABi0MSrAunTX8bq2mws8OHsdWw5x_s8d9kzIKACOwVWdrNvkJ1xDh1V3rLynQyN15chMKBhFvhx_jnvY8C8shArigQ-vXJfcVvVYHbncbDN2ofTn3dhGNcEymSedwx2mfIUOflca22kh7H9xdZTEmEQ_JTWwPq7yeNLLaaTUjHtXhijLFr7eo8KXOg1UO0FRyjeN9PxMXvbev0G9-VzQGBg" \ 
 -H "App-Id: UJbEee74CaUNMzrvzfAtUQ" \ 
 -H "App-Secret: B_oeBL7GIK9jPxzQSrmlLQ" \ 
 -H "Access-Token: b2e3f5f24b69dad11a89e9fdada9dd695a1e8f965a3f33248ea41ae6ca46c0d3a2ea38233fe9b6cedeaa9067ee89bb87981d0988bd688e8b8056640c86350b6f" \ 
 -H "Client-Request-Id: 17" \ 
 -X PUT "https://priora.saltedge.com/api/v2/accounts"

Example of unpacked Authorization header

{"data":{"from_date":"2019-08-18","to_date":"2019-11-18","initiated_by_customer":false,"redirect_url":"https://user.will.be/redirected/here"},"exp":1574093211}

Example of response

{"data":{"session_secret":"fssZuhgv1LNyG_TaHmgv"}}

Initiates the process of refreshing PSU data (accounts, transactions, holder info) on Salt Edge PSD2 Compliance side from the ASPSP which issued the access token.

Request

PUT https://priora.saltedge.com/api/v2/accounts

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: AuthorizationMissing
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, ConfigurationError
App-Secret string, required Application’s app_secret from connection details tab.
Access-Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Authorization
Parameter Type Description
data hash, required Wrapper for the data.
exp integer, required The lifetime of the request in timestamp UTC format. Values greater than: Current time.
data.from_date datetime, optional Specifies the starting date in ISO 8601: “yyyy-mm-dd” format, from which account data should be fetched. This value will be set to 90 days ago by default. Default value: 90 days ago.
data.initiated_by_customer boolean, optional Defines whether request was initiated by PSU or automatically. Default value: false Can raise: ActionNotAllowed
data.redirect_url string, optional The URL on which PSU should be redirected by TPP in order to perform authentication.
data.to_date datetime, optional Specifies the ending date in ISO 8601: “yyyy-mm-dd” format, to which account data should be fetched. This value will always be the today’s date by default. Default value: Today.
Response
Response Type Description
data hash, required Wrapper for the data.
data.session_secret string, required Session identifier in Salt Edge PSD2 Compliance.
Related Errors
Class Code Description
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
TokenNotFound 401 Token specified in request does not exist or cannot be retrieved.
TokenRevoked 401 Token specified in request is revoked and cannot be used anymore.
TokenExpired 401 Token specified in request is expired and cannot be used.
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.
ActionNotAllowed 406 You're not allowed to perform this action. This might be a configuration problem or parameters incompatibility.

Transactions

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6MTY1fSwiZXhwIjoxNTk2OTU5MTQ4fQ.U3ff84p11n5vkh8tExYM-XOMYW-u9_rinSwZO6pECGyIRwiQWUaRPJCCBIpiLWCB6DxS1_bjwUlggDG1EsnmIJjy3-z5cZKWFuj0nbnJ4EmqKijFHUyODEB_hmygcJDIJVtMiT_SIcBDI1lDwWr8Tlvkdtd5pEFky_7nfIwb_H_R8uo5w-Q1V_ufqYGhQSdqT6ive7SzZJ0cCQo-MFw4BLxwAYFuWKPQBjT1ugqc5Zk0G-NW45rgnppzQ5TKKSd9idpFEoh737tCpSPUYpoastiOYzzRCapqaKniXzMI-S-u-p5qkJm5g1Qd7dGdI_67WHaCWAO7QRXgaW7Wssmbow" \ 
 -H "App-Id: 1aeKgOrMn24XdsU8K5vgNw" \ 
 -H "App-Secret: YTYP2gAUWcXW3l9wvtMT6w" \ 
 -H "Access-Token: cf3f53fd0422519c4259cbbad9cdd556a5e6e03618a474431823e394b6f1204c98a46609f0606e8920a153665175739cc0174f721b263aeb0838f1a1afef8d3e" \ 
 -H "Client-Request-Id: 17" \ 
 -X GET "https://priora.saltedge.com/api/v2/accounts/:account_id/transactions"

Example of unpacked Authorization header

{"data":{"per_page":50,"from_id":165},"exp":1574093211,"account_id":442}

Example of response

{"data":[{"id":1054,"account_id":711,"currency_code":"EUR","amount":16.54,"fees":[{}],"description":"Internal transfer.","extra":{},"provider_transaction_id":"614","made_on":"2019-11-18T16:04:51.252Z","status":"posted","category":"transfer","created_at":"2019-11-18T16:04:51.253Z","updated_at":"2019-11-18T16:04:51.253Z"}],"meta":{"time":"2019-11-18T16:04:51.253Z","next_id":1055}}

Returns transactions for a specific account. This endpoint should be called after refreshing PSU data on Salt Edge side.

Request

GET https://priora.saltedge.com/api/v2/accounts/:account_id/transactions

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: AuthorizationMissing
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, ConfigurationError
App-Secret string, required Application’s app_secret from connection details tab.
Access-Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Authorization
Parameter Type Description
account_id (path) integer, required Account identifier on Priora. Can raise: AccountNotFound
data hash, required Wrapper for the data.
exp integer, required The lifetime of the request in timestamp UTC format. Values greater than: Current time.
data.from_id integer, optional Return transactions starting with a specific id. Values greater than: 0
data.per_page integer, optional Number of transactions that should be returned per request. Values in range between: 1 and 1000 Default value: 20
Response
Response Type Description
data array, required Wrapper for the data.
data.account_id integer, required Account identifier on Priora.
data.amount float, required Transaction amount
data.created_at datetime, required Datetime of transaction creation on Priora side.
data.currency_code string, required Transaction currency code in ISO 4217.
data.description string, required Transaction description.
data.fees array, required List of all fees applied to the given transation.
data.id integer, required Transaction identifier on Priora.
data.made_on datetime, required Date on which transaction was processed.
data.provider_transaction_id string, required Transaction identifier on ASPSP side.
data.status string, required Transaction status. Allowed values: posted, pending
data.updated_at datetime, required Datetime of transaction updation on Priora side.
meta hash, required Wrapper for the response metadata.
meta.time datetime, required Time when the request was processed.
data.category string, optional Transaction category defined on ASPSP side.
data.extra hash, optional Any data relevant to the transaction. Default value: {}
meta.next_id integer, optional Id of the next entity used in paginated responses.
Related Errors
Class Code Description
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
TokenNotFound 401 Token specified in request does not exist or cannot be retrieved.
TokenRevoked 401 Token specified in request is revoked and cannot be used anymore.
TokenExpired 401 Token specified in request is expired and cannot be used.
AccountNotFound 404 Account specified in request does not exist or cannot be retrieved.
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.
Go to previous page
Go to next page