Salt Edge PSD2 Compliance Logo

V1

Tokens

These endpoints are responsible for implementing authentication and authorization of PSU. Process of token creation starts once PSU grants his consent to TPP. At the end of authorization, Connector should issue an access_token which can be used for furhter actions. You can find below sequence diagrams represeting embedded and oauth authorization flows.

Embedded Authentication Flow Embedded Authentication Flow
OAuth Authentication Flow OAuth Authentication Flow

Create

Create an access token with a set of access rights, named scopes. As a result, Connector should send an update or fail 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 eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImFwcF9uYW1lIjoiRXhhbXBsZSBOYW1lIiwicHJvdmlkZXJfY29kZSI6ImRlbW9iYW5rIiwib3JpZ2luYWxfcmVxdWVzdCI6eyJjbGllbnRfand0IjoiQmVhcmVyIGV5SjBlWEFpT2lKS1YxUWlMQ0poYkdjaU9pSlNVekkxTmlKOS5leUprWVhSaElqcDdJbkJ5YjNacFpHVnlYMk52WkdVaU9pSmtaVzF2WW1GdWF5SXNJbk5qYjNCbGN5STZXeUpoWTJOdmRXNTBjeUlzSW5SeVlXNXpZV04wYVc5dWN5SXNJbXQ1WXlJc0luQmhlVzFsYm5Seklpd2lablZ1WkhOZllYWmhhV3hoWW1sc2FYUjVJaXdpZEhKMWMzUmxaRjlpWlc1bFptbGphV0Z5YVdWeklsMHNJbU52Ym5ObGJuUmZjR1Z5YVc5a1gyUmhlWE1pT2prd0xDSm1iM0pqWlY5elkyRWlPbVpoYkhObExDSmpjbVZrWlc1MGFXRnNjeUk2ZXlKMGVYQmxJam9pYjJGMWRHZ2lMQ0poZFhSb2IzSnBlbUYwYVc5dVgzUjVjR1VpT2lKUVUwUmZRVWxUVUNKOUxDSnlaV1JwY21WamRGOTFjbXdpT2lKb2RIUndjem92TDNWelpYSXVkMmxzYkM1aVpTOXlaV1JwY21WamRHVmtMMmhsY21VaWZTd2laWGh3SWpveE5UYzBNRGt6TWpFd2ZRLk9lNFdIaFVyaFE0cHNmc2hUR2kzeWEyanRJTEJIY1EwSDZFYlktbjlIdWx3YjI4UVhDTm9kLUN5MlVLYlNEZjRxX2hrckdyQm5TeGd5SWhEQzNXbThNYkRSQ0tFRlFtci1LTko4M3ZYTnJSd29seVRZdUR3MGxJVHBySVFYU1pwel8xdWd2R0NnN2tnSEIzSlV0M0puQ2dNTzVlTGtZenpmUmN6V2NnNnNwdXpCWUk0Qi1yNHEwajFCOXp6Y0RKQmYxZkg1aWdaMW5QYm9FR21RUmJyc1hlMkNIWnEwT1BGSUNNbkNrR1pTdkRJbkNHdXVRMGtEUnhVNnZ4VF9WMFNNRWRHUk9SVmtZQnk2WEJ3aU1VdWFQM3JrWXF0NmN2c2pUeVZEd256N214OVF1T3JBSERtOXVVNHRWMnBGQ2dYdXpLdzlSQXBreFZETi1OUG9RaEl1ZyIsImNsaWVudF9wYXlsb2FkIjp7ImRhdGEiOnsiY3JlZGVudGlhbHMiOnsiYXV0aG9yaXphdGlvbl90eXBlIjoib2F1dGgifSwicHJvdmlkZXJfY29kZSI6ImRlbW9iYW5rIiwicmVkaXJlY3RfdXJsIjoiaHR0cHM6Ly91c2VyLndpbGwuYmUvcmVkaXJlY3RlZC9oZXJlIiwic2NvcGVzIjpbImFjY291bnRzIiwidHJhbnNhY3Rpb25zIiwia3ljIiwicGF5bWVudHMiLCJmdW5kc19hdmFpbGFiaWxpdHkiLCJ0cnVzdGVkX2JlbmVmaWNpYXJpZXMiXSwiY29uc2VudF9wZXJpb2RfZGF5cyI6OTB9LCJleHAiOjE1NzQwOTMyMTB9fSwic2Vzc2lvbl9zZWNyZXQiOiJiN2stUXhDM3ZkQS1NNDhwZXhpUyJ9LCJleHAiOjE3MTQ3MzE5MTF9.TQGaWhfbBiSWFN0sNXTxAM1I9F40oE0OBkBw-ji6vnGsyDL8x29tvGQV4uKXt34kHEUafDMnFSmahf8ot-4gjge4sghYLQkBSh8fdR71PphgwxyI8VZUSu-jSKW7VZ-c4tgqp45jlsRbvr79FA108Mj_ax-xBfO__xfwws5eWvjOVG2WTeLwn2RXI6cq5c1udvS5Dj7L-0eZimJPXaOjGNDOQEDzHwQxGf9g0ZYkive83nbCUY6ne2JP8hyBITIvQbDhW1yhl4PJqkB2P351EolQg2bpl10DSgdGZwwgJToTrFOzUUp2C4BTGbAE_yKFc1K-k_s1FX9loRjmUClKxA" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 771" \ 
 -X POST "https://your.connector.url/api/priora/v1/tokens/create"

