Payments

Payment Statuses

The current stage of a payment lifecycle is represented in status field. The status of a payment can be one of the following:

Name Description
processing Salt Edge PSD2 Compliance is processing the request or response.
redirect Provider requires a redirect for authentication.
waiting_confirmation Provider is waiting for the consent of Customer.
waiting_confirmation_code Provider is waiting for a confirmation code, be it OTP for authentication or Dynamic linking for performing a payment.
closed Session is closed.

Create

Create a payment order on behalf of PSU

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwiZXh0cmEiOnt9LCJ0ZW1wbGF0ZV9pZCI6ODI0LCJwYXltZW50X2F0dHJpYnV0ZXMiOnsiZnJvbV9hY2NvdW50IjoiOTU0MjM0MjMxMiIsInRvX2FjY291bnQiOiIzNDU4OTc5NTcwIiwiYW1vdW50IjoiMTUwLjAwIiwiZGVzY3JpcHRpb24iOiJUZXN0IHBheW1lbnQuIn0sInByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayJ9LCJleHAiOjE3NjE0NTQxNzMsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.VwRnF9WdX8zeUcPj_GF2Klfq0ONScWogp46LJKvTdItRuqiYC8aeFlWFQGG4GjXSvlvDYFiCj2uIEjAu5e4nk64H_HucKuQREV0Ez9Gstjo0rIWQKncxGRFSobzIkBHokgtP5ulbFqRLbiQlJbNEbYBMv8jGtTY29cVOmZHRRab8Ar7qatARJcY7FFcZDIhqctmQ0U_0CyFi4_SOa7639msOnUIN0KKKcEZR2zm1EzBqMYNCmf4g4IeUY8fsBgcPq-zJROIVLsxpFMOYRqPdfQ1cT2o8HMiXqGz0pQmc39xpCofhtfVTPzBZnfwq5kcAala6B3zfVXWaxUHL9p9dDw" \ 
 -H "App-Id: pRhi4X5YXwmccpgmDsLb1w" \ 
 -H "App-Secret: dszz3LNHbWnqz9HnnH8DhA" \ 
 -H "Access-Token: aacd4e18fab5b180b5e3cc4d35f8600ec08e1be219e5ec9400bc819357928a9283e8d6941215742aaa127d9076496bf210044545cbc1dc00489f295024c926c8" \ 
 -H "Client-Request-Id: 17" \ 
 -X POST "/api/v2/payments"

Example of request parameters

{"data":{"redirect_url":"https://user.will.be/redirected/here","beneficiary_id":383,"force_sca":true,"extra":{},"template_id":824,"payment_attributes":{"from_account":"9542342312","to_account":"3458979570","amount":"150.00","description":"Test payment."},"provider_code":"demobank"},"exp":1574093209}

Example of response

{"data":{"status":"pending","description":"Internal payment.","fees":[{"amount":0.25,"description":"Bank fee.","currency_code":"EUR"},{"amount":0.1,"description":"Payment fee.","currency_code":"EUR"}],"updated_at":"2019-11-18T16:04:50.320Z","id":997,"payment_attributes":{"from_account":"9542342312","to_account":"3458979570","amount":"150.00","description":"Test payment."},"session":{"fail_message":"","id":611,"secret":"x2xxJojJkQ9u56EyU_NS","status":"processing","events":[{}],"success_at":"2019-11-18T16:04:50.320Z","expires_at":"2019-11-18T17:04:50.320Z","fail_at":""},"created_at":"2019-11-18T16:04:50.320Z"}}
Request

