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.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6NjY1fSwiZXhwIjoxNzg3NjA1MzU2LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.FyiK5-DuoaySTA9KXuphebsFsi9__zem8Ys7Qj5U5fQjutCz_Kn9ncF7KVrTTIkkQnhyrUQ2DjNoW0MgADJo1Rr0UlE9lFsEHqytBJUv57lFqniCavf4fGrGtGjAy9QjgjXcx_8jFICHp0xe03iIa5gKNvQxYDBxspWhdvjF1-4WWBP0T8nxsVO-n2aY-p6c0Hx7FmW23P3uJmICWAVJPoA0LlOt73FtNBfQNILhZWJoRwD4CZRBfgLe5Gm20rCFToCy3DQ3V7t0cwvyKUTcw-KlTGS3A8kT8lJdYhtBNkoz3ORaZKFCznoj0797cc6pPQ_7B7H7oe0fCwuUD6jTGw" \ -H "App-Id: hdxOnJzz7tUdwso5TeGIOQ" \ -H "App-Secret: mQdTa13N7SoBsmnoHok0mQ" \ -H "Access-Token: 0bd6a34ce608515b9ce2c2afae5d52fa047aaa07c10563b9e7ef4e786faf935f29d255858fac37d314bef7d24651ddebe60cb4342d98e0feaee5ca010c500c04" \ -H "Client-Request-Id: 34" \ -X GET "/api/v2/accounts/all"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6NjY1fSwiZXhwIjoxNzg3NjA1MzU2LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.FyiK5-DuoaySTA9KXuphebsFsi9__zem8Ys7Qj5U5fQjutCz_Kn9ncF7KVrTTIkkQnhyrUQ2DjNoW0MgADJo1Rr0UlE9lFsEHqytBJUv57lFqniCavf4fGrGtGjAy9QjgjXcx_8jFICHp0xe03iIa5gKNvQxYDBxspWhdvjF1-4WWBP0T8nxsVO-n2aY-p6c0Hx7FmW23P3uJmICWAVJPoA0LlOt73FtNBfQNILhZWJoRwD4CZRBfgLe5Gm20rCFToCy3DQ3V7t0cwvyKUTcw-KlTGS3A8kT8lJdYhtBNkoz3ORaZKFCznoj0797cc6pPQ_7B7H7oe0fCwuUD6jTGw" \ 
 -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

data

object, required

Wrapper for the data.

per_page

integer, optional

Number of accounts that should be returned per request. Values in range between: 1 and 1000 Default value: 20

from_id

integer, optional

Return all accounts starting with a specific id. Values greater than: 0

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.

data

array, required

Wrapper for the data.

updated_at

datetime, required

Datetime of last account update on Salt Edge PSD2 Compliance side.

created_at

datetime, required

Datetime of account creation on Salt Edge PSD2 Compliance side.

payment_account

boolean, required

Specifies whether account can be used to initiate payments. Allowed values: true, false

extra

object, optional

Any extra information related to an account. Default value: {}

provider_account_id

string, required

ID that uniquely identifies this account in provider’s system.

status

string, required

Conveys current status of the operation. Allowed values: active, inactive

available_amount

float, optional

Physically available funds.

balance

float, optional

Account balance.

currency_code

string, required

Account currency code in ISO 4217.

swift_code

string, optional

Business Identifier Code.

sort_code

string, optional

Used to identify bank accounts in United Kingdom and Ireland.

number

string, optional

Account number identifier within Bank.

iban

string, optional

International Bank Account Number.

nature

string, required

Account nature. Allowed values: account, card, debit_card, credit_card, checking, savings, investment, bonus, loan, credit, insurance, ewallet, mortgage

name

string, required

Human readable account name.

string, required