Example of request parameters

Request

POST https://your.connector.url/api/priora/v1/tokens/create

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.
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.


Revoke

Revoke an already existing and active access token.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInNlc3Npb25fc2VjcmV0IjoiaDI5Yzk0MVBRNF9rNl82UG4tbzUifSwiZXhwIjoxNzE0NzMxOTExfQ.rNAMFGZk18Khk9m2Rsvxj47H_6rmnZyfqIPNaEo3S8H3I53cLX7QqdPP0OrSLsJy0bIue4Nwf-qdXefQ6j5h5VEfjO95s9ZsTIakHeCDaiGhLnr9Q0JY9tYqnAh7F7Y7AQD78WRm9mCU8WcyDOYSdQzTWBgeGY9PHwHhDtcjGrqO8URTTt_7aDLXusdmscUSfDFNDwrR6sRnlHzcadkSF4MPjIiRJN1idIBf1aYbIR4WsQzGx8zXa7bZFqRFPpjyMerRMqxWzcUw-GF4qk0f03zwz_VJl9vKm0dcVpjqGLISsL1cZ32VpOpWc2UxHDJYXaivYFr4jw-4i0RZQdZ6_Q" \ 
 -H "Access-Token: 65adc909f5676f3902787ecb6f379c1c48bfc18a222157713808274b100b9e255f7b4b59a3ecd7689cb2abe26f8705dfd89b7a0cc9e9a07a587dc64a7c4572ad" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 843" \ 
 -X POST "https://your.connector.url/api/priora/v1/tokens/revoke"

Example of request parameters

{"data":{"provider_code":"demobank","session_secret":"h29c941PQ4_k6_6Pn-o5"},"exp":1574093209}
Request

POST https://your.connector.url/api/priora/v1/tokens/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.
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.


Reconnect Deprecated

This endpoint is invoked when a TPP asks to refresh an active token. ASPSP should determine behavior for this action: ASPSP can just return a new token sending it into session/success endpoint, ask for MFA using sessions/update endpoint or just deny using sessions/fail endpoint.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInNlc3Npb25fc2VjcmV0IjoieVU5VzYtQnU5dHpZTjJHWGlFckYifSwiZXhwIjoxNzE0NzMxOTEyfQ.uWMmeN8CExQBAC6Mh2DMQI6sPbEO8eJPyEsEYYbuylex1HJMdNBBZRkOLc4JLvZ_ZQ7DMpk_fc2a-ePGEqK-y2Ru8J2tTCzyGLqPUwrOTwGnnS6grSK1aKk_fAw8Qmb5E5W4z5y5itgKnJsadMHJFD64Z3QKIY8I3Uv_9MQlf4BNzfVhgMrxJoJ53kl8GM8KQq1JkkVe4VmtZPEvj3chiLpgQOw6sbdqOyrQQrDvHMbmrH1dex8B6ftL6IFWgGbTvx2pMWN2yhGWtBfo7LPLNF-PmyTJj-fhBHrxBr8PAnE5T6W5UzJqYEbe8TXfwcWNA_2HJ2DNMest9X1bRj9FfQ" \ 
 -H "Access-Token: b8a2d37ea0ed40716deebb7c5fff81ce096c87141d45ef39cc7c4b2c455b09c8e338c1190267ab1bf56ffa6840662e2f3d3967a13985d0e0bd777059814e6954" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 718" \ 
 -X POST "https://your.connector.url/api/priora/v1/tokens/reconnect"

Example of request parameters

{"data":{"provider_code":"demobank","session_secret":"yU9W6-Bu9tzYN2GXiErF"},"exp":1574093210}
Request

POST https://your.connector.url/api/priora/v1/tokens/reconnect

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.
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.


Confirm

