NAV
SaltEdge PSD2 Compliance Logo

PISP

Payments

Confirm

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNyZWRlbnRpYWxzIjp7InNtc19waW5jb2RlIjoiMTIzNDU2In19LCJleHAiOjE1OTY5NjM2MDJ9.ERxU3rWn99YcSkdn1lI6gBh8hi4_sO0E9qQIECxi6eiJRo132VjD6aJFYvAIyVhiP1UzgvfGPBLK3C1nOkHS6noVPMDfcAj30KaiNE_dgOb4DEd-OQKa3yuIG7Uli_ARJyRL8ZR44bfPHmvzN1w3yF3epdCnv7mY6KuR4P3ESRpV_lfY4zCL72FKaLU9Tw5LVq9f9dcy2OEHCIAtzgWyCbbRPXR_25tJFwFmildVaWCuakziYv8q6SQzDQVh8fW33HmxeLwcFWOvN-4f_-wo8EfQHcyzBZCVewZMOO68pNw1zsEeBeRSz33C8bj3MmqSaDVGKfDyWk40l2Wrnptukg" \ 
 -H "App-Id: kai5JbcoWosdVUzLG2ib1A" \ 
 -H "App-Secret: H9EhmbtXlqm73MML5Z8E8w" \ 
 -H "Access-Token: 19561f4a7115f1c8cd6818748e4f2f90aafa24ac42c139a0c99c92784a786e70eb7755be5582867fca28c78addd743f17c2758de65b0c69eb8ef78c049c62af6" \ 
 -H "Client-Request-Id: 17" \ 
 -X PUT "https://priora.saltedge.com/api/v2/payments/:id"

Example of unpacked Authorization header

{"data":{"credentials":{"sms_pincode":"123456"}},"exp":1574093209,"id":794}

Example of response

{"data":{"id":691,"status":"good","description":"Internal transfer.","fees":[{"amount":0.25,"description":"Bank fee.","currency_code":"EUR"},{"amount":0.1,"description":"Payment fee.","currency_code":"EUR"}],"payment_attributes":{"from_account":"9542342312","to_account":"3458979570","amount":"150.00","description":"Test payment."},"session":{"id":461,"secret":"yua36KyKycry_hAPQQVQ","status":"processing","events":[],"success_at":"","expires_at":"2019-11-18T16:04:50.249Z","fail_at":"","fail_message":""},"created_at":"2019-11-18T16:04:50.249Z","updated_at":"2019-11-18T16:04:50.249Z"}}

This endpoint is used for processing additional interactive steps in the process of payment creation.

Request

PUT https://priora.saltedge.com/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, ConfigurationError
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 Authorization
Parameter Type Description
data hash, required Wrapper for credentials pair.
data.credentials hash, required Wraps PSU's credentials, it is used for both first(e.g. login, password) and second factors(e.g. one time password). Contents may vary depending on authorization types supported by your Bank.
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, SessionExpired, SessionClosed
Response
Response Type Description
data hash, required Wrapper for credentials pair.
data.created_at datetime, required Datetime of payment creation.
data.description string, required Payment's description.
data.fees array, required List of all fees applied to given payment. Default value: []
data.fees.amount float, required Amount of bank's fee related to the payment.
data.fees.currency_code string, required Currency code of bank's fee related to the payment.
data.fees.description string, required Fee's description.
data.id integer, required Payment identifier in Salt Edge PSD2 Compliance.
data.payment_attributes hash, required All attributes (required and optional) that belong to a payment template which PSU fills before creating the payment order.
data.session hash, required Related session.
data.session.events array, required Related session's events.
data.session.expires_at datetime, required Datetime of session expiration.
data.session.id integer, required Payment identifier in Salt Edge PSD2 Compliance.
data.session.secret string, required Another session identifier that can be used for session lookup and confirmation.
data.session.status string, required Current status of the payment. Allowed values: processing, redirect, waiting_confirmation, waiting_confirmation_code, executing, closed, fetched_kyc, fetched_accounts, fetched_transactions, fetched_trusted_beneficiaries
data.status string, required Current status of the payment.
data.updated_at datetime, required Datetime of last payment updation.
data.session.fail_at datetime, optional Datetime of session failure.
data.session.fail_message string, optional Session fail message.
data.session.success_at datetime, optional Datetime of session successful closure.
Related Errors
Class Code Description
SessionClosed 400 Session specified in request has been already closed and cannot be modified.
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
SessionExpired 401 Found session has been expired and cannot be processed anymore.
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.
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.