Account identifier on Salt Edge PSD2 Compliance Solution.

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.eyJkYXRhIjp7fSwiZXhwIjoxNzg3NjA1MzU3LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.kRAJU__Bf89cWs_KTPK7Ghh8bDIQ7zyfQ5vFJ7POt8mdJkcrF1G29qftTX5ZrWC2vlCqz-4fWG2tFxEvxbekvXFVVYcyFhf8jehlppcGiGv0JtS0pWNNykj-9a1AnBBCD0kAFy0ywuSCpml7mprFoXX05uScvycN8DeSYjrvBy5PMhPm4GtgrXuSfxo6Wmexim15E0I_C6rUvrFrgfCJC2Rd7IaJDinCQemIyK5Bt2m-kx-2Hoe5-VCakbySUFIx4p3x7kYBr8jM0OR1-GDLpi6C0eUm9nfHlmiATBIYmFnm5TvrkDhJ6Y_pwwUV7J3Mi7squ0IM_AFZ-3AEXGuKfg" \ -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"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzg3NjA1MzU3LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.kRAJU__Bf89cWs_KTPK7Ghh8bDIQ7zyfQ5vFJ7POt8mdJkcrF1G29qftTX5ZrWC2vlCqz-4fWG2tFxEvxbekvXFVVYcyFhf8jehlppcGiGv0JtS0pWNNykj-9a1AnBBCD0kAFy0ywuSCpml7mprFoXX05uScvycN8DeSYjrvBy5PMhPm4GtgrXuSfxo6Wmexim15E0I_C6rUvrFrgfCJC2Rd7IaJDinCQemIyK5Bt2m-kx-2Hoe5-VCakbySUFIx4p3x7kYBr8jM0OR1-GDLpi6C0eUm9nfHlmiATBIYmFnm5TvrkDhJ6Y_pwwUV7J3Mi7squ0IM_AFZ-3AEXGuKfg" \ 
 -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

data

object, required

Wrapper for the data.

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.

data

object, required

Wrapper for the data.

name

string, optional

PSU name.

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.eyJkYXRhIjp7ImZyb21fZGF0ZSI6IjIwMTktMDgtMTgiLCJ0b19kYXRlIjoiMjAxOS0xMS0xOCIsImluaXRpYXRlZF9ieV9jdXN0b21lciI6ZmFsc2UsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSJ9LCJleHAiOjE3ODc2MDUzNTcsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.jzDIO5sHeviT04Ozw8ZhmnLoZqw-lhr6We4jD-0wweBafBUYV7iCHJrOqPVZ7kv4faE_yOk0md8jC04dVOtcpnTsUGUISrT9bBK9HC-FcyToCNLPfar_PTIxdNp-8IAV53qNNWsmUgwVB0yQay_CEFyVVd5zJsv0zxLH-Sb9v9adBF_Zo0UvQiIN_cyZBtLP3W1_afDfXPWVGYDsY0v8ERDx81zf-gIrgN4qc0oY-b0Sn0CGK3sfquqMyMI7avA0J0heaPz2HQCmDPfTmGJNK9Z2toV1e_LXwzm9JCcukHvMiGwObXnmeX9lzO0yaJe3Tz7c0ruXTo_YUU_j3arFbw" \ -H "App-Id: UJbEee74CaUNMzrvzfAtUQ" \ -H "App-Secret: B_oeBL7GIK9jPxzQSrmlLQ" \ -H "Access-Token: b2e3f5f24b69dad11a89e9fdada9dd695a1e8f965a3f33248ea41ae6ca46c0d3a2ea38233fe9b6cedeaa9067ee89bb87981d0988bd688e8b8056640c86350b6f" \ -H "Client-Request-Id: 17" \ -X PUT "/api/v2/accounts"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImZyb21fZGF0ZSI6IjIwMTktMDgtMTgiLCJ0b19kYXRlIjoiMjAxOS0xMS0xOCIsImluaXRpYXRlZF9ieV9jdXN0b21lciI6ZmFsc2UsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSJ9LCJleHAiOjE3ODc2MDUzNTcsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.jzDIO5sHeviT04Ozw8ZhmnLoZqw-lhr6We4jD-0wweBafBUYV7iCHJrOqPVZ7kv4faE_yOk0md8jC04dVOtcpnTsUGUISrT9bBK9HC-FcyToCNLPfar_PTIxdNp-8IAV53qNNWsmUgwVB0yQay_CEFyVVd5zJsv0zxLH-Sb9v9adBF_Zo0UvQiIN_cyZBtLP3W1_afDfXPWVGYDsY0v8ERDx81zf-gIrgN4qc0oY-b0Sn0CGK3sfquqMyMI7avA0J0heaPz2HQCmDPfTmGJNK9Z2toV1e_LXwzm9JCcukHvMiGwObXnmeX9lzO0yaJe3Tz7c0ruXTo_YUU_j3arFbw" \ 
 -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