This endpoint is used for processing additional interactive steps in the process of access token creation. As a result, Connector should send a success or fail callback to Salt Edge PSD2 Compliance with result of the operation.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0Ijoic2NfZkt0VHRvSGM5SGtKc3R5ZnciLCJwcm92aWRlcl9jb2RlIjoiZGVtb2JhbmsiLCJvcmlnaW5hbF9yZXF1ZXN0Ijp7ImNsaWVudF9qd3QiOiJCZWFyZXIgZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SmtZWFJoSWpwN0ltTnlaV1JsYm5ScFlXeHpJanA3SW5SNWNHVWlPaUp2WVhWMGFDSjlmU3dpWlhod0lqb3hOVGMwTURrek1qQTVmUS5IYUoyWksxVlZvUXJoUkZsSVBaTk01dzRtajhQVG9sT3BBbHJFRU9UY2VGSWFrYzQ1blFMd1BpUkNyUE9OQWl6blRJMTI1MEVkb01Vd1JmYVd6MUFRMEZBdi1Xc1dmb3ltTjNiaVljWlpwNEZlQXJMVzgyd3pzREZXVTlWV1VIU0h4MnpMX0k3dnZWaGxKY1BiX3R6SVJWcVJSTFRNTnp2SjJPX1hYZ0hPeG1TQXF6Q3B1UTdBVUV6QTVZdUQxWjgxZDVPcTMtNzNmMGRjenc1Nnk2cTV4blY4NnJuZ2s5M1FpYTdGR3oyRi1HY3dJbld6R0lsV2dtUXQxYk13SHltNnJ1RVVzeUxOZ09LanVObnFGaEtwOTh2V1FpaFFuVlZBdmU3bGNoUG9rWWFYMklGU0k4Z2FkT2FTZ1dyQ2FvMngySU1qQkZxMHZvaFYxQnFZbEVLYVEiLCJjbGllbnRfcGF5bG9hZCI6eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InNtc19waW5jb2RlIjoiNDg5NiJ9fSwiZXhwIjoxNTc0MDkzMjA5fX19LCJleHAiOjE3MTQ3MzE5MTJ9.f6DM9qoz4Bn1ErXCfbzHBq3WAdDPPXEpmUf1jwfvlbys5sHgtPJcRU35S7ZmvPF_mQSJVco5exiiZCR69AsLTeSi0Dc1SyzOxOUkJ8u0sky2fz5Lqil7KxAw215mV1dNW_hmVCI0ehAmR7Dn_URVOPqIozuBkCIhVjoc4BrZO6fey5gM0xYSBTkYU8JUYHf0RrIg1txxWiVdxtjwwnpstIDSkHiMB81ULf-IcR6GAoRE-2gdprvS0IE4OU-0yuJPj7eZo2wL6saqbBBSEqDBv-S3cblybA5ZxKcYEi-5izNpZAPdrF-bdMmdiloPhlhsT2dcPygBGMGxLrXgmOAjfA" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 501" \ 
 -X POST "https://your.connector.url/api/priora/v1/tokens/confirm"

Example of request parameters

{"data":{"session_secret":"sc_fKtTtoHc9HkJstyfw","provider_code":"demobank","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InR5cGUiOiJvYXV0aCJ9fSwiZXhwIjoxNTc0MDkzMjA5fQ.HaJ2ZK1VVoQrhRFlIPZNM5w4mj8PTolOpAlrEEOTceFIakc45nQLwPiRCrPONAiznTI1250EdoMUwRfaWz1AQ0FAv-WsWfoymN3biYcZZp4FeArLW82wzsDFWU9VWUHSHx2zL_I7vvVhlJcPb_tzIRVqRRLTMNzvJ2O_XXgHOxmSAqzCpuQ7AUEzA5YuD1Z81d5Oq3-73f0dczw56y6q5xnV86rngk93Qia7FGz2F-GcwInWzGIlWgmQt1bMwHym6ruEUsyLNgOKjuNnqFhKp98vWQihQnVVAve7lchPokYaX2IFSI8gadOaSgWrCao2x2IMjBFq0vohV1BqYlEKaQ","client_payload":{"data":{"credentials":{"sms_pincode":"4896"}},"exp":1574093209}}},"exp":1574093209}
Request

POST https://your.connector.url/api/priora/v1/tokens/confirm

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.
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.


Cancel

Cancel any access token that is in the process of enrollment, meaning it has not been confirmed yet.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiZzRmeV9XNHh5YzZUUktzWVNBTXQifSwiZXhwIjoxNzE0NzMxOTEzfQ.iEe8NeNpm5gM6cOgzsTyKUBcZTu0VoFzDZjKIt5bhvelh53_qXVs-gMwAUqHHXqWvR4ekV1FLQnIZIhg7ZzFWIYycNAQ088FrlUZ93_fXGIW-m_EAc7pD12pVPJoIRPHwfJnGW-087q4XlnGRbNFX_BJ8QbtjujFNsfUbssYclhveasAjYEsn_TwFIdd4KQZonpu3oITjHvoOLXgygpScQGZeRa7UjpU6y5n-duOY8vCkM7KmpglJ4eXyFMfk7B88poogC1jgVRghfjgyXCgq-i9NndIAR94reC5tiNugZJMNWo-DZt1y49xJ5Bx5-Q7Hv2FakXxo_kz-j24_gAlqQ" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 830" \ 
 -X POST "https://your.connector.url/api/priora/v1/tokens/cancel"

Example of request parameters

{"data":{"session_secret":"g4fy_W4xyc6TRKsYSAMt"},"exp":1574093209}
Request

POST https://your.connector.url/api/priora/v1/tokens/cancel

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.
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.


Accounts

This endpoint is responsible for fetching account information for Account Information Service.

Accounts Fetch Flow Accounts Fetch Flow

Fetch

Fetch list of accounts belonging to a PSU and all relevant information about them. Accounts available for making payments will be flagged accordingly.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiY3ppYVRYZ0JhQ1llckVIRHZXRTkifSwiZXhwIjoxNzE0NzMxOTEzfQ.I0nBAD1oZ9axyZSDA-sz-l7j_sVzL_lAOI8MUDyM5ARkRhc3FsTejvA6nG9QEthYTjp0TxY4Onj3EHTOfA_BSi4lhEpNL2izSFvu6Ed-R2QQ62c7pIDAuCLrywbWLytMe0DJvUSBUnogC8eCmlyo2LemCh0m423Q6tPH4BISoPuwjyzZuAqozTKtnl0zBNhaQPYkhjIsh3VDw4JKpOY5f_RETu4s0Aa4IafW1_Qe2vA9dUi2AX2C0u5pqM0tz8hlCYe6dGancoNSFHvSc8Rxf2umoQexUgWNMoLYK3wOfSIkgKpi6-HFfLNCOXgqjWmJwNrT8WAWXbzUDqxbDxmnFQ" \ 
 -H "Access-Token: e4649d535f5e3125bcc939e2f3b33a070127be520e2f1134ed8722976703e0b32d9354fb147014103ce39f6eed428ac65d82659b6289901449c73d12d939c28f" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 765" \ 
 -X GET "https://your.connector.url/api/priora/v1/accounts"