Create

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7InByb3ZpZGVyX2NvZGUiOiJkZW1vYmFuayIsInRlbXBsYXRlX2lkIjo4MjQsInJlZGlyZWN0X3VybCI6Imh0dHBzOi8vdXNlci53aWxsLmJlL3JlZGlyZWN0ZWQvaGVyZSIsImJlbmVmaWNpYXJ5X2lkIjozODMsImZvcmNlX3NjYSI6dHJ1ZSwicGF5bWVudF9hdHRyaWJ1dGVzIjp7ImZyb21fYWNjb3VudCI6Ijk1NDIzNDIzMTIiLCJ0b19hY2NvdW50IjoiMzQ1ODk3OTU3MCIsImFtb3VudCI6IjE1MC4wMCIsImRlc2NyaXB0aW9uIjoiVGVzdCBwYXltZW50LiJ9LCJleHRyYSI6e319LCJleHAiOjE1OTY5NjM2MDJ9.Fnuek2dAqK7Yfoys98f-UH6toeDHFiB_Iz6FC7lVVWP6yWRdlAFh3ayxKbSpivilY9DDOfbBB27x_dWnpGPjZqKzpld9FnBjrYs16hoW-I8KExjbXw9Jbm6eut6SCbwM8hvA9kwiZrYPpC91A5HjwelwOBg8r1kbyftOAlT7-hBnwSsZs9plHSp4Xvg1bxLrsoo-HPWj49jV97WdM19uXRZs6y98eTCL7-EjYMJD5anQB4SSyz-PrDz9RA3ICLP6B6O3codFBS_GwLDezZaZ3i8VIA3a2d7zfqt6N5ioKWw5wnyvvW02dxQJQPkm3E1IP6OWgPRgMPiUoUUjGi3D5A" \ 
 -H "App-Id: pRhi4X5YXwmccpgmDsLb1w" \ 
 -H "App-Secret: dszz3LNHbWnqz9HnnH8DhA" \ 
 -H "Access-Token: aacd4e18fab5b180b5e3cc4d35f8600ec08e1be219e5ec9400bc819357928a9283e8d6941215742aaa127d9076496bf210044545cbc1dc00489f295024c926c8" \ 
 -H "Client-Request-Id: 17" \ 
 -X POST "https://priora.saltedge.com/api/v2/payments"

Example of unpacked Authorization header

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

Example of response

{"data":{"id":997,"status":"pending","description":"Internal payment.","fees":[{"amount":0.25,"description":"Bank fee.","currency_code":"EUR"},{"amount":0.1,"description":"Payment fee.","currency_code":"EUR"}],"payment_attributes":{"from_account":"9542342312","to_account":"3458979570","amount":"150.00","description":"Test payment."},"session":{"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":"","fail_message":""},"created_at":"2019-11-18T16:04:50.320Z","updated_at":"2019-11-18T16:04:50.320Z"}}

Create a payment order on behalf of PSU

Request

