Accounts
All
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.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6NjY1fSwiZXhwIjoxNzE0ODg0NDUwfQ.pehz-MDorg5zU9lvkZhjhaJL_mHzJ9N2m4x97h2sOf8nQySaO4viYTVXps2_YJFOoa9Tugxp343YXD5i2M0YOHE_HhrOc3PyDSvHfadAwhLnmA3_Ql3jJFJ7XDfTcqiO7NEPoz9IXFZW-fz7_6zJa9yXDAq5SD4Xy3mzeyr038jBeiH1fHgNydj4mZVeK-r-tqzZMf7pmmh6sb5CY3BNP7NQI72RbHdQ-InT74jBBY4lorvPONuterRYx8A9MCoofCaBbOsMkR4Ek-Cv_nhj0-B5BxjQRtpwVOO4MOeTOQaGfNAlSs-tWTLO07jntCjaQwSTodFm62Uv3rZCO3V_Aw" \
-H "App-Id: hdxOnJzz7tUdwso5TeGIOQ" \
-H "App-Secret: mQdTa13N7SoBsmnoHok0mQ" \
-H "Access-Token: 0bd6a34ce608515b9ce2c2afae5d52fa047aaa07c10563b9e7ef4e786faf935f29d255858fac37d314bef7d24651ddebe60cb4342d98e0feaee5ca010c500c04" \
-H "Client-Request-Id: 34" \
-X GET "/api/v2/accounts/all"
Example of request parameters
{"data":{"per_page":50,"from_id":665},"exp":1574093211}
Example of response
{"meta":{"time":"2019-11-18T16:04:51.182Z","next_id":865},"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"}]}
Request
GET
/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, CertificateNotFound
|
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 Request Authorization
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
TokenMissing | 400 | This request cannot be performed without Access_Token header. |
AuthorizationMissing | 401 | Authorization header is missing. |
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. |
CertificateNotFound | 404 | Certificate has no permissions. |
Holder
Returns holder information that belongs to a PSU. This endpoint should be called after refreshing PSU data on Salt Edge side.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzE0ODg0NDUwfQ.nksgFXHUZ5z7R4qNqZGte4xXACO2vn2XoRToKJJDLEkpxC3RHAwBpGAAgl0hYQEhTlklZFKcDk0EdSop4V0AZvP5TJnWXPR9ef4PAq8axMPB-px6UT7sMaTSSDJyHxJthNBJjRscr0BxaFH5F4gFSyE29j7D3fHFdo-JEdJi_CiO4drIU7vtG0itQsqm63TVWPRQAgJdzcO4pcbakuH24FcG4kkhRhiUF1WSv7DwSqTJHfEnLb-ON8F4jLkSkw7JocLA5kGSzLuolDytdArMRmH4ceGMC2YFbY1ZTydYKFCU9NxqEOV8u2oi-MglxxhRNpTtkcSuuOUrutm1m_1tRA" \
-H "App-Id: HyR-HnEk7_WMUJv8BD6LkA" \
-H "App-Secret: yqQW_-qL3l1YnoJyzDvX-g" \
-H "Access-Token: 20442d11db40783035aa521337d264760fe46e0b241389fdc2081dae37a9952f6b5f58a7341a990c46a38b6b38c03770a4ecbd4d495c4030e323ad1b292d428f" \
-H "Client-Request-Id: 17" \
-X GET "/api/v2/accounts/holder"
Example of request parameters
{"data":{},"exp":1574093211}
Example of response
{"data":{"name":"John Smith"}}
Request
GET
/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, CertificateNotFound
|
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 Request Authorization
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
TokenMissing | 400 | This request cannot be performed without Access_Token header. |
AuthorizationMissing | 401 | Authorization header is missing. |
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. |
CertificateNotFound | 404 | Certificate has no permissions. |
Refresh
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.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImZyb21fZGF0ZSI6IjIwMTktMDgtMTgiLCJ0b19kYXRlIjoiMjAxOS0xMS0xOCIsImluaXRpYXRlZF9ieV9jdXN0b21lciI6ZmFsc2UsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSJ9LCJleHAiOjE3MTQ4ODQ0NTB9.JBqb-Y6xF6PLLUjqNmPrthxwgsxHRh6_RIYxNkjdO6MeKoZEQDwP2wRXxxwKzPJ84u5ppgVt1mc_ACDXv5m8cwfobA2AVO0XIe55kIIlirWCkCx0j_0zf_8kimjfd5jGrC35ovKA9W6wvjt-Jef548blXQKSNA0nIu085pev0zrtk01X1ho0x_ZmmYB8a0S3v3bAwV0TQDPW5mTxu4hFqj2hfZpgipYKe-wneZfnEFuEbkdiUjAFUgtAsZVlGO0-s4YVXDVV87LVd6iUOXMXQu_68AM8Pvy-DOHIZiMiXBWMJMCHWApIxkvfWKF9MIHornibRqPoaTzBd4y6Cx57-w" \
-H "App-Id: UJbEee74CaUNMzrvzfAtUQ" \
-H "App-Secret: B_oeBL7GIK9jPxzQSrmlLQ" \
-H "Access-Token: b2e3f5f24b69dad11a89e9fdada9dd695a1e8f965a3f33248ea41ae6ca46c0d3a2ea38233fe9b6cedeaa9067ee89bb87981d0988bd688e8b8056640c86350b6f" \
-H "Client-Request-Id: 17" \
-X PUT "/api/v2/accounts"
Example of request parameters
{"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"}}
Request
PUT
/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, CertificateNotFound
|
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 Request Authorization
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
TokenMissing | 400 | This request cannot be performed without Access_Token header. |
AuthorizationMissing | 401 | Authorization header is missing. |
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. |
CertificateNotFound | 404 | Certificate has no permissions. |
ActionNotAllowed | 406 | You're not allowed to perform this action. This might be a configuration problem or parameters incompatibility. |
AccessExceeded | 429 | Exceeded the number of automatic requests for this action. |
AccessExceeded | 429 | Exceeded the number of automatic requests for this action. |
Transactions
Returns transactions for a specific account. This endpoint should be called after refreshing PSU data on Salt Edge side.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6MTY1fSwiZXhwIjoxNzE0ODg0NDUwfQ.M_3UPDSQk8Zt3YrDyXLI3R2S7asyh_vY5FSEVd1WHzDsj91UG0aezAqh1biVnBF_pEBAxp7TkzccHpa192-jJ5-NyB9JxSKjQBlwJmvmZ33kmZGWFTqIncJhpkp1jJaWeoWbNw09h1955AFjnN4GDrqyo3KvSV6aoa9j67Kydvy9LEKKlCrQJ-IGowxO483r2HvIJQQCjf65yqjzFL_S-TtvAtuM8p6PAyut2BJyTUgu89x5SnrHjnWvC9AnHvqBK_XtPRB0bIQmvLB0_sas34GrSWdkjRQrcA3bXiVXXYp2PFZEvZWHoq-yCAefrb4_PRFmsV5BWtJf7HOf6M6xTg" \
-H "App-Id: 1aeKgOrMn24XdsU8K5vgNw" \
-H "App-Secret: YTYP2gAUWcXW3l9wvtMT6w" \
-H "Access-Token: cf3f53fd0422519c4259cbbad9cdd556a5e6e03618a474431823e394b6f1204c98a46609f0606e8920a153665175739cc0174f721b263aeb0838f1a1afef8d3e" \
-H "Client-Request-Id: 17" \
-X GET "/api/v2/accounts/:account_id/transactions"
Example of request parameters
{"data":{"per_page":50,"from_id":165},"exp":1574093211}
Example of response
{"meta":{"time":"2019-11-18T16:04:51.253Z","next_id":1055},"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"}]}
Request
GET
/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, CertificateNotFound
|
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 Request Authorization
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
TokenMissing | 400 | This request cannot be performed without Access_Token header. |
AuthorizationMissing | 401 | Authorization header is missing. |
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. |
CertificateNotFound | 404 | Certificate has no permissions. |