Example of request parameters

{"data":{"session_secret":"cziaTXgBaCYerEHDvWE9"},"exp":1574093209}

Example of response

{"data":[{"id":"724","name":"Example Name","iban":"FK54RAND61068421435452","currency_code":"USD","extra":{},"number":"619656558","sort_code":"82-78-66","swift_code":"TBNFFR23PAR","nature":"credit","payment_account":false,"balance":"5000.00","available_amount":"4995.00","credit_limit":"7000","status":"active"}]}
Request

GET https://your.connector.url/api/priora/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.
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.


Refresh

In case the connector uses a different database from Core Banking, this endpoint enables the process of refreshing accounts and transactions on connector side before sending them to Salt Edge PSD2 Compliance Solution.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoieGRzUHNMd19lUkw2Tko4bTIzR2UiLCJmcm9tX2RhdGUiOiIyMDE5LTA4LTE4IiwidG9fZGF0ZSI6IjIwMTktMTEtMTgifSwiZXhwIjoxNzE0NzMxOTE0fQ.KiuahbRa4OktxukOCe7aS3nRsgioBiiCh8XCrHbcWEQLB1jJQui0SRL_T952W2bNqgyN0MzqgXN4l9HjPc78K6KcuhnkiIi5pR5QEjvsdne_r03Ek2mkElGsjF7t13dDqyneIDwAoeYy3q5RvEiSonpkMQsOWCvhigtwKC6MDkL31W0035Yau6U9YaFlr9OylQgMvqSQPQGX-hzc5xLh6uFHCjiC0nlaz55k0I4XcCY22J1OkJ_kki0fOZgn4FTTKiXh3lSTS5fMT1l-f6TXRKIIR4jgilQJU-d6G0XCrsDMl4v4Sqpv9iG87rdUDFWrhHumOm37TCinMMb3ZampBA" \ 
 -H "Access-Token: 4fd12e851a9ed70420c3b2e8d5471ae56438e0875ba521c02bff802a176f4c99bebda2e3516e644fc99e37facf0c02e52836fefedcfc2dc9a44d993218bcda70" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 786" \ 
 -X PUT "https://your.connector.url/api/priora/v1/accounts"

Example of request parameters

Request

PUT https://your.connector.url/api/priora/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.
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.


Confirm

This endpoint is used for processing additional interactive steps in the process of accounts refresh. As a result, Connector should send a success or fail callback to Salt Edge PSD2 Compliance with result of the operation.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoieGtlVE53UjNHSEgzY0hjcTNVQ3QiLCJwcm92aWRlcl9jb2RlIjoiZGVtb2JhbmsiLCJvcmlnaW5hbF9yZXF1ZXN0Ijp7ImNsaWVudF9qd3QiOiJCZWFyZXIgZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SmtZWFJoSWpwN0ltTnlaV1JsYm5ScFlXeHpJanA3SW5OdGMxOXdhVzVqYjJSbElqb2lORFUyT0NKOWZTd2laWGh3SWpveE5UZ3pNalF5TnpZMGZRLlZPaGE4Rm13MTBQUkFoNjZHN3JwaVdWZS1ldEdYOVZGTzFjM185WFhRa2VtRGItS2N5STBMT2htM2xvd0c0MzJ6XzFnTzV6Z1p3cDdpVXdRQWVBTmk0aXJzU0MtOWNPQ01NdTNRY2RCU28zRHlpU2xLMDZObmRrZUZyYUYzb1puNVVMczF1YzYyVjFCNVJFRkJBS0NQaVNaeHQ4UWp0WWFWc3U4dGdYVFZ6N2FYMnNtNlZHOGJuSHp2cEdNcWt4LXQtclJEQ1lYTGlnTlpCR1hRTmhlTUE3RG1ERS14QzlEMzE3OWh6bUZpbGtVYktxYlgxOV93YnEzZFNaRk9SU2t3MHQ4bW1IeEwxV21lWFpTcm9OOXkzQmQwek9VQ3NjdGZUaXl1TzZsd05mYlhoZW5qcEJsdGM4dzEyZmRFU192cTVvOG56SDh0QzBJSnFQRFdYaFI4QSIsImNsaWVudF9wYXlsb2FkIjp7ImRhdGEiOnsiY3JlZGVudGlhbHMiOnsic21zX3BpbmNvZGUiOiI0NTY4In19LCJleHAiOjE1NzQwOTMyMTB9fX0sImV4cCI6MTcxNDczMTkxNH0.AwBHesXxHWvL9bb5RVEsSB27TScHHGkd8fxHEfRPfZe8bWaAUd0VNWPSdRoE9o2fjnQoao2PkeOX6WMKVZijFnUzNpU0TnSs1FkDZwHtOWbzt0xVcdO5RvM0e7UjmVbpqHaKb4IE2tNqVj8fE7TmN6uxlGcY4EqeTVT9WWAlTh2kypxAOr2cxItuMHw5tFN2lDusvCczUPvLCO4vlJDFfuwJ9ds2NgDkYdH0AulxPJuLnP9T4rnPevCyrokk34ZTP5UChua-DsTmJeljtzZkO7-4cyjVk6iHKzVFmMW-qTHWPPte6jDXhU1oeFagaujN3mbz1xPjbdlk0vryetz_Zg" \ 
 -H "Access-Token: 65adc909f5676f3902787ecb6f379c1c48bfc18a222157713808274b100b9e255f7b4b59a3ecd7689cb2abe26f8705dfd89b7a0cc9e9a07a587dc64a7c4572ad" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 843" \ 
 -X POST "https://your.connector.url/api/priora/v1/accounts/confirm"