POST https://priora.saltedge.com/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, ConfigurationError
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 Authorization
Parameter Type Description
data hash, required Wrapper for the data.
data.payment_attributes hash, required All attributes (required and optional) that belong to a payment template which PSU fills before creating the payment order.
data.provider_code string, required Human readable Provider identifier. Can raise: ProviderNotFound, AccessDenied
data.template_id integer, required Payment template identifier on Salt Edge PSD2 Compliance side. Can raise: TemplateNotFound
exp integer, required The lifetime of the request in timestamp UTC format. Values greater than: Current time.
data.beneficiary_id integer, optional Trusted Beneficiary identifier. Can raise: TrustedBeneficiaryNotFound
data.extra hash, optional Extra details that should be persisted into session. Default value: {}
data.force_sca boolean, optional Whether to disregard exemptions and force SCA as a required step to process the payment.
data.redirect_url string, optional The URL that the PSU will be redirected to proceed with payment. Used for oauth flow.
Response
Response Type Description
data hash, required Wrapper for the data.
data.created_at datetime, required Datetime of payment creation.
data.description string, required Payment's description.
data.fees array, required List of all fees applied to given payment. Default value: []
data.fees.amount float, required Amount of bank's fee related to the payment.
data.fees.currency_code string, required Currency code of bank's fee related to the payment.
data.fees.description string, required Fee's description.
data.id integer, required Payment identifier in Salt Edge PSD2 Compliance.
data.payment_attributes hash, required All attributes(required and optional) that are needed for a successful payment initiation.
data.session hash, required Related session.
data.session.events array, required Related session's events.
data.session.expires_at datetime, required Datetime of session expiration.
data.session.id integer, required Payment identifier in Salt Edge PSD2 Compliance.
data.session.secret string, required Another session identifier that can be used for session lookup and confirmation.
data.session.status string, required Current status of the payment. Allowed values: processing, redirect, waiting_confirmation, waiting_confirmation_code, executing, closed, fetched_kyc, fetched_accounts, fetched_transactions, fetched_trusted_beneficiaries
data.status string, required Current status of the payment.
data.updated_at datetime, required Datetime of last payment updation.
data.session.fail_at datetime, optional Datetime of session failure.
data.session.fail_message string, optional Session fail message.
data.session.success_at datetime, optional Datetime of session successful closure.
Related Errors
Class Code Description
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
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
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.
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.

Destroy

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7fSwiZXhwIjoxNTk2OTYzNjAyfQ.XP_Wvq6hII_eW8t6NGE66HYMblS4Tu5bdS3YtO7L3sjtEyzb7ZT9i0QhynjhrTwES504wv_kHL0IrN1h9PI6RGOuhEDIdOXuSPa8g7jujuOJNBR2y3EP-rV3BcE-mPnC2eFyRUV08IXtH5-bB5YNyuEE7gjWh-T9eGG18afj2jgIC_2VQtCUiNmqPKWlyHTO9ZOGhO0d7dXBzIxwYg1URU3Ij5IED1QRDFHuZJ_2IZC5E27_uURLJp5bNb8PHlmKaEXjiiMVzMDeQPC8-1sUnewCnRiJDsQLJhYw_Ko_2lZVqvjqUDMCvQcP0uBPISZixmrabHgz0M0IhaHrI6TBQA" \ 
 -H "App-Id: DZ8IEYmbfDvS3eMeLhA-Lw" \ 
 -H "App-Secret: 5FXgZCioWalfvTGVHqNe0g" \ 
 -H "Access-Token: 55de2eb27669505499da9cdfd7d8f9dccbc61b3c2d158df4959c35d01fc0dc856505986f750f4d84b6bee0b85d4e6dfb3e6309e59078ec81832274c72bb62d1a" \ 
 -H "Client-Request-Id: 17" \ 
 -X DELETE "https://priora.saltedge.com/api/v2/payments/:id"

Example of unpacked Authorization header

{"data":{},"exp":1574093210,"id":546}

Example of response

{"data":{"payment_id":324}}

Cancel the payment that is in the process of creation, meaning it has not been confirmed yet.

Request

DELETE https://priora.saltedge.com/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, ConfigurationError
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 Authorization
Parameter Type Description
data hash, required Wrapper for the data.
exp integer, required The lifetime of the request in timestamp UTC format. Values greater than: Current time.
id string, required Payment identifier in Salt Edge PSD2 Compliance. Can raise: PaymentNotFound, SessionExpired, SessionClosed
Response
Response Type Description
data hash, required Wrapper for the data.
data.payment_id string, required Payment order identifier on Connector side. Used to map Salt Edge PSD2 Compliance payments to Connector ones.
Related Errors
Class Code Description
SessionClosed 400 Session specified in request has been already closed and cannot be modified.
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
SessionExpired 401 Found session has been expired and cannot be processed anymore.
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.
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.