data

object, required

Wrapper for the 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.

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.

initiated_by_customer

boolean, optional

Defines whether request was initiated by PSU or automatically. Default value: false Can raise: ActionNotAllowed, AccessExceeded, AccessExceeded

redirect_url

string, optional

The URL on which PSU should be redirected by TPP in order to perform authentication.

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.

data

object, required

Wrapper for the data.

session_secret

string, required

Session identifier in Salt Edge PSD2 Compliance.

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.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6MTY1fSwiZXhwIjoxNzg3NjA1MzU3LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.YPeXIRb9pt4YpgFbz9RLzjXQXaV6iU8TMpabSrT7TPv_APlxyzcwN0ik2yNjzpHsVJQt2dnCnD-oxVdXTZr6vFadWX7Rd_rPxcFoTdb7XTM7LDIxr6AI7Cx4-PYdp8gIDE6ra2QHHfPyUJ2XZCjSJsSR5a_ESQW1q4gbyvOnRT1P4Jx7kS49_ramnme4xdmUMIDuuIyaC6Ab50C7m9C8Uo0uH0PYKpu4c6rcrmUDEpzbb68Hk6KMei5AuFzjk54HLJ-Su2aeQsJqlHyA_zGJ-C_Qisugl2jLFhw77xUWva8Z6MJ1uz34NvnVYwczPwbh-CKUQKyBifI8hrngXo-Htg" \ -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"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBlcl9wYWdlIjo1MCwiZnJvbV9pZCI6MTY1fSwiZXhwIjoxNzg3NjA1MzU3LCJpc3MiOiJwcmlvcmEuc2FsdGVkZ2UuY29tIn0.YPeXIRb9pt4YpgFbz9RLzjXQXaV6iU8TMpabSrT7TPv_APlxyzcwN0ik2yNjzpHsVJQt2dnCnD-oxVdXTZr6vFadWX7Rd_rPxcFoTdb7XTM7LDIxr6AI7Cx4-PYdp8gIDE6ra2QHHfPyUJ2XZCjSJsSR5a_ESQW1q4gbyvOnRT1P4Jx7kS49_ramnme4xdmUMIDuuIyaC6Ab50C7m9C8Uo0uH0PYKpu4c6rcrmUDEpzbb68Hk6KMei5AuFzjk54HLJ-Su2aeQsJqlHyA_zGJ-C_Qisugl2jLFhw77xUWva8Z6MJ1uz34NvnVYwczPwbh-CKUQKyBifI8hrngXo-Htg" \ 
 -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

data

object, required

Wrapper for the data.

per_page

integer, optional

Number of transactions that should be returned per request. Values in range between: 1 and 1000 Default value: 20

from_id

integer, optional

Return transactions starting with a specific id. Values greater than: 0

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

account_id (path)

integer, required

Account identifier on Salt Edge PSD2 Compliance Solution. Can raise: AccountNotFound

Response

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

data

array, required

Wrapper for the data.

updated_at

datetime, required

Datetime of transaction update on Salt Edge PSD2 Compliance side.

created_at

datetime, required

Datetime of transaction creation on Salt Edge PSD2 Compliance side.

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.