Example of request parameters

{"data":{"session_secret":"xkeTNwR3GHH3cHcq3UCt","provider_code":"demobank","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InNtc19waW5jb2RlIjoiNDU2OCJ9fSwiZXhwIjoxNTgzMjQyNzY0fQ.VOha8Fmw10PRAh66G7rpiWVe-etGX9VFO1c3_9XXQkemDb-KcyI0LOhm3lowG432z_1gO5zgZwp7iUwQAeANi4irsSC-9cOCMMu3QcdBSo3DyiSlK06NndkeFraF3oZn5ULs1uc62V1B5REFBAKCPiSZxt8QjtYaVsu8tgXTVz7aX2sm6VG8bnHzvpGMqkx-t-rRDCYXLigNZBGXQNheMA7DmDE-xC9D3179hzmFilkUbKqbX19_wbq3dSZFORSkw0t8mmHxL1WmeXZSroN9y3Bd0zOUCsctfTiyuO6lwNfbXhenjpBltc8w12fdES_vq5o8nzH8tC0IJqPDWXhR8A","client_payload":{"data":{"credentials":{"sms_pincode":"4568"}},"exp":1574093210}}},"exp":1574093210}
Request

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

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.
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.


Transactions

This endpoint is responsible for fetching transactions which belong to previously fetched accounts.

Fetch

Fetch all transactions related to a bank account.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoieVBzZXRDeVA3Y0d6bnZiOVNERkMiLCJhY2NvdW50X2lkIjoiODciLCJmcm9tX2RhdGUiOiIyMDE5LTExLTE4VDE2OjA0OjQ5LjU4NVoiLCJ0b19kYXRlIjoiMjAxOS0xMS0xOFQxNjowNDo0OS41ODVaIn0sImV4cCI6MTcxNDczMTkxNX0.GX8bC9nSObykkxJjnZIVgcFEe100Qa1y1XMd11UhqV10DVUxnVNno7F3-eY8_YeExMyhsGquXVjPxl95ZPjrke4Z73OEhrXNwZG_xJw9F3i8AoanXr1jFcRL30whDT1rOqLXT_I3RyQ1Zij1-QeYPXjQ2ZQZixBarwHrldJ2bkBtY6PjDF-oPix8XK95vSSKtgzVKB1jrvXyWgRmhZRJ7rWm0CqmKSxaxm0dUY72Jvl-oF3K2dMFFMnekVIwHHUnlkfnCqX2U0SKFiSFdEmrjO-yoLO0SL49ZJ3pUKCbvblLUy4m_B3_I4onY2M5Bk2EJ235lHDANJE4Ir19PMSVAA" \ 
 -H "Access-Token: 2cab054fa0dfd20d725ef46c533b537701c29d47ebea97893374d4e47714e49e2e331764e4f4a20d5e285dbb08af9566e14a8f597230bca6d9f5b3b2048a71f5" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 866" \ 
 -X GET "https://your.connector.url/api/priora/v1/transactions"

Example of request parameters

{"data":{"session_secret":"yPsetCyP7cGznvb9SDFC","account_id":"87","from_date":"2019-11-18T16:04:49.585Z","to_date":"2019-11-18T16:04:49.585Z"},"exp":1574093209}

Example of response

{"data":[{"id":"378","account_id":"241","amount":"38.85","currency_code":"GBP","description":"Test transaction","made_on":"2019-11-18T16:04:49.573Z","status":"posted","fees":[{}],"extra":{"mcc":"example_data.extra.mcc","original_amount":"38.85","original_currency_code":"GBP"}}]}
Request

GET https://your.connector.url/api/priora/v1/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.
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.


KYC

This endpoint is responsible for fetching personal data of PSU.

Fetch

