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.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6NjY1fSwiZXhwIjoxNzQ3MTcwNzM1LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.l8RZRouaJvFtGt5Lb2xPtI5lh3d49fiSfaD9TGZkKwLSAoHbC2jWR8lfB9bcKxVEaUp-xo3khbxjdJnhLNGGg3RNLjJ1ftEfMgvIL-MYUNwGE9Epl0hxpBQV3LHqUStaSEkm4zFx-xcKoRxeHOoFLxBOZDgWFkQDHhP1LIpiJn0b9mRwazQ2NeMbvTk0zyjBtavNV6EJM2audR-PNs-yoiEbbh3TdM8MFdSfZOp44zwT7mzY1u9-ulazTuIar95y0aiqgYJfUAkdHHStSltv05MmcWXgDT93Cofm4Voi31S69r391wqwX_mIVuGymH9dXJ8Aw8iQ0YKQvXTXG4q_UA" \
-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. |
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. |
TokenNotFound | 404 | Token specified in request does not exist or cannot be retrieved. |
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.eyJkYXRhIjp7fSwiZXhwIjoxNzQ3MTcwNzM1LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.Hsk_MtAB201VqBRf0tiYTWEl4Fe3-smIae0-SQMJr8nGL5-9CMpNsvaXMeOfjnB1VljEX0lh-V26r39EorXEeh3a6BJMlTzu4M2J8cTRQAPVYQ0OcZGZVv2N0NEWTSgQCa-8qWiQRa5AqeXG90ROGzOLfBoDCOmofhS1JTdY9WKwnHI4Ihw3kLit-ViZmms5ZpwGNXQU6DGhwg5rE04l1wscOSf4A-55deEpRnuzVBOGyB--tZpVVD2zsG1P1U8MGP2M1FADIcW5ZennXb_3Qs3juHVNkxm4f8_uqV4vcPW6dMlqkdV9X6WJ9zWlavBWiPZ-K66_USbYO44Tajvrkg" \
-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. |
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. |
TokenNotFound | 404 | Token specified in request does not exist or cannot be retrieved. |
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.eyJkYXRhIjp7ImZyb21fZGF0ZSI6IjIwMTktMDgtMTgiLCJ0b19kYXRlIjoiMjAxOS0xMS0xOCIsImluaXRpYXRlZF9ieV9jdXN0b21lciI6ZmFsc2UsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSJ9LCJleHAiOjE3NDcxNzA3MzYsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.Q18Njw47pOww9v3Rrwql08Cg-P9-WpChe0UElPzm0ekRIxpubECYjQoLf3-t0-STvyGemc2tBf2CZnEsvLYgu0ZddjqbPRwo4jeqiM-aVU-8gtz-R7mtncWCcxmb8j-FL7nf6EgXSPXzWKT8gJSdT7U3vuOusE8IM0WITqQEw_bt_WIhwt-OjQHrqD680A7azDXPEO0EsFmL7OtSZXSvqtb2EqeB3Hsfj-hmBkuxhDCTUhhkX6RCvd44rfA-cydOVReOEe1r4mKfeirUDlyaCuTuwx0SSAMi-rvY5eSymKGTZDrjEsnEdeZof9xW8W_PaiIyVb49GzgcwihlR3IZtA" \
-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. |
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. |
TokenNotFound | 404 | Token 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. |
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.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6MTY1fSwiZXhwIjoxNzQ3MTcwNzM2LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.Kwofs-ybs9LyMnSRRoTUKNmHwzu7zUqY0Ae6T_qnHjJeAQy-bIIWiIlh3XqZlG_AFLp6W3m-kLPEJRetqzJ2LHRwtvS5lSyIVIhOCbBm1hNYqNI0JRF2_pGDEIYZI-gYoe01r7H0D7F-M2S0U7pk-mtFS01UejnOMv-iEyy6mp67JuqojoQUPpp3hLn0xMOOMjFsZIV48eD5Xi5rGOLIg8tuqp_r-wMVi6V0QefPckadNrEJqUYidh2olM1lEAXHQH2SwMPvv7nV52KBDfwtkamSOpp5_pxjlZDr9maLZYFu0luB-oaUqgFy2q3Ngq_MMjGq7C8z3xy29WBq0gB3rg" \
-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. |
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. |
TokenNotFound | 404 | Token specified in request does not exist or cannot be retrieved. |