Payments
This endpoints are responsible for creating payment orders on behalf of PSU via TPP interface. Process of payment creation starts once PSU fills a payment template form and submits the request. You can find below sequence diagrams represeting oauth payment creation, oauth payment creation using SCA and funds availability flows.
OAuth SCA Payment Creation Flow
OAuth Payment Creation Flow
Create
Create a payment. As a result, Connector should send a success , update or fail callback to Salt Edge PSD2 Compliance with result of the operation.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInNlc3Npb25fc2VjcmV0IjoieGJtLXZtU1NvRXNCc3NTUkttbTgiLCJvcmlnaW5hbF9yZXF1ZXN0Ijp7ImNsaWVudF9qd3QiOiJCZWFyZXIgZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SmtZWFJoSWpwN0luQnliM1pwWkdWeVgyTnZaR1VpT2lKa1pXMXZZbUZ1YXlJc0luUmxiWEJzWVhSbFgybGtJam80TWpRc0luSmxaR2x5WldOMFgzVnliQ0k2SW1oMGRIQnpPaTh2ZFhObGNpNTNhV3hzTG1KbEwzSmxaR2x5WldOMFpXUXZhR1Z5WlNJc0ltSmxibVZtYVdOcFlYSjVYMmxrSWpvek9ETXNJbVp2Y21ObFgzTmpZU0k2ZEhKMVpTd2laWGgwY21FaU9udDlmU3dpWlhod0lqb3hOVGMwTURrek1qQTVmUS5pQkNPT25kNnRDVnp5Z2h2amtfaW9uUGNXTEV6WEVzMU5TUDc5UVc4WWJJcFc0WHFZYkNoSUhMMkxIYzdweE9SdDRYWXBKYV91cUI1YUR2VmdDZGhBekY5dkszVVFHWEZpNW1sTEhXdkh5N3NCWXhWcjVKRl9XQXhRQlRlRkx6NVJjUVdfZ2hoSmhqUGc2bXZleFBwNXpVWWxhcWx3SEN3eHpxaFNLZXpiREVCbkVxNjJJYnZoVHIxVUxuNTdLVWx6ZFFJRGwwNzFkRW9rdnhqbUZWSlB0V3RfcWhGRVVydFlDWkJLRlFhelI5X0dGdXJkNzJaOV9FMFBYcmZOS2M0dUh3WnRucWFUZ2VuNktpQXFGdlBxenpEODlocWRFdmVuMVhqWVNlcnBpZnR1Rk92MXNYQkY4WnFFTzN2MS16dGs3Nm9TeFBaMnpoNkxud2xSSkszanciLCJjbGllbnRfcGF5bG9hZCI6eyJkYXRhIjp7InJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9LCJ0ZW1wbGF0ZV9pZCI6ODI0LCJwYXltZW50X2F0dHJpYnV0ZXMiOnsiZnJvbV9hY2NvdW50IjoiMTM0NjU0NjQiLCJ0b19hY2NvdW50IjoiMjU3NjU3NDYiLCJhbW91bnQiOjEwMC41LCJkZXNjcmlwdGlvbiI6InRlc3QifSwicHJvdmlkZXJfY29kZSI6ImRlbW9iYW5rIn0sImV4cCI6MTU3NDA5MzIwOX19LCJyZWRpcmVjdF91cmwiOiJodHRwczovL3VzZXIud2lsbC5iZS9yZWRpcmVjdGVkL2hlcmUiLCJwcmlvcmFfcGF5bWVudF9pZCI6NDUxLCJwYXltZW50X3R5cGUiOiJQU0RfQUlTUCJ9LCJleHAiOjE3MTQ3ODY1ODh9.lD_Zy5_5GkUSeENVWmw3yPPbs-Qhs9jS0LGUZubeU8B3bjCVlm1fckm1BHxiDTTrRLi19-6CY-ixqoynXX2FY_wC8BKX7ewef8UkQpV4NyL7uf3frm6TOmYIOTdnQmou_9wVCQYPE9qwAQggNTEHpSJYQnyhyZEddLZzYHnmDIF-CRFxIYoajF8fDotichA6mcY2WvgG1EfNb9hM3MKSgBTROvbMP6K-SFZhyu5COGWhEW4oLM5ZpNd6h-dtt09GJHnyjHEuq2ZQOq0YPJeMi-cFnohII2Pru5GwZmHGvyjlS7Gjbo4T63_-jPp3Wr2ZuUyMVkFHr--HboOr9t3-cA" \
-H "Access-Token: 724e66da1e457c6e5d309a78966d79ddd877368e142ed4b3fd36b73909a880ff69052fdfa57d09eb7b308a79b47728e80e681bbc9e9a68b72b2a10534c64220a" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 388" \
-X POST "https://your.connector.url/api/priora/v1/payments/create"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInNlc3Npb25fc2VjcmV0IjoieGJtLXZtU1NvRXNCc3NTUkttbTgiLCJvcmlnaW5hbF9yZXF1ZXN0Ijp7ImNsaWVudF9qd3QiOiJCZWFyZXIgZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SmtZWFJoSWpwN0luQnliM1pwWkdWeVgyTnZaR1VpT2lKa1pXMXZZbUZ1YXlJc0luUmxiWEJzWVhSbFgybGtJam80TWpRc0luSmxaR2x5WldOMFgzVnliQ0k2SW1oMGRIQnpPaTh2ZFhObGNpNTNhV3hzTG1KbEwzSmxaR2x5WldOMFpXUXZhR1Z5WlNJc0ltSmxibVZtYVdOcFlYSjVYMmxrSWpvek9ETXNJbVp2Y21ObFgzTmpZU0k2ZEhKMVpTd2laWGgwY21FaU9udDlmU3dpWlhod0lqb3hOVGMwTURrek1qQTVmUS5pQkNPT25kNnRDVnp5Z2h2amtfaW9uUGNXTEV6WEVzMU5TUDc5UVc4WWJJcFc0WHFZYkNoSUhMMkxIYzdweE9SdDRYWXBKYV91cUI1YUR2VmdDZGhBekY5dkszVVFHWEZpNW1sTEhXdkh5N3NCWXhWcjVKRl9XQXhRQlRlRkx6NVJjUVdfZ2hoSmhqUGc2bXZleFBwNXpVWWxhcWx3SEN3eHpxaFNLZXpiREVCbkVxNjJJYnZoVHIxVUxuNTdLVWx6ZFFJRGwwNzFkRW9rdnhqbUZWSlB0V3RfcWhGRVVydFlDWkJLRlFhelI5X0dGdXJkNzJaOV9FMFBYcmZOS2M0dUh3WnRucWFUZ2VuNktpQXFGdlBxenpEODlocWRFdmVuMVhqWVNlcnBpZnR1Rk92MXNYQkY4WnFFTzN2MS16dGs3Nm9TeFBaMnpoNkxud2xSSkszanciLCJjbGllbnRfcGF5bG9hZCI6eyJkYXRhIjp7InJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9LCJ0ZW1wbGF0ZV9pZCI6ODI0LCJwYXltZW50X2F0dHJpYnV0ZXMiOnsiZnJvbV9hY2NvdW50IjoiMTM0NjU0NjQiLCJ0b19hY2NvdW50IjoiMjU3NjU3NDYiLCJhbW91bnQiOjEwMC41LCJkZXNjcmlwdGlvbiI6InRlc3QifSwicHJvdmlkZXJfY29kZSI6ImRlbW9iYW5rIn0sImV4cCI6MTU3NDA5MzIwOX19LCJyZWRpcmVjdF91cmwiOiJodHRwczovL3VzZXIud2lsbC5iZS9yZWRpcmVjdGVkL2hlcmUiLCJwcmlvcmFfcGF5bWVudF9pZCI6NDUxLCJwYXltZW50X3R5cGUiOiJQU0RfQUlTUCJ9LCJleHAiOjE3MTQ3ODY1ODh9.lD_Zy5_5GkUSeENVWmw3yPPbs-Qhs9jS0LGUZubeU8B3bjCVlm1fckm1BHxiDTTrRLi19-6CY-ixqoynXX2FY_wC8BKX7ewef8UkQpV4NyL7uf3frm6TOmYIOTdnQmou_9wVCQYPE9qwAQggNTEHpSJYQnyhyZEddLZzYHnmDIF-CRFxIYoajF8fDotichA6mcY2WvgG1EfNb9hM3MKSgBTROvbMP6K-SFZhyu5COGWhEW4oLM5ZpNd6h-dtt09GJHnyjHEuq2ZQOq0YPJeMi-cFnohII2Pru5GwZmHGvyjlS7Gjbo4T63_-jPp3Wr2ZuUyMVkFHr--HboOr9t3-cA" \
-H "Access-Token: 724e66da1e457c6e5d309a78966d79ddd877368e142ed4b3fd36b73909a880ff69052fdfa57d09eb7b308a79b47728e80e681bbc9e9a68b72b2a10534c64220a" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 388" \
-X POST "https://your.connector.url/api/priora/v1/payments/create"
Example of request parameters
{"exp":1574093209,"data":{"provider_code":"demobank","session_secret":"xbm-vmSSoEsBssSRKmm8","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInRlbXBsYXRlX2lkIjo4MjQsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9fSwiZXhwIjoxNTc0MDkzMjA5fQ.iBCOOnd6tCVzyghvjk_ionPcWLEzXEs1NSP79QW8YbIpW4XqYbChIHL2LHc7pxORt4XYpJa_uqB5aDvVgCdhAzF9vK3UQGXFi5mlLHWvHy7sBYxVr5JF_WAxQBTeFLz5RcQW_ghhJhjPg6mvexPp5zUYlaqlwHCwxzqhSKezbDEBnEq62IbvhTr1ULn57KUlzdQIDl071dEokvxjmFVJPtWt_qhFEUrtYCZBKFQazR9_GFurd72Z9_E0PXrfNKc4uHwZtnqaTgen6KiAqFvPqzzD89hqdEven1XjYSerpiftuFOv1sXBF8ZqEO3v1-ztk76oSxPZ2zh6LnwlRJK3jw","client_payload":{"data":{"redirect_url":"https://user.will.be/redirected/here","beneficiary_id":383,"force_sca":true,"extra":{},"template_id":824,"payment_attributes":{"from_account":"13465464","to_account":"25765746","amount":100.5,"description":"test"},"provider_code":"demobank"},"exp":1574093209}},"redirect_url":"https://user.will.be/redirected/here","priora_payment_id":451,"payment_type":"PSD_AISP"}}
{"exp":1574093209,"data":{"provider_code":"demobank","session_secret":"xbm-vmSSoEsBssSRKmm8","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInRlbXBsYXRlX2lkIjo4MjQsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9fSwiZXhwIjoxNTc0MDkzMjA5fQ.iBCOOnd6tCVzyghvjk_ionPcWLEzXEs1NSP79QW8YbIpW4XqYbChIHL2LHc7pxORt4XYpJa_uqB5aDvVgCdhAzF9vK3UQGXFi5mlLHWvHy7sBYxVr5JF_WAxQBTeFLz5RcQW_ghhJhjPg6mvexPp5zUYlaqlwHCwxzqhSKezbDEBnEq62IbvhTr1ULn57KUlzdQIDl071dEokvxjmFVJPtWt_qhFEUrtYCZBKFQazR9_GFurd72Z9_E0PXrfNKc4uHwZtnqaTgen6KiAqFvPqzzD89hqdEven1XjYSerpiftuFOv1sXBF8ZqEO3v1-ztk76oSxPZ2zh6LnwlRJK3jw","client_payload":{"data":{"redirect_url":"https://user.will.be/redirected/here","beneficiary_id":383,"force_sca":true,"extra":{},"template_id":824,"payment_attributes":{"from_account":"13465464","to_account":"25765746","amount":100.5,"description":"test"},"provider_code":"demobank"},"exp":1574093209}},"redirect_url":"https://user.will.be/redirected/here","priora_payment_id":451,"payment_type":"PSD_AISP"}}
{"data":{"provider_code":"demobank","session_secret":"fVj2LZy9y7JKWuxabEED","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInRlbXBsYXRlX2lkIjo5MjgsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjo0MTYsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9fSwiZXhwIjoxNTc0MDkzMjA5fQ.OOsP_WNJ6c3BI60tbB9myDLlvcQEY0mgbiAUlBfJQmT9U7rpCWqEQcSQAl495Dkunl8nYtQNCc3bmW2qs_eX8h6-Jk3GPxzFeS7uES35YefMqx3zJ5gXefg-CWpJRcMCcIQ_ih2J_mpTG1vlo4cYR_ujQ8eOCeuklWUF1opLH791br0171SNSmKi6Gm7qQfn6wVcvh6X8MUyuCY1jWR9NCP9QcbCXawxRmXYkhfE1E6CakfLggRI9XTrYB1XKCxKQFXbxqXcHL2kwZWOI9jRsKYdzUqvWM4kgUX6Ow0Bn8NZj4tRmpl5LBYkYFOlRSyb7LQQmHcPH2RWPDxBGs43lQ","client_payload":{"data":{"redirect_url":"https://user.will.be/redirected/here","beneficiary_id":416,"force_sca":true,"extra":{},"template_id":928,"payment_attributes":{"from_account":"13465464","to_account":"25765746","amount":100.5,"description":"test"},"provider_code":"demobank"},"exp":1574093209}},"priora_payment_id":307,"payment_type":"PSD_AISP"},"exp":1574093209}
{"data":{"provider_code":"demobank","session_secret":"fVj2LZy9y7JKWuxabEED","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInRlbXBsYXRlX2lkIjo5MjgsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjo0MTYsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9fSwiZXhwIjoxNTc0MDkzMjA5fQ.OOsP_WNJ6c3BI60tbB9myDLlvcQEY0mgbiAUlBfJQmT9U7rpCWqEQcSQAl495Dkunl8nYtQNCc3bmW2qs_eX8h6-Jk3GPxzFeS7uES35YefMqx3zJ5gXefg-CWpJRcMCcIQ_ih2J_mpTG1vlo4cYR_ujQ8eOCeuklWUF1opLH791br0171SNSmKi6Gm7qQfn6wVcvh6X8MUyuCY1jWR9NCP9QcbCXawxRmXYkhfE1E6CakfLggRI9XTrYB1XKCxKQFXbxqXcHL2kwZWOI9jRsKYdzUqvWM4kgUX6Ow0Bn8NZj4tRmpl5LBYkYFOlRSyb7LQQmHcPH2RWPDxBGs43lQ","client_payload":{"data":{"redirect_url":"https://user.will.be/redirected/here","beneficiary_id":416,"force_sca":true,"extra":{},"template_id":928,"payment_attributes":{"from_account":"13465464","to_account":"25765746","amount":100.5,"description":"test"},"provider_code":"demobank"},"exp":1574093209}},"priora_payment_id":307,"payment_type":"PSD_AISP"},"exp":1574093209}
Request
POST
https://your.connector.url/api/priora/v1/payments/create
Headers
Unpacked Request Authorization
Oauth Payment
Embedded Payment
hash, required
Wrapper for the data.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
string, required
Specifies the type of payment associated with a preregistered template.
string, required
Human readable Provider identifier.
string, required
Session identifier in Salt Edge PSD2 Compliance.
hash, required
Original parameters coming from Client application.
hash, required
Already verified and decoded client JWT. Using this data will allow you to not perform additional calls to Salt Edge PSD2 Compliance Solution.
hash, required
Wrapper for the data.
string, optional
Trusted Beneficiary identifier.
hash, required
All attributes(required and optional) that are needed for a successful payment initiation according to specified template_id.
string, required
Payment template identifier on Salt Edge PSD2 Compliance side.
url, required
The URL that the PSU will be redirected to after payment confirmation via redirect, if the provider initiates such a redirect.
hash, required
Any additional information relevant to a payment.
Default value:
{}
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
url, required
The URL that the PSU will be redirected to after payment confirmation via redirect, if the provider initiates such a redirect.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
string, required
Specifies the type of payment associated with a preregistered template.
string, required
Human readable Provider identifier.
string, required
Session identifier in Salt Edge PSD2 Compliance.
hash, required
Original parameters coming from Client application.
hash, required
Already verified and decoded client JWT. Using this data will allow you to not perform additional calls to Salt Edge PSD2 Compliance Solution.
hash, required
Wrapper for the data.
hash, required
All attributes(required and optional) that are needed for a successful payment initiation according to specified template_id.
string, required
Payment template identifier on Salt Edge PSD2 Compliance side.
hash, required
Any additional information relevant to a payment.
Default value:
{}
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
Response headers
Response
Upon successful request, 200 status code should be returned.
Show
Fetch all data relevant to a payment including fees, status and other. Response of this action should contain a corresponding payment object in JSON format.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzE0Nzg2NTg4fQ.BGSlNb-Pgc02GRXUHHnWMUeZA_tDFmqqHi-548fdrsx0BVv6pzqIYxezCLRGFCRo9ECXOyPDfSf37zbZLbu-Ck-Vb07X0T5VqzPlSj1uPF1IXmafT_K2DaKMUvL38nv6aHX0Fr9TBLG9VKgrnjyZ_jtPLamrCl9bktDUflajSVvsj8t-xBPOpKDFL-jBoQPOaOv5tI92Qg959ZJkwR9vbPb8rpUYpWuC9XAvirH2VDQGdRFqQbYMBEOt1Fid2DFbxzP-T-V-d61-y_mT7ADCg5D03Bd-We6yTWMgu2pootW3v4C0Qzk_iHX5SIXDQCSOh77DKufeWMnuvQhiQUu6PQ" \
-H "Access-Token: d006c043ccc799237ec0be8137e8756c09b5add0357410a90298203705731b4da954c8108387bf8d1ef45244fee380704e7b883e66e09f51c767d776206f748c" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 951" \
-X GET "https://your.connector.url/api/priora/v1/payments/show"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzE0Nzg2NTg4fQ.BGSlNb-Pgc02GRXUHHnWMUeZA_tDFmqqHi-548fdrsx0BVv6pzqIYxezCLRGFCRo9ECXOyPDfSf37zbZLbu-Ck-Vb07X0T5VqzPlSj1uPF1IXmafT_K2DaKMUvL38nv6aHX0Fr9TBLG9VKgrnjyZ_jtPLamrCl9bktDUflajSVvsj8t-xBPOpKDFL-jBoQPOaOv5tI92Qg959ZJkwR9vbPb8rpUYpWuC9XAvirH2VDQGdRFqQbYMBEOt1Fid2DFbxzP-T-V-d61-y_mT7ADCg5D03Bd-We6yTWMgu2pootW3v4C0Qzk_iHX5SIXDQCSOh77DKufeWMnuvQhiQUu6PQ" \
-H "Access-Token: d006c043ccc799237ec0be8137e8756c09b5add0357410a90298203705731b4da954c8108387bf8d1ef45244fee380704e7b883e66e09f51c767d776206f748c" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 951" \
-X GET "https://your.connector.url/api/priora/v1/payments/show"
Example of request parameters
{"data":{},"exp":1574093209}
{"data":{},"exp":1574093209}
Example of response
{"data":{"total":-43.5,"payment_attributes":{"amount":100.5,"from_account":"13465464","to_account":"25765746","description":"test"},"status":"executing","fees":[{"amount":0.25,"description":"Bank fee.","currency_code":"EUR"},{"amount":0.1,"description":"Payment fee.","currency_code":"EUR"}],"description":"Test payment","id":198,"extra":{},"priora_payment_id":"677"}}
{"data":{"total":-43.5,"payment_attributes":{"amount":100.5,"from_account":"13465464","to_account":"25765746","description":"test"},"status":"executing","fees":[{"amount":0.25,"description":"Bank fee.","currency_code":"EUR"},{"amount":0.1,"description":"Payment fee.","currency_code":"EUR"}],"description":"Test payment","id":198,"extra":{},"priora_payment_id":"677"}}
Request
GET
https://your.connector.url/api/priora/v1/payments/show
Headers
Unpacked Request Authorization
hash, required
Wrapper for the data.
string, required
Payment identifier on Connector side.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
Response headers
Response
Upon successful request, 200 status code should be returned.
hash, required
Wrapper for the data.
string, required
Payment identifier on Connector.
float, required
Total amount paid.
hash, required
All attributes (required and optional) that belong to a payment template which PSU fills before creating the payment order.
string, required
Status of payment.
Allowed values:
processing, pending, redirect, waiting_confirmation, waiting_confirmation_code, successful, closed, failed, confirmed, executing
array, optional
List of all fees applied to given payment.
Default value:
[]
float, required
Amount of bank's fee related to the payment.
string, required
Fee's description.
string, required
Currency code of bank's fee related to the payment.
Can raise:
UnknownCurrency
hash, optional
Any additional information relevant to a payment.
Default value:
{}
string, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
string, optional
Payment's description.
Confirm
This endpoint is used for processing additional interactive steps in the process of payment 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.eyJkYXRhIjp7InBheW1lbnRfaWQiOiI5NzkiLCJvcmlnaW5hbF9yZXF1ZXN0Ijp7ImNsaWVudF9qd3QiOiJCZWFyZXIgZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SmtZWFJoSWpwN0ltTnlaV1JsYm5ScFlXeHpJanA3SW5SNWNHVWlPaUp2WVhWMGFDSjlmU3dpWlhod0lqb3hOVGMwTURrek1qQTVmUS5IYUoyWksxVlZvUXJoUkZsSVBaTk01dzRtajhQVG9sT3BBbHJFRU9UY2VGSWFrYzQ1blFMd1BpUkNyUE9OQWl6blRJMTI1MEVkb01Vd1JmYVd6MUFRMEZBdi1Xc1dmb3ltTjNiaVljWlpwNEZlQXJMVzgyd3pzREZXVTlWV1VIU0h4MnpMX0k3dnZWaGxKY1BiX3R6SVJWcVJSTFRNTnp2SjJPX1hYZ0hPeG1TQXF6Q3B1UTdBVUV6QTVZdUQxWjgxZDVPcTMtNzNmMGRjenc1Nnk2cTV4blY4NnJuZ2s5M1FpYTdGR3oyRi1HY3dJbld6R0lsV2dtUXQxYk13SHltNnJ1RVVzeUxOZ09LanVObnFGaEtwOTh2V1FpaFFuVlZBdmU3bGNoUG9rWWFYMklGU0k4Z2FkT2FTZ1dyQ2FvMngySU1qQkZxMHZvaFYxQnFZbEVLYVEiLCJjbGllbnRfcGF5bG9hZCI6eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InNtc19waW5jb2RlIjoiMTIzNDU2In19LCJleHAiOjE1NzQwOTMyMDksImlkIjo3OTR9fSwiY3JlZGVudGlhbHMiOnsidHlwZSI6Im9hdXRoIn0sInNlc3Npb25fc2VjcmV0IjoiRTVlVk5IdmdDSDlpZjRGSkE4UGUiLCJwcmlvcmFfcGF5bWVudF9pZCI6NDQ4fSwiZXhwIjoxNzE0Nzg2NTg5fQ.tJ69bgijGROTXNv91i3vZooD-xlSdhM8Tq7EBiPbBLdC1Yo9Xn10Zvsw6zKwNA1-H6m9HBZ0eSRiDSwk0Wdni3ClNpdc4LHviVOcKQZ8CD8Xh5iMU1yY-IfqLBrk6TX09j_vs_Ai31yGmHbmoBuoTqC1K1P9NTGWmfgX5U-qREZPOi4YaWT0Ag2TzvQJys96Q064zmKpzB2jftDruZjJ5S_RYmxc9KjUtkUGqeOIifiIfLeY-yyW7HIb8hK0nwCG1Ls1xd_Qa44CY3xtRsMV_VK1pC9lQBwdJHmN1M4SepFLVsaXDsIGD4APrXnhhGX0Lm8drEMSml1Nn3x9Ba_Avw" \
-H "Access-Token: a38cb0703965208ce622270370d5174d074385ee6f615052fb2856cde4b30c8909ea2a71fb702eb4c129aa9dd671354099c1179f3313ea3eea233a73ffc9cf91" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 305" \
-X POST "https://your.connector.url/api/priora/v1/payments/confirm"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBheW1lbnRfaWQiOiI5NzkiLCJvcmlnaW5hbF9yZXF1ZXN0Ijp7ImNsaWVudF9qd3QiOiJCZWFyZXIgZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKU1V6STFOaUo5LmV5SmtZWFJoSWpwN0ltTnlaV1JsYm5ScFlXeHpJanA3SW5SNWNHVWlPaUp2WVhWMGFDSjlmU3dpWlhod0lqb3hOVGMwTURrek1qQTVmUS5IYUoyWksxVlZvUXJoUkZsSVBaTk01dzRtajhQVG9sT3BBbHJFRU9UY2VGSWFrYzQ1blFMd1BpUkNyUE9OQWl6blRJMTI1MEVkb01Vd1JmYVd6MUFRMEZBdi1Xc1dmb3ltTjNiaVljWlpwNEZlQXJMVzgyd3pzREZXVTlWV1VIU0h4MnpMX0k3dnZWaGxKY1BiX3R6SVJWcVJSTFRNTnp2SjJPX1hYZ0hPeG1TQXF6Q3B1UTdBVUV6QTVZdUQxWjgxZDVPcTMtNzNmMGRjenc1Nnk2cTV4blY4NnJuZ2s5M1FpYTdGR3oyRi1HY3dJbld6R0lsV2dtUXQxYk13SHltNnJ1RVVzeUxOZ09LanVObnFGaEtwOTh2V1FpaFFuVlZBdmU3bGNoUG9rWWFYMklGU0k4Z2FkT2FTZ1dyQ2FvMngySU1qQkZxMHZvaFYxQnFZbEVLYVEiLCJjbGllbnRfcGF5bG9hZCI6eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InNtc19waW5jb2RlIjoiMTIzNDU2In19LCJleHAiOjE1NzQwOTMyMDksImlkIjo3OTR9fSwiY3JlZGVudGlhbHMiOnsidHlwZSI6Im9hdXRoIn0sInNlc3Npb25fc2VjcmV0IjoiRTVlVk5IdmdDSDlpZjRGSkE4UGUiLCJwcmlvcmFfcGF5bWVudF9pZCI6NDQ4fSwiZXhwIjoxNzE0Nzg2NTg5fQ.tJ69bgijGROTXNv91i3vZooD-xlSdhM8Tq7EBiPbBLdC1Yo9Xn10Zvsw6zKwNA1-H6m9HBZ0eSRiDSwk0Wdni3ClNpdc4LHviVOcKQZ8CD8Xh5iMU1yY-IfqLBrk6TX09j_vs_Ai31yGmHbmoBuoTqC1K1P9NTGWmfgX5U-qREZPOi4YaWT0Ag2TzvQJys96Q064zmKpzB2jftDruZjJ5S_RYmxc9KjUtkUGqeOIifiIfLeY-yyW7HIb8hK0nwCG1Ls1xd_Qa44CY3xtRsMV_VK1pC9lQBwdJHmN1M4SepFLVsaXDsIGD4APrXnhhGX0Lm8drEMSml1Nn3x9Ba_Avw" \
-H "Access-Token: a38cb0703965208ce622270370d5174d074385ee6f615052fb2856cde4b30c8909ea2a71fb702eb4c129aa9dd671354099c1179f3313ea3eea233a73ffc9cf91" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 305" \
-X POST "https://your.connector.url/api/priora/v1/payments/confirm"
Example of request parameters
{"data":{"payment_id":"979","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InR5cGUiOiJvYXV0aCJ9fSwiZXhwIjoxNTc0MDkzMjA5fQ.HaJ2ZK1VVoQrhRFlIPZNM5w4mj8PTolOpAlrEEOTceFIakc45nQLwPiRCrPONAiznTI1250EdoMUwRfaWz1AQ0FAv-WsWfoymN3biYcZZp4FeArLW82wzsDFWU9VWUHSHx2zL_I7vvVhlJcPb_tzIRVqRRLTMNzvJ2O_XXgHOxmSAqzCpuQ7AUEzA5YuD1Z81d5Oq3-73f0dczw56y6q5xnV86rngk93Qia7FGz2F-GcwInWzGIlWgmQt1bMwHym6ruEUsyLNgOKjuNnqFhKp98vWQihQnVVAve7lchPokYaX2IFSI8gadOaSgWrCao2x2IMjBFq0vohV1BqYlEKaQ","client_payload":{"data":{"credentials":{"sms_pincode":"123456"}},"exp":1574093209,"id":794}},"credentials":{"type":"oauth"},"session_secret":"E5eVNHvgCH9if4FJA8Pe","priora_payment_id":448},"exp":1574093209}
{"data":{"payment_id":"979","original_request":{"client_jwt":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InR5cGUiOiJvYXV0aCJ9fSwiZXhwIjoxNTc0MDkzMjA5fQ.HaJ2ZK1VVoQrhRFlIPZNM5w4mj8PTolOpAlrEEOTceFIakc45nQLwPiRCrPONAiznTI1250EdoMUwRfaWz1AQ0FAv-WsWfoymN3biYcZZp4FeArLW82wzsDFWU9VWUHSHx2zL_I7vvVhlJcPb_tzIRVqRRLTMNzvJ2O_XXgHOxmSAqzCpuQ7AUEzA5YuD1Z81d5Oq3-73f0dczw56y6q5xnV86rngk93Qia7FGz2F-GcwInWzGIlWgmQt1bMwHym6ruEUsyLNgOKjuNnqFhKp98vWQihQnVVAve7lchPokYaX2IFSI8gadOaSgWrCao2x2IMjBFq0vohV1BqYlEKaQ","client_payload":{"data":{"credentials":{"sms_pincode":"123456"}},"exp":1574093209,"id":794}},"credentials":{"type":"oauth"},"session_secret":"E5eVNHvgCH9if4FJA8Pe","priora_payment_id":448},"exp":1574093209}
Request
POST
https://your.connector.url/api/priora/v1/payments/confirm
Headers
Unpacked Request Authorization
hash, required
Wrapper for the data.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
string, required
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
hash, required
Original parameters coming from Client application.
hash, optional
Wrapper for required first step credentials.
string, required
Session identifier in Salt Edge PSD2 Compliance.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
Response headers
Response
Upon successful request, 200 status code should be returned.
Cancel
Cancel the payment that is in the process of creation, meaning it has not been confirmed yet.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBheW1lbnRfaWQiOiI2ODEiLCJzZXNzaW9uX3NlY3JldCI6IlVUUmdIdFotZnh5SGRNaTZmQ2liIn0sImV4cCI6MTcxNDc4NjU4OX0.iU-696PocHUFKtKOe42dF4wpIwA5rDAtCcqV9PgUczCTeFoaorRS_won0516KC0_FV5IoOgdS98sbd5cAry18x6QzaYD_ERILBcF33V2H0O0LohIHU-SrquErKfnNBcA8LYil6k6bWb7aQVAqTCU-5NHDIKbemSuXGKrQwB4OKUbgnUQw4fylrbYKqCYiHT6nNsKbci8xOxDuOfAkLazyq4YJeP1lvrv70d-8Ys9GRlLwW1OT9dm6bUPLLdf9nn_7Fx6jN0wbDC-DxVnRvQeWcspTX3dAOqw-7Npn11VXsjKphkT_QwyHvQSJDl3noko-JbHhGkESO9TjhVVfx3V0A" \
-H "Access-Token: caab3e072b3c178b01aa19b52e05a518e23b63d5330a4592f8d9378d24001f55e21476dd29a22334e37ec1396332804254bebf0190852be2ce2626eb6d82aa0f" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 311" \
-X POST "https://your.connector.url/api/priora/v1/payments/cancel"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBheW1lbnRfaWQiOiI2ODEiLCJzZXNzaW9uX3NlY3JldCI6IlVUUmdIdFotZnh5SGRNaTZmQ2liIn0sImV4cCI6MTcxNDc4NjU4OX0.iU-696PocHUFKtKOe42dF4wpIwA5rDAtCcqV9PgUczCTeFoaorRS_won0516KC0_FV5IoOgdS98sbd5cAry18x6QzaYD_ERILBcF33V2H0O0LohIHU-SrquErKfnNBcA8LYil6k6bWb7aQVAqTCU-5NHDIKbemSuXGKrQwB4OKUbgnUQw4fylrbYKqCYiHT6nNsKbci8xOxDuOfAkLazyq4YJeP1lvrv70d-8Ys9GRlLwW1OT9dm6bUPLLdf9nn_7Fx6jN0wbDC-DxVnRvQeWcspTX3dAOqw-7Npn11VXsjKphkT_QwyHvQSJDl3noko-JbHhGkESO9TjhVVfx3V0A" \
-H "Access-Token: caab3e072b3c178b01aa19b52e05a518e23b63d5330a4592f8d9378d24001f55e21476dd29a22334e37ec1396332804254bebf0190852be2ce2626eb6d82aa0f" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 311" \
-X POST "https://your.connector.url/api/priora/v1/payments/cancel"
Example of request parameters
{"data":{"payment_id":"681","session_secret":"UTRgHtZ-fxyHdMi6fCib"},"exp":1574093209}
{"data":{"payment_id":"681","session_secret":"UTRgHtZ-fxyHdMi6fCib"},"exp":1574093209}
Request
POST
https://your.connector.url/api/priora/v1/payments/cancel
Headers
Unpacked Request Authorization
hash, required
Wrapper for the data.
string, required
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
string, required
Session identifier in Salt Edge PSD2 Compliance.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
Response headers
Response
Upon successful request, 200 status code should be returned.
Trusted Beneficiaries
These endpoints are responsible for processing trusted beneficiaries.
Get
Fetch all data relevant to trusted beneficiaries. Response of this action should contain a corresponding trusted beneficiary object in JSON format.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzE0Nzg2NTkwfQ.eBXOLUn5sQ1bK_NSFhFlSIhlQF_oOyvEXHol2M2wXJaaV3sl7tqq2bsZ62RKjEY3kEUKdvobjNKUNowCLgiMR83QODX45ztlh7Qcz5QXOtCpl6WZ9XxyPDWliDUtkRfaHxbKIPYc789YVm0q8CdD8gMuAtwc3bpq-0NWYyqj3UmS31iQAakb51Gj48iZEST0K7fZHtcFyRnB5MDUURo_Upu-zEDwKDiivrbs_401U8op9lljJ1gL7FUNyzr1Jcp64fumXE08HrqMyunacyULSI71g_Emj1UU03chTF7NXV12tvk4378P76WpiSFE0Z3Kpersvum959U6Wx7OzJoNew" \
-H "Access-Token: 714f57a6cbedda63a9bd9f18d748ba108200cff058217d35621c17cf2790b9ef1487c905020c61bcb76c3bd1f4a17acd3bb18ada44ff9a3a2bd625580ce19224" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 718" \
-X GET "https://your.connector.url/api/priora/v1/trusted_beneficiaries"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNzE0Nzg2NTkwfQ.eBXOLUn5sQ1bK_NSFhFlSIhlQF_oOyvEXHol2M2wXJaaV3sl7tqq2bsZ62RKjEY3kEUKdvobjNKUNowCLgiMR83QODX45ztlh7Qcz5QXOtCpl6WZ9XxyPDWliDUtkRfaHxbKIPYc789YVm0q8CdD8gMuAtwc3bpq-0NWYyqj3UmS31iQAakb51Gj48iZEST0K7fZHtcFyRnB5MDUURo_Upu-zEDwKDiivrbs_401U8op9lljJ1gL7FUNyzr1Jcp64fumXE08HrqMyunacyULSI71g_Emj1UU03chTF7NXV12tvk4378P76WpiSFE0Z3Kpersvum959U6Wx7OzJoNew" \
-H "Access-Token: 714f57a6cbedda63a9bd9f18d748ba108200cff058217d35621c17cf2790b9ef1487c905020c61bcb76c3bd1f4a17acd3bb18ada44ff9a3a2bd625580ce19224" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Client-Id: 718" \
-X GET "https://your.connector.url/api/priora/v1/trusted_beneficiaries"
Example of request parameters
{"data":{},"exp":1574093210}
{"data":{},"exp":1574093210}
Example of response
{"data":[{"id":"705","alias_name":"Example Name","payment_type":"PSD_AISP","identifiers":{"from_account":"*****111","to_account":"*****222","description":"*****tion"}}]}
{"data":[{"id":"705","alias_name":"Example Name","payment_type":"PSD_AISP","identifiers":{"from_account":"*****111","to_account":"*****222","description":"*****tion"}}]}
Request
GET
https://your.connector.url/api/priora/v1/trusted_beneficiaries
Headers
Unpacked Request Authorization
hash, required
Wrapper for the data.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
Response headers
Response
Fetch all data relevant to trusted beneficiaries. Response of this action should contain a corresponding trusted beneficiary object in JSON format.
array, required
Wrapper for the data.
Can raise:
RequestFormatInvalid
string, required
Trusted Beneficiary identifier on Connector's side.
string, required
Any human-readable description that is used to identify the trusted beneficiary on TPP side.
string, required
Specifies the type of payment associated with a preregistered template.
hash, required
Object which maps the field of related payment template with its masked value. The value can be also empty.
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.eyJkYXRhIjp7InJlcXVlc3QiOnsibWV0aG9kIjoiZGVsZXRlIiwidXJsIjoiaHR0cHM6Ly91c2VyLndpbGwuYmUvcmVkaXJlY3RlZC9oZXJlIiwiaGVhZGVycyI6e319LCJlcnJvciI6eyJlcnJvcl9tZXNzYWdlIjoic29tZXRoaW5nIHdlbnQgd3JvbmciLCJlcnJvcl9jbGFzcyI6IkludGVybmFsUHJvdmlkZXJFcnJvciJ9fSwiZXhwIjoxNzE0Nzg2NTkxfQ.PiU6e7MUWdutaDYhj5DkF6fp_XJpJjE33hbs0l517JjKjwIr1MRFQgQIX5F8ONJlgWqPQolc6jM8ga0riHYGE4lNLzeXcY4iscAx0mJsevzgp1g2nYrXtyi0Ekb-a8YMHn2hkz2l48osEOl4lD6BDVC2uTwDDUhEjRko6Tlt5scirYRK0oh3OCGyGfAEA89zKMt5Iw32BEdQROfUC7yDBCpyQB8zRDdrVHKJYAuXQx4oZ_PCrviU1oGFq63x7q2sjhdH_1khmN5u3g_C0rpTbEO7_jj4-QHYLA3Cj2a4dEfxHs7rNLVaWa4xcC8C7VyWD2G7NlhvmRTEfwCvJohaRg" \
-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"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InJlcXVlc3QiOnsibWV0aG9kIjoiZGVsZXRlIiwidXJsIjoiaHR0cHM6Ly91c2VyLndpbGwuYmUvcmVkaXJlY3RlZC9oZXJlIiwiaGVhZGVycyI6e319LCJlcnJvciI6eyJlcnJvcl9tZXNzYWdlIjoic29tZXRoaW5nIHdlbnQgd3JvbmciLCJlcnJvcl9jbGFzcyI6IkludGVybmFsUHJvdmlkZXJFcnJvciJ9fSwiZXhwIjoxNzE0Nzg2NTkxfQ.PiU6e7MUWdutaDYhj5DkF6fp_XJpJjE33hbs0l517JjKjwIr1MRFQgQIX5F8ONJlgWqPQolc6jM8ga0riHYGE4lNLzeXcY4iscAx0mJsevzgp1g2nYrXtyi0Ekb-a8YMHn2hkz2l48osEOl4lD6BDVC2uTwDDUhEjRko6Tlt5scirYRK0oh3OCGyGfAEA89zKMt5Iw32BEdQROfUC7yDBCpyQB8zRDdrVHKJYAuXQx4oZ_PCrviU1oGFq63x7q2sjhdH_1khmN5u3g_C0rpTbEO7_jj4-QHYLA3Cj2a4dEfxHs7rNLVaWa4xcC8C7VyWD2G7NlhvmRTEfwCvJohaRg" \
-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}
{"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
Unpacked Request Authorization
hash, required
Wrapper for the data.
hash, required
Wrapper for the following data: url, method, headers.
string, required
Original method of the request.
Allowed values:
get, post, put, delete
url, required
Original url of the request.
hash, required
Original headers of the request including Authorization header.
hash, required
Wrapper for the following data error_class, error_message.
string, required
Class of failure.
string, required
Conveys the reason of failure in human readable text.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
Response headers
Response
Upon successful request, 200 status code should be returned.
Payments
Success
Success callback should be used when all verification procedures have passed and the payment has been carried out.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByaW9yYV9wYXltZW50X2lkIjoxMzQsInBheW1lbnRfaWQiOiI1NTEiLCJleHRyYSI6e319LCJleHAiOjE3MTQ3ODY1OTF9.CqCdhQqnl-7vuvmLS6249y5VVe5b3EZoUhQCUjpJziyJlGAV33GagIpwfSjds70qgeJNTqGdt-i8Ful7cXk2f3dcJWVftK4FKzdTUFr2ZzMaohjNz9GmLzAD5SlN5r_jgrZ5EI9Eo2bCypSKEYP9fBl74H7p8wzsADkFc90viHbMxeKJ3JqHLbkqRGr8dewsuqakhoZ7dkjJc12KqwTMm0TT8prj3LXV44Pk6RLnunXOn2v3JtKp-0Z8xlUvRT_lQf6LjG6sWStzHYITt7-AENcGLJk4aN7fH7je1fK-3BOkfZccQdhvOtlShh0xJCmEaCXv2WOP-EqQp0px5QbK7Q" \
-H "App-Id: KwQ2u8Nn3XKEu0xcMbAPUQ" \
-H "App-Secret: bzTIvz_hEpQ-AAdw4Un4Xg" \
-X POST "/api/connectors/v1/payments/success"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByaW9yYV9wYXltZW50X2lkIjoxMzQsInBheW1lbnRfaWQiOiI1NTEiLCJleHRyYSI6e319LCJleHAiOjE3MTQ3ODY1OTF9.CqCdhQqnl-7vuvmLS6249y5VVe5b3EZoUhQCUjpJziyJlGAV33GagIpwfSjds70qgeJNTqGdt-i8Ful7cXk2f3dcJWVftK4FKzdTUFr2ZzMaohjNz9GmLzAD5SlN5r_jgrZ5EI9Eo2bCypSKEYP9fBl74H7p8wzsADkFc90viHbMxeKJ3JqHLbkqRGr8dewsuqakhoZ7dkjJc12KqwTMm0TT8prj3LXV44Pk6RLnunXOn2v3JtKp-0Z8xlUvRT_lQf6LjG6sWStzHYITt7-AENcGLJk4aN7fH7je1fK-3BOkfZccQdhvOtlShh0xJCmEaCXv2WOP-EqQp0px5QbK7Q" \
-H "App-Id: KwQ2u8Nn3XKEu0xcMbAPUQ" \
-H "App-Secret: bzTIvz_hEpQ-AAdw4Un4Xg" \
-X POST "/api/connectors/v1/payments/success"
Example of request parameters
{"data":{"priora_payment_id":134,"payment_id":"551","extra":{}},"exp":1574093208}
{"data":{"priora_payment_id":134,"payment_id":"551","extra":{}},"exp":1574093208}
Example of response
{"data":{},"meta":{"time":"2019-11-18T16:04:48.418Z"}}
{"data":{},"meta":{"time":"2019-11-18T16:04:48.418Z"}}
Request
POST
/api/connectors/v1/payments/success
Headers
Unpacked Request Authorization
hash, required
Wrapper for the data.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
Can raise:
PaymentNotFound, SessionExpired, SessionClosed
string, required
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
hash, optional
Extra details that should persist in the session.
Default value:
{}
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.
hash, optional
Wrapper for the data.
hash, optional
Wrapper for the response metadata.
datetime, required
Time when the request was processed.
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.
PaymentNotFound
404
Payment 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.
Update
Update callback may be called multiple times in order to request multiple steps of authorization or to send other updates to Sale Edge PSD2 Compliance session.
CURL
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBheW1lbnRfaWQiOiI1NTAiLCJwcmlvcmFfcGF5bWVudF9pZCI6MjI4LCJleHRyYSI6e30sImV4cGlyZXNfYXQiOiIyMDE5LTExLTE4VDE2OjA5OjQ4LjUxNFoiLCJzdGF0dXMiOiJleGVjdXRpbmcifSwiZXhwIjoxNzE0Nzg2NTkyfQ.LXWsyk3fQZubKUiCQHqYCs0-_LRn6VzFSLxwsBOIG9gDHsAftYrfjt55jRGKtN0lXBipxTgs3hkrflDqUot-gp1ri60WPQ4iO5Vu5cyzxzfT1b0uWtcy1e__wjIk6rd2orETRInf1iWDXHTOvOF_9x0mAdKUGnKctOmXAgY4G0zxeFiQooPySJvZOvkk485ro7A1_3-RIqlS2JAMl3FJFAcPXh0e1VN-a8l9VgPfajQN2K35jIXKD95OeBhto5g3ddTbFZviuHO5sEhU65q-I7gwdO3t1M4Q66Eh2ehxj_etyhM4K7UDv8L3MAgwEsgqkqBLqgrboxySzJU15x7y-A" \
-H "App-Id: zDyFXCDE217MvWKQg1-h7w" \
-H "App-Secret: ri05Whlc9Nb0Rz5Y6PDFKw" \
-X POST "/api/connectors/v1/payments/update"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBheW1lbnRfaWQiOiI1NTAiLCJwcmlvcmFfcGF5bWVudF9pZCI6MjI4LCJleHRyYSI6e30sImV4cGlyZXNfYXQiOiIyMDE5LTExLTE4VDE2OjA5OjQ4LjUxNFoiLCJzdGF0dXMiOiJleGVjdXRpbmcifSwiZXhwIjoxNzE0Nzg2NTkyfQ.LXWsyk3fQZubKUiCQHqYCs0-_LRn6VzFSLxwsBOIG9gDHsAftYrfjt55jRGKtN0lXBipxTgs3hkrflDqUot-gp1ri60WPQ4iO5Vu5cyzxzfT1b0uWtcy1e__wjIk6rd2orETRInf1iWDXHTOvOF_9x0mAdKUGnKctOmXAgY4G0zxeFiQooPySJvZOvkk485ro7A1_3-RIqlS2JAMl3FJFAcPXh0e1VN-a8l9VgPfajQN2K35jIXKD95OeBhto5g3ddTbFZviuHO5sEhU65q-I7gwdO3t1M4Q66Eh2ehxj_etyhM4K7UDv8L3MAgwEsgqkqBLqgrboxySzJU15x7y-A" \
-H "App-Id: zDyFXCDE217MvWKQg1-h7w" \
-H "App-Secret: ri05Whlc9Nb0Rz5Y6PDFKw" \
-X POST "/api/connectors/v1/payments/update"
Example of request parameters
{"data":{"priora_payment_id":324,"extra":{"redirect_url":"https://user.will.be/redirected/here"},"payment_id":"893","expires_at":"2019-11-18T16:09:48.514Z","status":"redirect"},"exp":1574093208}
{"data":{"priora_payment_id":324,"extra":{"redirect_url":"https://user.will.be/redirected/here"},"payment_id":"893","expires_at":"2019-11-18T16:09:48.514Z","status":"redirect"},"exp":1574093208}
{"data":{"payment_id":"550","priora_payment_id":228,"extra":{},"expires_at":"2019-11-18T16:09:48.514Z","status":"executing"},"exp":1574093208}
{"data":{"payment_id":"550","priora_payment_id":228,"extra":{},"expires_at":"2019-11-18T16:09:48.514Z","status":"executing"},"exp":1574093208}
{"exp":1574093208,"data":{"payment_id":"332","extra":{},"interactive_step_instruction":{"instruction":{},"interactive_field":"sms_pincode"},"priora_payment_id":380,"expires_at":"2019-11-18T16:09:48.514Z","status":"waiting_confirmation_code"}}
{"exp":1574093208,"data":{"payment_id":"332","extra":{},"interactive_step_instruction":{"instruction":{},"interactive_field":"sms_pincode"},"priora_payment_id":380,"expires_at":"2019-11-18T16:09:48.514Z","status":"waiting_confirmation_code"}}
{"data":{"payment_id":"166","priora_payment_id":968,"extra":{},"expires_at":"2019-11-18T16:09:48.515Z","status":"executing"},"exp":1574093208}
{"data":{"payment_id":"166","priora_payment_id":968,"extra":{},"expires_at":"2019-11-18T16:09:48.515Z","status":"executing"},"exp":1574093208}
Example of response
{"data":{},"meta":{"time":"2019-11-18T16:04:48.491Z"}}
{"data":{},"meta":{"time":"2019-11-18T16:04:48.491Z"}}
Request
POST
/api/connectors/v1/payments/update
Headers
Unpacked Request Authorization
Oauth Mfa
Oauth Other Actions
Embedded Mfa
Embedded Other Actions
hash, required
Wrapper for the data.
datetime, optional
Payment's session expiration.
Default value:
5 minutes from now
string, required
Conveys current status of the operation.
Allowed values:
redirect
string, required
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
Can raise:
PaymentNotFound, SessionExpired, SessionClosed
hash, required
Extra details that should persist in the session.
url, required
The URL on which PSU should be redirected by TPP in order to perform authentication.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Payment's session expiration.
Default value:
5 minutes from now
string, required
Conveys current status of the operation.
Allowed values:
waiting_confirmation, executing
string, required
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
Can raise:
PaymentNotFound, SessionExpired, SessionClosed
hash, optional
Extra details that should persist in the session.
Default value:
{}
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Payment's session expiration.
Default value:
5 minutes from now
string, required
Conveys current status of the operation.
Allowed values:
waiting_confirmation_code
string, required
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
Can raise:
PaymentNotFound, SessionExpired, SessionClosed
hash, optional
Extra details that should persist in the session.
Default value:
{}
interactive_step_instruction
hash, required
Object which maps the field with interactive field and it's instruction.
string, required
Interactive step instruction.
string, required
MFA interactive field name.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Payment's session expiration.
Default value:
5 minutes from now
string, required
Conveys current status of the operation.
Allowed values:
waiting_confirmation, executing
string, required
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
Can raise:
PaymentNotFound, SessionExpired, SessionClosed
hash, optional
Extra details that should persist in the session.
Default value:
{}
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.
hash, optional
Wrapper for the data.
hash, optional
Wrapper for the response metadata.
datetime, required
Time when the request was processed.
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.
PaymentNotFound
404
Payment 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.
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.eyJkYXRhIjp7InBheW1lbnRfaWQiOiIzMzkiLCJlcnJvcl9tZXNzYWdlIjoiU29tZXRoaW5nIHdlbnQgd3JvbmcuIiwiZXJyb3JfY2xhc3MiOiJJbnRlcm5hbFByb3ZpZGVyRXJyb3IiLCJleHRyYSI6e30sInByaW9yYV9wYXltZW50X2lkIjoyNDF9LCJleHAiOjE3MTQ3ODY1OTJ9.YUJFNlvMZjuiYoH0xVDaPK8_89BxjZBct-eEPg6nGYPE7Uisn1NNUL5d9u7YFLCMpm0GtId45uAJX1XTr108Qxd4YTAcOxunfe3hkYWhIYqTPvWvf4uONqYxuyjc4RgqglXW5DlryJs5DJ0pZePC--hFmVbXpgV73YR-8nu8wCSlcWOMXix91_r3GkontdgodB5FBpf-LDRLwcM_TadZSqs2_R_2_4jT7POSCQSY5LZsvNLWWArNViqav9Vgei_oLnPk4rNqjzoh9jLc5Ww7FQyjwrh3WQN5_crGe41Y0nbOGfNcyJmZtV1EwNd4wKQ2nRDj11vft0hobhvS4KV4tw" \
-H "App-Id: 5qNBNdE2YhZViFumcu-RFA" \
-H "App-Secret: nsI4wPpMeAyBWGYNSresIQ" \
-X POST "/api/connectors/v1/payments/fail"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InBheW1lbnRfaWQiOiIzMzkiLCJlcnJvcl9tZXNzYWdlIjoiU29tZXRoaW5nIHdlbnQgd3JvbmcuIiwiZXJyb3JfY2xhc3MiOiJJbnRlcm5hbFByb3ZpZGVyRXJyb3IiLCJleHRyYSI6e30sInByaW9yYV9wYXltZW50X2lkIjoyNDF9LCJleHAiOjE3MTQ3ODY1OTJ9.YUJFNlvMZjuiYoH0xVDaPK8_89BxjZBct-eEPg6nGYPE7Uisn1NNUL5d9u7YFLCMpm0GtId45uAJX1XTr108Qxd4YTAcOxunfe3hkYWhIYqTPvWvf4uONqYxuyjc4RgqglXW5DlryJs5DJ0pZePC--hFmVbXpgV73YR-8nu8wCSlcWOMXix91_r3GkontdgodB5FBpf-LDRLwcM_TadZSqs2_R_2_4jT7POSCQSY5LZsvNLWWArNViqav9Vgei_oLnPk4rNqjzoh9jLc5Ww7FQyjwrh3WQN5_crGe41Y0nbOGfNcyJmZtV1EwNd4wKQ2nRDj11vft0hobhvS4KV4tw" \
-H "App-Id: 5qNBNdE2YhZViFumcu-RFA" \
-H "App-Secret: nsI4wPpMeAyBWGYNSresIQ" \
-X POST "/api/connectors/v1/payments/fail"
Example of request parameters
{"data":{"payment_id":"339","error_message":"Something went wrong.","error_class":"InternalProviderError","extra":{},"priora_payment_id":241},"exp":1574093208}
{"data":{"payment_id":"339","error_message":"Something went wrong.","error_class":"InternalProviderError","extra":{},"priora_payment_id":241},"exp":1574093208}
Example of response
{"data":{},"meta":{"time":"2019-11-18T16:04:48.351Z"}}
{"data":{},"meta":{"time":"2019-11-18T16:04:48.351Z"}}
Request
POST
/api/connectors/v1/payments/fail
Headers
Unpacked Request Authorization
hash, required
Wrapper for the data.
integer, required
Identifier of the corresponding payment on Salt Edge PSD2 Compliance side.
Can raise:
PaymentNotFound, SessionExpired, SessionClosed
string, optional
Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
string, optional
Conveys the reason of failure in human readable text.
Default value:
Something went wrong.
string, optional
Class of failure.
Default value:
InternalProviderError
hash, optional
Extra details that should persist in the session.
Default value:
{}
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.
hash, optional
Wrapper for the data.
hash, optional
Wrapper for the response metadata.
datetime, required
Time when the request was processed.
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.
PaymentNotFound
404
Payment 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.
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.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiV3VSQ2p1Zlg5b1Z5eW12UFFRaV8iLCJiZW5lZmljaWFyeV9pZCI6IjQ5NCIsImlkZW50aWZpZXJzIjp7fX0sImV4cCI6MTcxNDc4NjU5Mn0.ETWjSklWTUnJygBD_hov9nVxeSTgCuUlfn7pukWuapPeMWIZO93rUyM7nvE7txTc9haAVnuEYKUCPvzSDwd_on0QLPEMehmDmYphJS4JIMMDGu76yLx1SS_GXeeASMIFrey7FKp8GbIa5a_QkZpoUvhMiEEiIjP5GtHP2KnIAK4ctcmDnGruqogQM_jKWmRoZbZ47AYpMXtIj66nRDbCYM-x-VpaD3-h3HRDufH6AcgivhvqHB_BL25J1nYbTovR2ESshkrLBlgB3jzyZk_qzK1CR9t3jDJSBcdkFPkWdVZIrWqQqB-B1c8txqzfiwOIjExqPvADWQPzwVW97pS5aA" \
-H "App-Id: qjQYP-jCx-8FBsZSgNVzIw" \
-H "App-Secret: -XeeN2UhtdphUGtI-FZpzg" \
-X POST "/api/connectors/v1/sessions/success"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiV3VSQ2p1Zlg5b1Z5eW12UFFRaV8iLCJiZW5lZmljaWFyeV9pZCI6IjQ5NCIsImlkZW50aWZpZXJzIjp7fX0sImV4cCI6MTcxNDc4NjU5Mn0.ETWjSklWTUnJygBD_hov9nVxeSTgCuUlfn7pukWuapPeMWIZO93rUyM7nvE7txTc9haAVnuEYKUCPvzSDwd_on0QLPEMehmDmYphJS4JIMMDGu76yLx1SS_GXeeASMIFrey7FKp8GbIa5a_QkZpoUvhMiEEiIjP5GtHP2KnIAK4ctcmDnGruqogQM_jKWmRoZbZ47AYpMXtIj66nRDbCYM-x-VpaD3-h3HRDufH6AcgivhvqHB_BL25J1nYbTovR2ESshkrLBlgB3jzyZk_qzK1CR9t3jDJSBcdkFPkWdVZIrWqQqB-B1c8txqzfiwOIjExqPvADWQPzwVW97pS5aA" \
-H "App-Id: qjQYP-jCx-8FBsZSgNVzIw" \
-H "App-Secret: -XeeN2UhtdphUGtI-FZpzg" \
-X POST "/api/connectors/v1/sessions/success"
Example of request parameters
{"exp":1574093208,"data":{"token_expires_at":"2019-11-18T16:04:48.798Z","extra":{},"consent":[{"account_id":"756","scopes":["balance","transactions"]}],"token":"j1Ngh7AroM1AqtR1_Psd","session_secret":"tUxQZRj9CohqgM_QyDTD","user_id":"523"}}
{"exp":1574093208,"data":{"token_expires_at":"2019-11-18T16:04:48.798Z","extra":{},"consent":[{"account_id":"756","scopes":["balance","transactions"]}],"token":"j1Ngh7AroM1AqtR1_Psd","session_secret":"tUxQZRj9CohqgM_QyDTD","user_id":"523"}}
{"data":{"session_secret":"GcQ_1uqmkxYTK1XWQ2u3","token":"aiyuTTgpa4JvwQeKhDzf","token_expires_at":"2019-11-18T16:04:48.799Z"},"exp":1574093208}
{"data":{"session_secret":"GcQ_1uqmkxYTK1XWQ2u3","token":"aiyuTTgpa4JvwQeKhDzf","token_expires_at":"2019-11-18T16:04:48.799Z"},"exp":1574093208}
{"data":{"session_secret":"bUhpHcLWvxq7yx19REbd","funds_available":true},"exp":1574093208}
{"data":{"session_secret":"bUhpHcLWvxq7yx19REbd","funds_available":true},"exp":1574093208}
{"data":{"session_secret":"WuRCjufX9oVyymvPQQi_","beneficiary_id":"494","identifiers":{}},"exp":1574093208}
{"data":{"session_secret":"WuRCjufX9oVyymvPQQi_","beneficiary_id":"494","identifiers":{}},"exp":1574093208}
{"data":{"session_secret":"yPsetCyP7cGznvb9ZEDQ"},"exp":1574093208}
{"data":{"session_secret":"yPsetCyP7cGznvb9ZEDQ"},"exp":1574093208}
{"data":{"session_secret":"yWPDKLKzoBf9HnJ7JKrt"},"exp":1574093208}
{"data":{"session_secret":"yWPDKLKzoBf9HnJ7JKrt"},"exp":1574093208}
Example of response
{"data":{},"meta":{"time":"2019-11-18T16:04:48.773Z"}}
{"data":{},"meta":{"time":"2019-11-18T16:04:48.773Z"}}
Request
POST
/api/connectors/v1/sessions/success
Headers
Unpacked Request Authorization
Create Token
Reconnect Token
Check Funds
Create Trusted Beneficiaries
Refresh Accounts
Revoke Token
hash, required
Wrapper for the data.
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, required
PSU identifier on Connector side. Used to map PSU resource on Salt Edge PSD2 Compliance side to Connector one.
string, required
Access token that will be used to access ASPSP data. Token is an unique value which is linked to authenticated user.
datetime, required
Token expiry date.
hash, optional
Extra details that should persist in the session.
Default value:
{}
array, optional
Wrapper of consent.
Default value:
[{:account_id=>"all", :scopes=>["balance", "transactions"]}]
string, required
Account ID.
array, required
Set of permissions for access token.
Allowed values:
balance, transactions
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, required
Access token that will be used to access ASPSP data. Token is an unique value which is linked to authenticated user.
datetime, required
Token expiry date.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
boolean, required
Response whether account has sufficient funds of not.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, required
Trusted Beneficiary identifier.
hash, optional
Object which maps the field of related payment template with its masked value. The value can be also empty.
Default value:
{}
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
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.
hash, optional
Wrapper for the data.
hash, optional
Wrapper for the response metadata.
datetime, required
Time when the request was processed.
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.eyJkYXRhIjp7InNlc3Npb25fZXhwaXJlc19hdCI6IjIwMTktMTEtMThUMTY6MDk6NDguODcyWiIsInNlc3Npb25fc2VjcmV0IjoiSHMteGM4b3pBV0xrMXh0X3pUNHYiLCJzdGF0dXMiOiJ3YWl0aW5nX2NvbmZpcm1hdGlvbl9jb2RlIiwiZXh0cmEiOnt9fSwiZXhwIjoxNzE0Nzg2NTkzfQ.TZyzKHk62mj202ZyqadkrpciVVfC84Y6lGVWOPbATKr86hCrPJGMZo8mdo92JPq4yIOPicTkzTNmNtI7HTsowMCqxU5pNCSNQ620lURvdvPFr16zNbhpoEwnN3prbUX6ey_p6X1lHnwyDQpudEGt97iiHEbR3CFcGeN24cOoNRu2VLdiomzHVL6TmhuLTOEWrXGVmYyU_p7VF7NtIOFIL6c62mFl9oQOaDNpjLAiFWrUqM4L4W_sjQ_lSJYIMh9c4Njhwjf60ow8STqBYWV1RYdPsIvm4SxR6ARHdw6ltSL8Sz3IkRyItuekKm7Pu4Ek0615VAwA3lZMKjVaXVP-DA" \
-H "App-Id: q5QE7Dqlpm1d5weLS5pn7w" \
-H "App-Secret: y8imt1cgG8x2zmBMrF-oxw" \
-X POST "/api/connectors/v1/sessions/update"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fZXhwaXJlc19hdCI6IjIwMTktMTEtMThUMTY6MDk6NDguODcyWiIsInNlc3Npb25fc2VjcmV0IjoiSHMteGM4b3pBV0xrMXh0X3pUNHYiLCJzdGF0dXMiOiJ3YWl0aW5nX2NvbmZpcm1hdGlvbl9jb2RlIiwiZXh0cmEiOnt9fSwiZXhwIjoxNzE0Nzg2NTkzfQ.TZyzKHk62mj202ZyqadkrpciVVfC84Y6lGVWOPbATKr86hCrPJGMZo8mdo92JPq4yIOPicTkzTNmNtI7HTsowMCqxU5pNCSNQ620lURvdvPFr16zNbhpoEwnN3prbUX6ey_p6X1lHnwyDQpudEGt97iiHEbR3CFcGeN24cOoNRu2VLdiomzHVL6TmhuLTOEWrXGVmYyU_p7VF7NtIOFIL6c62mFl9oQOaDNpjLAiFWrUqM4L4W_sjQ_lSJYIMh9c4Njhwjf60ow8STqBYWV1RYdPsIvm4SxR6ARHdw6ltSL8Sz3IkRyItuekKm7Pu4Ek0615VAwA3lZMKjVaXVP-DA" \
-H "App-Id: q5QE7Dqlpm1d5weLS5pn7w" \
-H "App-Secret: y8imt1cgG8x2zmBMrF-oxw" \
-X POST "/api/connectors/v1/sessions/update"
Example of request parameters
{"data":{"session_expires_at":"2019-11-18T16:09:48.872Z","session_secret":"Hs-xc8ozAWLk1xt_zT4v","status":"waiting_confirmation_code","extra":{}},"exp":1574093208}
{"data":{"session_expires_at":"2019-11-18T16:09:48.872Z","session_secret":"Hs-xc8ozAWLk1xt_zT4v","status":"waiting_confirmation_code","extra":{}},"exp":1574093208}
{"data":{"extra":{},"interactive_step_instruction":{"instruction":{},"interactive_field":"sms_pincode"},"status":"waiting_confirmation_code","session_expires_at":"2020-03-02T15:37:30.923Z","session_secret":"Hs-xc8ozAWLk1xt_zT4v"},"exp":1574093208}
{"data":{"extra":{},"interactive_step_instruction":{"instruction":{},"interactive_field":"sms_pincode"},"status":"waiting_confirmation_code","session_expires_at":"2020-03-02T15:37:30.923Z","session_secret":"Hs-xc8ozAWLk1xt_zT4v"},"exp":1574093208}
{"data":{"extra":{},"interactive_step_instruction":{"instruction":{},"interactive_field":"sms_pincode"},"status":"waiting_confirmation_code","session_expires_at":"2020-03-02T15:37:30.923Z","session_secret":"Hs-xc8ozAWLk1xt_zT4v"},"exp":1574093208}
{"data":{"extra":{},"interactive_step_instruction":{"instruction":{},"interactive_field":"sms_pincode"},"status":"waiting_confirmation_code","session_expires_at":"2020-03-02T15:37:30.923Z","session_secret":"Hs-xc8ozAWLk1xt_zT4v"},"exp":1574093208}
{"data":{"session_secret":"Hs-xc8ozAWLk1xt_zT4v","status":"redirect","extra":{"redirect_url":"https://user.will.be/redirected/here"},"session_expires_at":"2020-03-05T16:44:19.977Z"},"exp":1574093208}
{"data":{"session_secret":"Hs-xc8ozAWLk1xt_zT4v","status":"redirect","extra":{"redirect_url":"https://user.will.be/redirected/here"},"session_expires_at":"2020-03-05T16:44:19.977Z"},"exp":1574093208}
{"data":{"session_secret":"Hs-xc8ozAWLk1xt_zT4v","user_id":"245","status":"redirect","extra":{"redirect_url":"https://user.will.be/redirected/here"},"session_expires_at":"2020-03-02T15:37:30.924Z"},"exp":1574093208}
{"data":{"session_secret":"Hs-xc8ozAWLk1xt_zT4v","user_id":"245","status":"redirect","extra":{"redirect_url":"https://user.will.be/redirected/here"},"session_expires_at":"2020-03-02T15:37:30.924Z"},"exp":1574093208}
{"data":{"session_secret":"Hs-xc8ozAWLk1xt_zT4v","extra":{},"user_id":"245","status":"waiting_confirmation_code","session_expires_at":"2020-03-02T15:37:30.924Z"},"exp":1574093208}
{"data":{"session_secret":"Hs-xc8ozAWLk1xt_zT4v","extra":{},"user_id":"245","status":"waiting_confirmation_code","session_expires_at":"2020-03-02T15:37:30.924Z"},"exp":1574093208}
Example of response
{"data":{},"meta":{"time":"2019-11-18T16:04:48.853Z"}}
{"data":{},"meta":{"time":"2019-11-18T16:04:48.853Z"}}
Request
POST
/api/connectors/v1/sessions/update
Headers
Unpacked Request Authorization
Other
Embedded Trusted Beneficiary
Embedded Refresh Acccounts
Oauth Refresh Acccounts
Create Token Oauth
Create Token Embedded
hash, required
Wrapper for the data.
datetime, optional
Session expiry time.
Default value:
5 minutes from now
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, required
Conveys current status of the operation.
Allowed values:
redirect, waiting_confirmation_code
hash, optional
Extra details that should persist in the session.
Default value:
{}
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Session expiry time.
Default value:
5 minutes from now
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, required
Conveys current status of the operation.
Allowed values:
waiting_confirmation_code
hash, optional
Extra details that should persist in the session.
Default value:
{}
interactive_step_instruction
hash, required
Object which maps the field with interactive field and it's instruction.
string, required
Interactive step instruction.
string, required
MFA interactive field name.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Session expiry time.
Default value:
5 minutes from now
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, required
Conveys current status of the operation.
Allowed values:
waiting_confirmation_code
hash, optional
Extra details that should persist in the session.
Default value:
{}
interactive_step_instruction
hash, required
Object which maps the field with interactive field and it's instruction.
string, required
Interactive step instruction.
string, required
MFA interactive field name.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Session expiry time.
Default value:
5 minutes from now
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, required
Conveys current status of the operation.
Allowed values:
redirect
hash, required
Extra details that should persist in the session.
url, required
The URL on which PSU should be redirected by TPP in order to perform authentication.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Session expiry time.
Default value:
5 minutes from now
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, optional
PSU identifier on Connector side. Used to map PSU resource on Salt Edge PSD2 Compliance side to Connector one.
string, required
Conveys current status of the operation.
Allowed values:
redirect
hash, required
Extra details that should persist in the session.
url, required
The URL on which PSU should be redirected by TPP in order to perform authentication.
integer, required
The lifetime of the request in timestamp UTC format.
Values greater than:
Current time.
hash, required
Wrapper for the data.
datetime, optional
Session expiry time.
Default value:
5 minutes from now
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, optional
PSU identifier on Connector side. Used to map PSU resource on Salt Edge PSD2 Compliance side to Connector one.
string, required
Conveys current status of the operation.
Allowed values:
waiting_confirmation_code
hash, optional
Extra details that should persist in the session.
Default value:
{}
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.
hash, optional
Wrapper for the data.
hash, optional
Wrapper for the response metadata.
datetime, required
Time when the request was processed.
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.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiM1BRaXB1RFBvV3BhMTFGY1ZFVjYiLCJlcnJvcl9jbGFzcyI6IkludGVybmFsUHJvdmlkZXJFcnJvciIsImVycm9yX21lc3NhZ2UiOiJJbnRlcm5hbCBlcnJvciIsImV4dHJhIjp7fX0sImV4cCI6MTcxNDc4NjU5M30.QlVUlqp8RdI_32ymtBVfgJT8s1hObD1FdqWZNJTW2lqa_4daIaqcwK7onl9SrYi-y2sQiH7iZk8X_jwmf719uWb7smuKR_9Ll8nqVGyaQtPEF4J5mPYI7Y37A6BWknS2f0DUbswrFN-446Juf_hGJhVt1IDQGqvmRuJIFxiGG5R6CwKN_9_QNdtgkElQUZe9covFJSZD1Uhqa3g9EDYx1eOs0qrjYrYjiBBHb1pIFakA2Zs3GmL6A_wHFnyLBoJqexQHO4CDpCwsogze0etT62kbzUazNaO3RH-GeHhasPOFHsXAx4enwSEDRLmEYxdoXy_jFPA3nxwKBZrB0b8u9Q" \
-H "App-Id: xU7SyhPrd95GAPSMNo_XMQ" \
-H "App-Secret: BVSkESo7zpRdzk_hWUUwCQ" \
-X POST "/api/connectors/v1/sessions/fail"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InNlc3Npb25fc2VjcmV0IjoiM1BRaXB1RFBvV3BhMTFGY1ZFVjYiLCJlcnJvcl9jbGFzcyI6IkludGVybmFsUHJvdmlkZXJFcnJvciIsImVycm9yX21lc3NhZ2UiOiJJbnRlcm5hbCBlcnJvciIsImV4dHJhIjp7fX0sImV4cCI6MTcxNDc4NjU5M30.QlVUlqp8RdI_32ymtBVfgJT8s1hObD1FdqWZNJTW2lqa_4daIaqcwK7onl9SrYi-y2sQiH7iZk8X_jwmf719uWb7smuKR_9Ll8nqVGyaQtPEF4J5mPYI7Y37A6BWknS2f0DUbswrFN-446Juf_hGJhVt1IDQGqvmRuJIFxiGG5R6CwKN_9_QNdtgkElQUZe9covFJSZD1Uhqa3g9EDYx1eOs0qrjYrYjiBBHb1pIFakA2Zs3GmL6A_wHFnyLBoJqexQHO4CDpCwsogze0etT62kbzUazNaO3RH-GeHhasPOFHsXAx4enwSEDRLmEYxdoXy_jFPA3nxwKBZrB0b8u9Q" \
-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}
{"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"}}
{"data":{},"meta":{"time":"2019-11-18T16:04:48.710Z"}}
Request
POST
/api/connectors/v1/sessions/fail
Headers
Unpacked Request Authorization
hash, required
Wrapper for the data.
string, required
Session identifier in Salt Edge PSD2 Compliance.
Can raise:
SessionNotFound, SessionClosed, SessionExpired, ActionNotAllowed
string, optional
Class of failure.
Default value:
InternalProviderError
string, optional
Conveys the reason of failure in human readable text.
Default value:
Internal error
hash, optional
Extra details that should persist in the session.
Default value:
{}
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.
hash, optional
Wrapper for the data.
hash, optional
Wrapper for the response metadata.
datetime, required
Time when the request was processed.
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.
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.eyJkYXRhIjp7ImNsaWVudF9pZCI6NTE3fSwiZXhwIjoxNzE0Nzg2NTkzfQ.kC8ETPAdk26z_Gh7312eURmkzlgNVh-Mygz8ip1WEvqIohgfCmSxZ8S73otm8T3Ya4RuCzU4ggQ-JD8X4iXUABPftxZhhCsxOtj_xLBr725NmpTPBb5SdEe55IwQW-tyqbRGM2iGfMhKRgxUr30Z3F336QW1daJP9lqOh5loKld0UHNT4sPqkuIZt6rKwm9yrUIEDztGIQ2pCX-lzci3cUyiMm4WwNotuF4-DDWReWaRO5g2H65769ATZdaQMSCrJSc7ZSIB-WKjR64fRbIxlwi9qjh1d5ialJjmfCPhLrZcdxs-9cyGvHAlkLxpq9d8vBZzkCg91ttmvoap01mGxg" \
-H "App-Id: hAnmNmGFFBN3W_jNWJd_fQ" \
-H "App-Secret: h6rzA_lw2wVuCpDaBKlxAA" \
-X GET "/api/connectors/v1/clients/info"
curl -i \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNsaWVudF9pZCI6NTE3fSwiZXhwIjoxNzE0Nzg2NTkzfQ.kC8ETPAdk26z_Gh7312eURmkzlgNVh-Mygz8ip1WEvqIohgfCmSxZ8S73otm8T3Ya4RuCzU4ggQ-JD8X4iXUABPftxZhhCsxOtj_xLBr725NmpTPBb5SdEe55IwQW-tyqbRGM2iGfMhKRgxUr30Z3F336QW1daJP9lqOh5loKld0UHNT4sPqkuIZt6rKwm9yrUIEDztGIQ2pCX-lzci3cUyiMm4WwNotuF4-DDWReWaRO5g2H65769ATZdaQMSCrJSc7ZSIB-WKjR64fRbIxlwi9qjh1d5ialJjmfCPhLrZcdxs-9cyGvHAlkLxpq9d8vBZzkCg91ttmvoap01mGxg" \
-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}
{"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"}}
{"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
Unpacked Request Authorization
hash, required
Wrapper for the data.
integer, required
Client application identifier.
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.
hash, optional
Wrapper for the data.
string, required
Name of TPP registered in Salt Edge PSD2 Compliance Solution.
array, required
Available permissions for TPP.
string, required
Public key of TPP extacted form him eIDAS cerfiticate. Used to decode the ‘client_jwt’ from ‘original_request’ attribute.
hash, optional
Wrapper for the response metadata.
datetime, required
Time when the request was processed.
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.