Extract PSU’s personal data. Response should contain a JSON object representing a PSU.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoieVBzZXRDeVA3Y0d6bnZiOVNERkMifSwiZXhwIjoxNzE0NzMxOTE1fQ.qXpQMKeCNySxe9G9vZqKNKyu6Z4Q3lcN69qyw4SKRdOYjdoHRv7y9YZQE6V8QdIQCfvpX64_c85JI52YiRvk1ctrpAE8MPBKdvdDzxPBdBewYZtJ55UZ6ONX9kwOt-T58czETKcW1TBOwEmzHJ--_cOso-__XCJpPgJD9-T1Z0PKGHJikvzbCNQGyAK8eSGLuaqBor5L1dAzTd6kXb0KMcDBf8nxLSZcgxRuzoBefao4IONV01IwDQf7RXD5qPbIqEkB7-UfKOUcTokenV7h2cE0lDaFsWbXFNr6ARRRgCdqU7rRaELRjFwkDa7Y4xuEz6vxK5f2vBktCoEv3P5qKA" \ 
 -H "Access-Token: 3a0b2f004410dca9713cd484a02bb565292e3945500334798274584c7448e9171d1ec9e3d74392792021a7698c7fdee0df041eccc9706871907686770f47833a" \ 
 -H "Accept: application/json" \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: 552" \ 
 -X GET "https://your.connector.url/api/priora/v1/kyc"

Example of request parameters

{"data":{"session_secret":"yPsetCyP7cGznvb9SDFC"},"exp":1574093209}

Example of response

{"data":{"name":"Example Name"}}
Request

GET https://your.connector.url/api/priora/v1/kyc

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.
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.


Errors

Additional endpoints to be implemented on connector side to improve communication between Salt Edge PSD2 Compliance Solution and Connector.

Notify

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

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InJlcXVlc3QiOnsibWV0aG9kIjoiZGVsZXRlIiwidXJsIjoiaHR0cHM6Ly91c2VyLndpbGwuYmUvcmVkaXJlY3RlZC9oZXJlIiwiaGVhZGVycyI6e319LCJlcnJvciI6eyJlcnJvcl9tZXNzYWdlIjoic29tZXRoaW5nIHdlbnQgd3JvbmciLCJlcnJvcl9jbGFzcyI6IkludGVybmFsUHJvdmlkZXJFcnJvciJ9fSwiZXhwIjoxNzE0NzMxOTE2fQ.tcsftTyX4fDMjXLxdcfjiHAdCHxPmk8ndkqIBzRnrmub3e0vDurg6c-yLZ3FljUxJ7stJnrTPv9vQ7UithSQMzrv5FhnjH-i3srw-8omVbbT0rKnpZ6oRHyN0LUatEpPiq9vfqoyvWOOG0QRshmZKuj2Z_cgqi_4iZsstE-5_FoouC3DU3dgH8AbXbHoIDSTMU90-tqdybBrmrduGy8vuEkeOxCSvsceohLG2x76mEqUvt6SjEU6ooU-pu2h1xrAK_52r-0Kn632T6xZ0AsvEM1kL9TSIcCLXGnqmADHp7Gasp6gN3y_wBgl0j_Ka8TzS7Ek1wsXdn4Z16jGQ1whVA" \ 
 -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/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/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.
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.


Sessions

Success

Success callback should be sent to Salt Edge PSD2 Compliance when all required verification steps have been passed, and therefore access is granted.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiV3VSQ2p1Zlg5b1Z5eW12UFFRaV8iLCJiZW5lZmljaWFyeV9pZCI6IjQ5NCIsImlkZW50aWZpZXJzIjp7fX0sImV4cCI6MTcxNDczMTkxN30.qL-OLBA9bIIbNhVv_xkzEYkcJ3etDfQFsmw0BGj7OeAEvfwe0h_zO2GQETxWv1m99TRm7wIk50d_l9a3IxXlooCAC9Gn1tlYSsKpkFt5M8kXfuxD05iuEiiTrPh5SggD-q3Odz_tbSu2nOqfl8vF4pbEqJrGyluPtSlsh75DnnHOicZI8WvgOL-RRcTel0up-e_oZKO85w1IBT5CVbEs2wxXYz038k-fHn50lgBeKUrDvAKc7nQ2gQnyh2g5VuIF5BeRLWiBvIleZTxiU3OJ0wuhuZZrypS5HPegCQt-x58m-RT-h9M8LF0_UMIjXdGsrj2CfFkfohdCwvVXL_5rBQ" \ 
 -H "App-Id: qjQYP-jCx-8FBsZSgNVzIw" \ 
 -H "App-Secret: -XeeN2UhtdphUGtI-FZpzg" \ 
 -X POST "/api/connectors/v1/sessions/success"

Example of request parameters

Example of response

{"data":{},"meta":{"time":"2019-11-18T16:04:48.773Z"}}
Request

POST /api/connectors/v1/sessions/success

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 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 Authorization
Response

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


data
hash, optional
Wrapper for the data.
Related Errors
Class Code Description
SessionClosed 400 Session specified in request is already closed and cannot be modified.
ConfigurationError 400 Missing configurations in dashboard.
SessionExpired 401 Found session is expired and cannot be processed anymore.
AuthorizationMissing 401 Authorization header is missing.
SessionNotFound 404 Session specified in request does not exist or cannot be retrieved.
ProviderNotFound 404 Provider 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.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Update