POST /api/v2/payments

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: AuthorizationMissing
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
App-Secret string, required Application’s app_secret from connection details tab.
Access-Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Request Authorization
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
TokenMissing 400 This request cannot be performed without Access_Token header.
AccessDenied 401 Action you want to perform is not allowed. More in error_message
AuthorizationMissing 401 Authorization header is missing.
TokenRevoked 401 Token specified in request is revoked and cannot be used anymore.
TokenExpired 401 Token specified in request is expired and cannot be used.
ProviderNotFound 404 Provider specified in request does not exist or cannot be retrieved.
TrustedBeneficiaryNotFound 404 Trusted Beneficiary specified in request does not exist or cannot be retrieved.
TemplateNotFound 404 Template specified in request does not exist or cannot be retrieved.
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound 404 Certificate has no permissions.
TokenNotFound 404 Token specified in request does not exist or cannot be retrieved.

Show

Endpoint used to fetch all data relevant to a payment including fees, status and other.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImlkIjo5NjF9LCJleHAiOjE3NjE0NTQxNzQsImlzcyI6InByaW9yYS5zYWx0ZWRnZS5jb20ifQ.klKIMwwmTMxEbF6OKPN-VFo6E6_QMydRQeRKjIqSf9ncHU9NHDM_slGzGl9yYkgXWzpnrl6ejT_h2qrp6Bh_W-w4L9t4C4OrWafscw14KIY3OwrEdalnisnwBOFsJTqw7Vq_jKJxuIUCDvJocOuPdPscFwmKzxYPzW-XUFDLMceQhDc6nh5rWZg2_aEhi-3BUzEH3HoiWYoFZRNVHdcU1yZuwojcxyUNHy-GU1-7KWLOilElxQNa4UUWJQ5Ro_dcR6HltkV7__39FZAx2T58NH6U6LmbQwJa08ljRb1BKWm4KXYgGu0GQk8S-SVsjZ5xKf2KWKCLjnhFTbKYO2RC5w" \ 
 -H "App-Id: xiPaOjVpBugwMgcYacdZtA" \ 
 -H "App-Secret: -vhQNUkweQ8udbSof_w-Fg" \ 
 -H "Access-Token: 057b31e63213d7c1f825398fb26de481c5d97ff2d89caad409c2b765418f84ca398f9338df21012f3e004d4c73fef623ce8464e829ce9e58ffc52fdbc48da467" \ 
 -H "Client-Request-Id: 17" \ 
 -X GET "/api/v2/payments/:id"

Example of request parameters

{"data":{"id":961},"exp":1574093210,"id":141}

Example of response

{"data":{"status":"closed","description":"Test payment","fees":[{"amount":0.25,"description":"Bank fee.","currency_code":"EUR"},{"amount":0.1,"description":"Payment fee.","currency_code":"EUR"}],"updated_at":"2019-11-18T16:04:50.451Z","id":305,"payment_attributes":{"from_account":"9542342312","to_account":"3458979570","amount":"150.00","description":"Test payment."},"interactive_step_instruction":{"interactive_field":"sms_pincode","instruction":{}},"session":{"fail_message":"","id":501,"secret":"oxL4oeiCApNvSKQYKGoi","status":"processing","events":[{}],"success_at":"2019-11-18T16:04:51.450Z","expires_at":"2019-11-18T17:04:50.450Z","fail_at":""},"created_at":"2019-11-18T16:04:50.451Z"}}
Request

GET /api/v2/payments/:id

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: AuthorizationMissing
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
App-Secret string, required Application’s app_secret from connection details tab.
Access-Token string, required Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Request Authorization
data
object, required
Wrapper for the data.
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
id
integer, required
Payment identifier in Salt Edge PSD2 Compliance. Can raise: PaymentNotFound
Response

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


Related Errors
Class Code Description
TokenMissing 400 This request cannot be performed without Access_Token header.
AuthorizationMissing 401 Authorization header is missing.
TokenRevoked 401 Token specified in request is revoked and cannot be used anymore.
TokenExpired 401 Token specified in request is expired and cannot be used.
PaymentNotFound 404 Payment specified in request does not exist or cannot be retrieved.
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound 404 Certificate has no permissions.
TokenNotFound 404 Token specified in request does not exist or cannot be retrieved.