Show

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImlkIjo5NjF9LCJleHAiOjE1OTY5NjM2MDJ9.lc4fQC8hLruew9OI_sMcIwByTaKhBj48i-as8rBSOY_S-hc2SYpRjab11AaYMPBxJB3zt1yIeRlOqmB-zylnNv29UwAw4Ao60rzZjaWI1TWsug7_JVqDKJA9tO69BLni9tSdLjsy56nmv_cY_UKTKY2MyqijuThv2sLZBbtoTEuYawDwiFwB1mXdoURKaqC4AL9_DSzy1BRp2kvD26EkyvCfo9iA46QTmY5ViC4yPNpctXkBURNqw9_e-CxxmF_R6MNLu09ImmJny0t82ZzHRh4QeMf4ra0hjEH3VqENQALUKNiFCYxBcvvF2U5_SHLKthsRNZgqQLBB99nkruu39Q" \ 
 -H "App-Id: xiPaOjVpBugwMgcYacdZtA" \ 
 -H "App-Secret: -vhQNUkweQ8udbSof_w-Fg" \ 
 -H "Access-Token: 057b31e63213d7c1f825398fb26de481c5d97ff2d89caad409c2b765418f84ca398f9338df21012f3e004d4c73fef623ce8464e829ce9e58ffc52fdbc48da467" \ 
 -H "Client-Request-Id: 17" \ 
 -X GET "https://priora.saltedge.com/api/v2/payments/:id"

Example of unpacked Authorization header

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

Example of response

{"data":{"id":305,"status":"closed","description":"Test payment","fees":[{"amount":0.25,"description":"Bank fee.","currency_code":"EUR"},{"amount":0.1,"description":"Payment fee.","currency_code":"EUR"}],"payment_attributes":{"from_account":"9542342312","to_account":"3458979570","amount":"150.00","description":"Test payment."},"interactive_step_instruction":{"instruction":{},"interactive_field":"sms_pincode"},"session":{"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":"","fail_message":""},"created_at":"2019-11-18T16:04:50.451Z","updated_at":"2019-11-18T16:04:50.451Z"}}

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

Request

GET https://priora.saltedge.com/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, ConfigurationError
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 Authorization
Parameter Type Description
data hash, 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
Response Type Description
data hash, required Wrapper for the data.
data.created_at datetime, required Datetime of payment creation.
data.fees array, required List of all fees applied to given payment. Default value: []
data.fees.amount float, required Amount of bank's fee related to the payment.
data.fees.currency_code string, required Currency code of bank's fee related to the payment.
data.fees.description string, required Fee's description.
data.id integer, required Payment identifier in Salt Edge PSD2 Compliance.
data.interactive_step_instruction hash, required Object which maps the field with interactive field and it's instruction. Default value: {}
data.payment_attributes hash, required All attributes (required and optional) that belong to a payment template which PSU fills before creating the payment order.
data.session hash, required Related session.
data.session.expires_at datetime, required Datetime of session expiration.
data.session.id integer, required Payment identifier in Salt Edge PSD2 Compliance.
data.session.secret string, required Another session identifier that can be used for session lookup and confirmation.
data.session.status string, required Current status of the payment. Allowed values: processing, redirect, waiting_confirmation, waiting_confirmation_code, executing, closed, fetched_kyc, fetched_accounts, fetched_transactions, fetched_trusted_beneficiaries
data.status string, required Current status of the payment. Allowed values: processing, redirect, waiting_confirmation, waiting_confirmation_code, closed
data.updated_at datetime, required Datetime of last payment updation.
data.description string, optional Payment's description.
data.interactive_step_instruction.instruction string, optional Interactive step instruction.
data.interactive_step_instruction.interactive_field string, optional Mfa interactive field name.
data.session.events array, optional Related session's events.
data.session.fail_at datetime, optional Datetime of session failure.
data.session.fail_message string, optional Session fail message.
data.session.success_at datetime, optional Datetime of session successful closure.
Related Errors
Class Code Description
AuthorizationMissing 400 Authorization header is missing.
ConfigurationError 400 Missing configurations in dashboard.
TokenMissing 400 This request cannot be performed without Access_Token header.
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.
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.
Go to previous page
Go to next page