Update callback may be accessed multiple times in order to request multiple steps of authorization or to send other updates to Salt Edge PSD2 Compliance session.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiSHMteGM4b3pBV0xrMXh0X3pUNHYiLCJleHRyYSI6e30sInVzZXJfaWQiOiIyNDUiLCJzdGF0dXMiOiJ3YWl0aW5nX2NvbmZpcm1hdGlvbl9jb2RlIiwic2Vzc2lvbl9leHBpcmVzX2F0IjoiMjAyMC0wMy0wMlQxNTozNzozMC45MjRaIn0sImV4cCI6MTcxNDczMTkxN30.BLK4u-YydoZ8grflnYr-J0ZRhu2ov53a3Km1Z__AztDD90oxKB7q_abKn_E9r21Yn0bcLQLM7AH8eW27hc8FLUkbD7JTx04OxMqS2viiX5nCY5LvH4tLaduy3uu-ns1Poo2kvVUChZZsOJkT0xDnP0VeEAss1P9_LpHSzu6y82iwY4zHA3CBSguCb52dRc2gBE69szCr8HJdbtz0eR2X1sOtZFnIu2Eu2Ii2WU9hRW0lpm5ILy3nHYxZk82hOF8b7EJJ5zPjuqX-y79WA-zNdO9p0OFqdS6YDVOoqtwf_5f5XBKsfOV6YFtgWWKQ5sLumtvWqSjkHchhvNAIr2q5AA" \ 
 -H "App-Id: q5QE7Dqlpm1d5weLS5pn7w" \ 
 -H "App-Secret: y8imt1cgG8x2zmBMrF-oxw" \ 
 -X POST "/api/connectors/v1/sessions/update"

Example of request parameters

Example of response

{"data":{},"meta":{"time":"2019-11-18T16:04:48.853Z"}}
Request

POST /api/connectors/v1/sessions/update

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 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 Authorization
Response

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


data
hash, optional
Wrapper for the data.
Related Errors
Class Code Description
SessionClosed 400 Session specified in request is already closed and cannot be modified.
ConfigurationError 400 Missing configurations in dashboard.
SessionExpired 401 Found session is expired and cannot be processed anymore.
AuthorizationMissing 401 Authorization header is missing.
SessionNotFound 404 Session specified in request does not exist or cannot be retrieved.
ProviderNotFound 404 Provider 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.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Fail

Fail callback should be used when authorization process has been compromised for any reason: broken request, invalid credentials, etc.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiM1BRaXB1RFBvV3BhMTFGY1ZFVjYiLCJlcnJvcl9jbGFzcyI6IkludGVybmFsUHJvdmlkZXJFcnJvciIsImVycm9yX21lc3NhZ2UiOiJJbnRlcm5hbCBlcnJvciIsImV4dHJhIjp7fX0sImV4cCI6MTcxNDczMTkxN30.UeO6Zt3lZZgqg4bRJ_85Clt3oa41A1bPANTfYX8_8zdxovaiv_DpzHmSM65-qoYQtvpbslWBE9m3Cnp5D6qd_hOOdraLnHLTQI1UgxY4iOTCnjuUiklAu7fcavjrWMAielNUqJN8THUoZZ1D6GyjHBNKQjnQY5HdR467e60Q_-B23XHkfED3ICZfJECnrUxI12khCIZ9zc_LeFYjQs_k9o8pjBKaTsqNgOtBEtqpSlDYD2045-g2zgJDS8CTK6WskBaTQd73qyd9XmKZgMJoMm80pX7wcNmNzBjC7lh0EJZenEn2ZL7s47EeE1JJxeKrJ0w8Pd1M1363JzbKYmBGbg" \ 
 -H "App-Id: xU7SyhPrd95GAPSMNo_XMQ" \ 
 -H "App-Secret: BVSkESo7zpRdzk_hWUUwCQ" \ 
 -X POST "/api/connectors/v1/sessions/fail"

Example of request parameters

{"data":{"session_secret":"3PQipuDPoWpa11FcVEV6","error_class":"InternalProviderError","error_message":"Internal error","extra":{}},"exp":1574093208}

Example of response

{"data":{},"meta":{"time":"2019-11-18T16:04:48.710Z"}}
Request

POST /api/connectors/v1/sessions/fail

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 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 Authorization
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
hash, optional
Wrapper for the data.
Related Errors
Class Code Description
SessionClosed 400 Session specified in request is already closed and cannot be modified.
ConfigurationError 400 Missing configurations in dashboard.
SessionExpired 401 Found session is expired and cannot be processed anymore.
AuthorizationMissing 401 Authorization header is missing.
SessionNotFound 404 Session specified in request does not exist or cannot be retrieved.
ProviderNotFound 404 Provider 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.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Tokens

Index

Returns the list of access tokens issued by Provider for Salt Edge PSD2 Compliance Solution.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImtpbmQiOiJyZXZva2VkIiwiZnJvbV9pZCI6MzAyLCJmcm9tX2RhdGUiOiIyMDE5LTA4LTIwVDE2OjA0OjQ5LjAyMVoiLCJwZXJfcGFnZSI6NTAsImN1c3RvbWVyX2lkIjo4MjF9LCJleHAiOjE3MTQ3MzE5MTh9.bLLPSG7fF87KQWgFOA2SBZgoRMIpNZahb_H8yhVu-X5rBL59Ioi6DUp0Flz8ZQuK_9wCAG2Nna10v6R518aIusvRp_28hhZae6a2dhSRdVzyFdBZTnNlTDoLVGkaKP62nNVZ2Cg4Z5eM_L1tFRcofoVbTg5svcdV2aXp7EZq1sKi5wAywZVnxv1OzEV3SmIxEg0T9fhX12mSWAQ-Kz2vWflphd9R5oqAq3PsB5ZKxP4mbG5ce7cAiYeAYHMXMrL116TwiPM5WV4PKexBOyjRvAUjzWQj56wNbSJltDuh3rvNQKKdhXiShdY7shZMvg5NkXIEaL8GWvbLbcT37T47Yw" \ 
 -H "App-Id: G9SgwyF-RdxsjCu3f3mLnw" \ 
 -H "App-Secret: Az6qAhT6pdezVjAex58qqQ" \ 
 -X GET "/api/connectors/v1/tokens/index"

Example of request parameters

{"data":{"kind":"revoked","from_id":302,"from_date":"2019-08-20T16:04:49.021Z","per_page":50,"customer_id":821},"exp":1574093209}

Example of response

{"meta":{"next_id":303,"time":"2019-11-18T16:04:49.001Z"},"data":{"tokens":[]}}
Request

GET /api/connectors/v1/tokens/index

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 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 Authorization
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
ConfigurationError 400 Missing configurations in dashboard.
AuthorizationMissing 401 Authorization header is missing.
CustomerNotFound 404 PSU specified in request does not exist or cannot be retrieved.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Revoke

Revoke callback needs to be called any time a token is revoked on the Provider Connector side.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzE0NzMxOTE4fQ.l-CUYQHNXnWUoTxEvPVNQMw6gKOnK2Dx6mSvnZdDZMAIk__q2nGraRIpGf_clEtbHpi92hqyUEip-brmm1Pgw4e-anlDfV33vDRS7klWPLhwru7rmiAaXZsl3I96yuuQt0WCIoyas0hY44i4x1cWbn4Ih4EThTJIEIwrIwpgnuYV0kLiNDMzhF6Q5tUkoMjNgJ6QQxcQJYjUu64kHTokL7VVVlCoXGgkX2uo_YkTvU9Ek1v_uMmvfxaDAc40FN1IigoTu_Y9ZBWZDu-HBUBgJCG1TJbgIfP0FAno1otxBghVWtnXA2OTTxuvH2YdhPsIHAxXtGoOqcpqWl3IlD9ZpQ" \ 
 -H "App-Id: cfOK5P9RVooLksNv8il3rw" \ 
 -H "App-Secret: rwkTbW41SPT55uo1I_-UGQ" \ 
 -H "Token: example_Token" \ 
 -X DELETE "/api/connectors/v1/tokens/revoke"

Example of request parameters

{"data":{},"exp":1574093208}

Example of response

{"data":{"revoked":true},"meta":{"time":"2019-11-18T16:04:48.928Z"}}
Request

DELETE /api/connectors/v1/tokens/revoke

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 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.
Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Unpacked Request Authorization
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

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


Related Errors
Class Code Description
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without 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.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled 406 Cooperation with specified Provider is impossible.

Clients

Info

All requests that are forwarded by Salt Edge PSD2 Compliance Solution are signed by TPP applications. Provider can decide whether to decode the original request by itself or use decoded payload by Salt Edge PSD2 Compliance Solution which is stored in client_payload key. In order to decode the client_jwt, Connector has to perform the following request to obtain TPP's public key. The client_id is present in Client-Id header along with Authorization header.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNsaWVudF9pZCI6NTE3fSwiZXhwIjoxNzE0NzMxOTE4fQ.Oum_KhSNOOw4wPw6u-jCViLieCjeeM1R9KHjHJuAn3Ev3zWVCmauG0fVY0H8ZmGH0VNH52WZJY3w_OAPA_JbE7Ri9SSsJdvXtACb1M2FijwH1gUgEl-BB7iZFLUbuDBHW4LS7cHaqpEe9pm64ijRam1HW6PuMsTC0uzhS68ZS-QUHFSe8iGFeqlsNrsgtSmbyTv6FBjmWWIiJiNmf-R0dFxOh8FrgEoym_aIkwvDYssEMeeKFZRHGH-t1PDi2lWrF1FbBZOg1lez0XpnUYMLk2vIUkiLi0wguxi-LQJ1eEeY0HJ_ybTc7YNu7ch2OG4nomivYv01vVVvcsZQBEGX5A" \ 
 -H "App-Id: hAnmNmGFFBN3W_jNWJd_fQ" \ 
 -H "App-Secret: h6rzA_lw2wVuCpDaBKlxAA" \ 
 -X GET "/api/connectors/v1/clients/info"

Example of request parameters

{"data":{"client_id":517},"exp":1574093208}

Example of response

{"data":{"name":"Fentury","scopes":["accounts","transactions","kyc"],"public_key":"-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0\nFPqri0cb2JZfXJ/DgYSF6vUpwmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/\n3j+skZ6UtW+5u09lHNsj6tQ51s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQAB\n-----END PUBLIC KEY-----"},"meta":{"time":"2019-11-18T16:04:48.271Z"}}
Request

GET /api/connectors/v1/clients/info

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 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 Authorization
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
ConfigurationError 400 Missing configurations in dashboard.
AuthorizationMissing 401 Authorization header is missing.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled 406 Cooperation with specified Provider is impossible.